[5.1 Assembly]module

module — A modular component within a structure.


module ::=


Common attributes.

Additional attributes:

  • chunk (enumeration) [default=“auto”]
    • “true”
    • “false”
    • “auto”
  • contentonly (boolean)
  • omittitles (boolean)
  • renderas (QName)
  • resourceref (IDREF)

Additional Constraints

  • The renderas attribute can be specified on either the structure or output, but not both.


Within a structure, the module elements describe the subunits of the structure. If the structure represents a book, then the modules are effectively the chapters, appendixes, etc. If the structure represents an interactive help system or web site, then the modules may be pages or sets of pages within that system.

In the simplest case, a module points to the resource that is the body of the module. In more complex cases, a module may impose more structure through nested modules.

If contentonly is true, then only the content of the referenced resource is included (that is, the children of the root element, but not the root element itself).

If omittitles is true, then the title elements of the referenced resource are not included.


The omittitles attribute seems redundant, or perhaps just misnamed (notitles?) given the existence of merge.

Processing expectations

Never rendered directly. The content that results from processing a module is generally rendered in the normal fashion.


Common attributes.


Specifies chunking for this module

Enumerated values:

This module will be in a chunk


This module will not be in a chunk


Chunking of this module depends on the overall chunking algorithm


Indicates if only the content should be copied when including a resource


Indicates if titles should be omitted when including a resource


Specifies the DocBook element to which this unit should be renamed


Indicates a single resource from which to construct this module


These elements contain module: module, structure.


The following elements occur in module: filterin, filterout, info (db.info), merge, module, output.