The
source files for the DITA-OT
documentation include examples of the following DITA features (among others):
- subjectScheme classification for controlling available attributes
- profiling and branch filtering (novice/expert content)
- extending topics with conref push
- keys and key references
- XML mention domain
Subject schemes
Various topics, sections and elements in the docs are profiled by audience:
An “audience” subject scheme controls the values that are available for the audience
attribute:
Branch filtering: re-using profiled content
Installing DITA-OT pulls a subset of the build description from using the
dita command, filtered to display only content deemed suitable for novice users
under
:
The same content appears later in
with additional information on arguments, options and examples.
The docs build uses the conref push mechanism (with the pushreplace, mark,
and pushafter
conactions) to extend the parameter descriptions embedded in the
default plug-ins:
The pushed content appears in the output after the default description. (See
.)
You could also use the same mechanism to extend the documentation with custom information that
applies only to your company’s toolkit distribution.
The key-definitions.ditamap defines keys for version references, re-usable links, etc.
This key definition defines the maintenance release version:
In topics, the keyword is used in place of hard-coded version references:
<title>DITA Open Toolkit <keyword keyref="maintenance-version"/> Release Notes</title>
The docs use the
XML mention domain to mark up XML elements and attributes:
<li id="1777">
DITA 1.3: Initial support has been added for the <xmlatt>orient</xmlatt>
attribute on <xmlelement>table</xmlelement> elements. These changes allow
Antenna House Formatter to render tables in landscape mode when the
<xmlatt>orient</xmlatt> attribute is set to <option>land</option>. […]
</li>
When the toolkit generates output for the sample above:
- the XML element name is wrapped in angle brackets as table
- the attribute name is prefixed with an “at” sign as orient