Printing

Darwin Information Typing Architecture (DITA) Version 1.2

Document
Darwin Information Typing Architecture (DITA) Version 1.2

By default, the content of most elements is included in all output media. The DITA map provides a means to suppress element content from appearing in print-oriented media, or from appearing in non-print-oriented media, such as HTML. The generation or non-generation of print and other forms of output can also be affected through the use of other navigation-related attributes.

The author can specify whether individual topics or groups of topics referenced in a DITA map should be included for processing to print-oriented outputs such as PDF. Each map (or map specialization) and topicref (or topicref specialization) in a DITA map supports the attributes @toc, @processing-role, and @print. The @print attribute supports the following enumerated values, each controlling the way that print-oriented processors handle the inclusion or exclusion of topics or groups of topics.

@print value Print-oriented Processing Non-print-oriented Processing

unspecified (default)

Example:

<topicref href="foo.dita">

Topics referenced by the map element are included in output.

Topics referenced by the map element are included in output.

yes

Example:

<topicref href="foo.dita" print="yes">

Topics referenced by the map element are included in output.

Topics referenced by the map element are included in output.

printonly

Example:

<topicref href="foo.dita" print="printonly">

Topics referenced by the map element are included in output.

Topics referenced by the map element are excluded in output.

no

Example:

<topicref href="foo.dita" print="no">

Topics referenced by the map element are excluded in output.

Topics referenced by the map element are included in output.

-dita-use-conref-target

Example:

<topicref conref="#foo-topic" print="-dita-use-conref-target">

Topics referenced by the map element derive a value for @print from the @print value of the referenced map element.

See Using the -dita-use-conref-target value for more details on this value.

Topics referenced by the map element derive a value for @print from the @print value of the referenced map element.

See Using the -dita-use-conref-target value for more details on this value.

Note: If a value for @print is not specified explicitly in a map element, but is specified in a map that references the map element, the @print value cascades to the referenced map. If the @print value is not specified on the referencing map, a default of "yes" is assumed.

Use @print="printonly" to identify transitional topics to be included exclusively in highly contextual or linear print-oriented output.

If the referenced topic should be excluded from all output formats, set the @processing-role attribute to "resource-only" instead of using the @print attribute. Content within that topic may still be referenced for display in other locations.