[5.1 Assembly]output

output — Specify an output format and/or file name and/or renderas.

Synopsis

output ::=

  • empty

Attributes

Common attributes.

Additional attributes:

  • chunk (enumeration) [default=“auto”]
    • “true”
    • “false”
    • “auto”
  • file (anyURI)
  • renderas (QName)
  • suppress (boolean)
  • transform (NMTOKEN)

Description

The output element specifies a set of options to be used when rendering the module or structure in which it occurs. Multiple output elements can be specified and, if effectivity attributes and profiling are used, options can be selectively turned on and off for different renderings.

The grammar attribute on output was mistakenly included in DocBook version 5.1, and will be removed in version 5.2. The grammar attribute appears on a resource element to specify its vocabulary if it is not DocBook, and on a transform element to specify a transformation to convert resources with that grammar to DocBook during assembly.

Processing expectations

Never rendered.

Attributes

Common attributes.

chunk

Specifies chunking for this module

Enumerated values:
“true”

This module will be in a chunk

“false”

This module will not be in a chunk

“auto”

Chunking of this module depends on the overall chunking algorithm

file

Specifies the output file for this module or structure

renderas

Specifies the DocBook element to which this unit should be renamed

suppress

Indicates whether or not this unit should be suppressed

transform

Specifies the transformation that should be applied to this unit

Parents

These elements contain output: module, structure.

Examples

This example has two output elements, each with a different value for the outputformat effectivity attribute. During assembly, profiling should be used to select one of them.

<module resourceref="topic1">
  <output renderas="section" outputformat="print"/>
  <output renderas="topic" outputformat="help"/>
  …

In this example, only the content of topic2, without its root element or titles, is inserted at the end of the topic1 section as more content in the same section.

<module resourceref="topic1" renderas="section">
  <module resourceref="topic2">
    <output contentonly="true" omittitles="true"/>
  </module>
</module>