Sample files

This section contains information about the DITA sample source files that come with DITA Open Toolkit.

The following sample files (garage and grocery shopping) are included in the package accompanying this document. Ant scripts are also included.

The garage sample is featured in the processing instructions in the processing chapter of this document (Processing (building) and publishing DITA documents

The grocery shopping sample is featured in the creating topics and maps chapters of this document (Creating DITA topics and Creating DITA maps).

Garage sample

The garage sample, which is downloadable from http://dita-ot.sourceforge.net/SourceForgeFiles/doc/user_guide.html, is a set of DITA source files containing concepts and tasks related to organizing and doing tasks in a garage. The sample map files allow the topics to be published as either a hierarchy or a sequence. The sample also includes Ant scripts that allow you to publish to all target environments.

Note: The garage sample that is part of the DITA Open Toolkit User Guide

is not exactly the same set of files as the garage sample that is part of the Toolkit package.

Before you begin to use the garage sample files, we recommend creating two directories in your root directory called DITASAMPLE_GARAGE_SOURCE and DITASAMPLE_GARAGE_OUTPUT (Windows examples would be C:/DITASAMPLE_GARAGE_SOURCE and C:/DITASAMPLE_GARAGE_OUTPUT) and then copying the garage sample files to DITASAMPLE_GARAGE_SOURCE. Your directory structure should then look like this:

We recommend that you process your first test case to the XHTML target (dita2xhtml), which generally provides predictably positive results. The dita2htmlhelp, dita2pdf2, and the Eclipse targets (dita2eclipsecontent and dita2eclipsehelp) are also very reliable. The other targets are, in our experience, somewhat problematic, and may require special coding to get acceptable results.

One of the garage sample targets (dita2filtered, which produces XHTML output) illustrates conditional processing using filtering. The output is a hierarchically organized file with four of the garage topics (those dealing with "oil" or "snow") excluded.

Grocery shopping sample

The grocery shopping sample, which is downloadable from http://dita-ot.sourceforge.net/SourceForgeFiles/doc/user_guide.html, is a simple DITA project that includes seven topics: an overview topic, two concepts, two tasks, and two reference topics. The project also includes a map that aggregates the files and links them meaningfully using a relationship table. Ant scripts that process to all DITA Open Toolkit targets are also provided.

Before you begin to use the grocery shopping sample files, we recommend creating two directories in your root directory called DITASAMPLE_GROCERY_SOURCE and DITASAMPLE_GROCERY_OUTPUT (Windows examples would be C:/DITASAMPLE_GROCERY_SOURCE and C:/DITASAMPLE_GROCERY_OUTPUT) and then copying into them both the grocery shopping sample files DITASAMPLE_GROCERY_SOURCE. Your directory structure should then look like this:

The grocery shopping sample assumes you are already familiar with the garage sample provided as both a project model as well as a tool to verify your DITA Open Toolkit installation, and that you have processed the garage sample as described in Processing (building) and publishing DITA documents.