1 | This file is part of the DITA Open Toolkit project hosted on
|
---|
2 | Sourceforge.net. See the accompanying license.txt file for
|
---|
3 | applicable licenses.
|
---|
4 | (c) Copyright IBM Corp. 2004, 2009 All Rights Reserved.
|
---|
5 | PACKAGE DESCRIPTION FOR "DITA-OT1.5"
|
---|
6 |
|
---|
7 | This document describes the organization and contents of the current DITA
|
---|
8 | distribution. These notes represent the specific organization of the
|
---|
9 | directories in the current package.
|
---|
10 |
|
---|
11 | FILES IN THE ROOT DIRECTORY:
|
---|
12 |
|
---|
13 | Within the root directory are the usual license, change notes, a link to
|
---|
14 | the actual readme in the doc directory, and other files related to
|
---|
15 | installation, configuration and processing for DITA:
|
---|
16 |
|
---|
17 | * Files that define ant processing (build.xml and ditatargets.xml). For a
|
---|
18 | description of the use of the ant processing capability, please see
|
---|
19 | doc/DITA-ant.html.
|
---|
20 |
|
---|
21 | * Files that configure the DITA DTDs to tools that are XML Catalog-aware.
|
---|
22 | These are in both text and OASIS XML format. (Schemas have no formal
|
---|
23 | requirement for use of XML Catalogs, although some tools can make use
|
---|
24 | of catalogs in the same way as for DTDs.)
|
---|
25 |
|
---|
26 |
|
---|
27 | DIRECTORIES WITHIN THE ROOT DIRECTORY:
|
---|
28 |
|
---|
29 | \css
|
---|
30 | \demo
|
---|
31 | \doc
|
---|
32 | \dtd
|
---|
33 | \lib
|
---|
34 | \plugins
|
---|
35 | \resource
|
---|
36 | \samples
|
---|
37 | \schema
|
---|
38 | \tools
|
---|
39 | \xsl
|
---|
40 |
|
---|
41 | The "\css" directory contains sample CSS files that can be used for
|
---|
42 | displaying DITA content directly in browsers or editors that configure
|
---|
43 | their views using CSS.
|
---|
44 |
|
---|
45 | The "\demo" directory contains examples of specializations that
|
---|
46 | demonstrate how various types of information can be supported using
|
---|
47 | DITA techniques. This directory has the following components:
|
---|
48 | \demo\book - use of the out-dated original bookmap specialization of map
|
---|
49 | \demo\dita132 - the original, pre-OASIS version of DITA kept for
|
---|
50 | backwards compatibility
|
---|
51 | \demo\elementref - a simple "element reference" descriptive markup
|
---|
52 | \demo\enote - the use of specialization to represent data objects
|
---|
53 | \demo\faq - a Frequently Asked Questions summary format
|
---|
54 | \demo\h2d - XSL conversion tools to convert HTML to DITA
|
---|
55 | \demo\java - validators for DITA Schemas
|
---|
56 | \demo\legacypdf - the original, demo level PDF output code
|
---|
57 |
|
---|
58 |
|
---|
59 | The "\doc" directory contains the core DITA description, image resources,
|
---|
60 | and a growing library of application notes.
|
---|
61 | \doc\articles contains the DITA source for the articles that define the
|
---|
62 | DITA architecture.
|
---|
63 | \doc\langref contains the DITA source for the DITA Language Reference
|
---|
64 |
|
---|
65 | The "\dtd" directory contains the core DITA definitions in XML DTD format.
|
---|
66 |
|
---|
67 | The "\plugins" directory can be used to store DITA-OT plug-ins.
|
---|
68 |
|
---|
69 | The "\resource" directory contains the commonly used css files and default
|
---|
70 | plugin.xml, helpset.hs and index.html for different html related output. It
|
---|
71 | also contains other resources common to toolkit builds.
|
---|
72 |
|
---|
73 | The "\samples" directory has the following components:
|
---|
74 | \samples\ant_sample - sample Ant customizations for running toolkit builds
|
---|
75 | \samples\concepts - content for garage User Assistance
|
---|
76 | \samples\image - image resources for garage UA
|
---|
77 | \samples\taskbook - sample content using the OASIS bookmap specialization
|
---|
78 | \samples\tasks - content for garage UA
|
---|
79 |
|
---|
80 | The "\schema" directory contains the core DITA definitions in XML Schema format.
|
---|
81 |
|
---|
82 | The "\xsl" directory contains the main stylesheets for the various processing
|
---|
83 | options for DITA. The subdirectories contain process-specific XSLT stylesheets:
|
---|