13. inclusionProcessor
Prev | Chapter 7. Configuration elements | Next

## 13. inclusionProcessor

    <inclusionProcessor
      name = non empty token
    >
      Content: [ class ]?
    </inclusionProcessor>

    <class>
      Content: Java class name
    </class>

Register `inclusionProcessor` specified by `class` with XXE.

An `inclusionProcessor` is associated to a type of document. Each time a document for which an inclusion processor has been declared is opened, XXE invokes this processor in order to evaluate the inclusion directives it contains. To make it simple, evaluating the inclusion directives means replacing these directives by up-to-date included elements. Each time a document for which an inclusion processor has been declared is saved, XXE invokes this processor in order to convert included elements back to inclusion directives.

`Xi:include` (XInclude) elements are inclusion directives processed by the "`XInclude`" inclusion processor. DITA elements having a `conref` attribute are inclusion directives processed by the "`Conref`" inclusion processor.

An inclusion processor is always associated with a command which can be used to interactively create included elements managed by the processor. For the "`XInclude`" inclusion processor, these commands are `copyAsInclusion` and `include` (see Section 13, “copyAsInclusion” in XMLmind XML Editor - Commands). For the "`Conref`" inclusion processor, this command is `dita.setConref`.

Several `inclusionProcessor`s can be associated to the same document type. In such case, they are notified in the order of their registration.

There is no need to declare the "`XInclude`" inclusion processor because this standard processor is declared by default. However, in some case, it may be useful to disable the "`XInclude`" inclusion processor. Learn how below.

Child elements of `inclusionProcessor`:

class

  Register `inclusionProcessor` implemented in the Java™ language by class `class` (implements interface `com.xmlmind.xmledit.edit.InclusionProcessor` -- SeeChapter 10, Specializing the generic inclusion facility of XMLmind XML Editor in XMLmind XML Editor - Developer's Guide).

Attributes of `inclusionProcessor`:

name

  This name is useful to remove or replace a previously registered `inclusionProcessor`. Anonymous `inclusionProcessor`s cannot be removed or replaced.

  When a `inclusionProcessor` element is used to remove a registered `inclusionProcessor`, a `name` attribute must be specified and there must be no `class` child element.

DITA Example:

      <inclusionProcessor name="Conref">
        <class>com.xmlmind.xmleditapp.dita.ConrefProcessor</class>
      </inclusionProcessor>

      <!-- Suppress XInclude processing -->
      <inclusionProcessor name="XInclude"/>

Prev | Up | Next
12. include | Home | 13.1. The "`GenericInclusion`" inclusion processor