31. include

Parameter syntax:

'into' | ('replace'|'before'|'after' [ implicit_selection ]?)
[ referenced_document_URL reference_id [  '[absoluteReference]' ]? ]?
into

Pastes a reference into element containing caret, at caret position.

replace

Pastes a reference replacing text selection or selected nodes.

before or after

Pastes a reference before of after selected nodes.

Commands copyAsInclusion (generally bound to keystroke Shift+Ctrl+C) and paste (generally bound to keystroke Ctrl+V) are used to compose modular documents, see the corresponding tutorial section in the User's Guide.

When parameters referenced_document_URL and reference_id are not specified, command include is basically an alternative user interface for composing modular documents. It displays a dialog box, similar to the Include tool, allowing the user to choose which reference to insert.

When parameters referenced_document_URL and reference_id are specified, command include may be used in macro-commands to automate tasks.

referenced_document_URL

The URL of the document containing the nodes to be referenced.

reference_id

A string identifying the nodes to be referenced: DITA-style ID for DITA documents (e.g. my_topic, my_topic/my_paragraph), standard ID for other document types.

[absoluteReference]

When this option is specified, the including document references referenced_document_URL using an absolute URL. By default, a URL relative to the including document is used.

Examples:

include into
include after[implicitElement]
include replace[implicitNode]
include into file:/home/john/doc/boilerplate.xml product_name
include before[implicitElement] ../common/Copyright.xhtml copyright [absoluteReference]