XMLmind logo

XMLmind XML Editor - Configuration and Deployment

  
Contents
Index
Search

17. inclusionScheme

<inclusionScheme
  name = non empty token
>
  Content: [ class [ property ]* ]?
</inclusionScheme>

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

<property
  name = NMTOKEN matching [_a-zA-Z][_a-zA-Z0-9]*
  type = (boolean|byte|char|short|int|long|float|double|
          String|URL)
  value = string
/>

Register inclusionScheme specified by class with XXE.

An inclusionScheme is associated to a type of document.

To make it simple:

  • Each time a document for which an inclusion scheme has been declared is opened, XXE invokes this scheme in order to ``evaluate'' the inclusion directives it contains. Evaluating the inclusion directives means replacing these directives by up-to-date included nodes.

  • Each time a document for which an inclusion scheme has been declared is saved, XXE invokes this scheme in order to convert included nodes back to inclusion directives.

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

By default, no inclusion schemes at all, not even XInclude, are associated to a document type.

Several inclusionSchemes can be associated to the same document type. In such case, they are invoked in the order of their registration.

Child elements of inclusionScheme:

class

Register inclusionScheme implemented in the Java™ language by class class (implements interface com.xmlmind.xml.load.InclusionScheme).

Attributes of inclusionScheme:

name

This name is useful to remove or replace a previously registered inclusionScheme. Anonymous inclusionSchemes cannot be removed or replaced.

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

DITA example:

<inclusionScheme name="Conref">
  <class>com.xmlmind.xmleditext.dita.ConrefScheme</class>
</inclusionScheme>

DocBook 5.1, which uses XInclude 1.1, example:

<inclusionScheme name="XInclude">
  <class>com.xmlmind.xml.xinclude.XIncludeScheme</class>
  <property name="copiedAttributesWhenMultipleInstances" 
            type="String" value="set-xml-id=''" />
</inclusionScheme>
Table 6.1. Properties of the XInclude scheme
NameTypeValueDescription

copiedAttributes

String

One or more attributes separated by whitespace. Attribute names must be specified using the Clark's notation in XMLmind XML Editor - Commands.

Attributes added to an xi:include element created by commands such as Edit → Reference → Copy As Reference when this xi:include element is not expected to be found several times, at different places, in the including document.

These attributes are used by an XInclude 1.1 feature called Attribute Copying.

See also command copyAsInclusion in XMLmind XML Editor - Commands.

copiedAttributesWhenMultipleInstances

String

One or more attributes separated by whitespace. Attribute names must be specified using the Clark's notation in XMLmind XML Editor - Commands.

Example 1:

set-xml-id=''

Example 2:

{http://docbook.org/ns/¬
transclusion}idfixup='auto'
{http://docbook.org/ns/¬
transclusion}linkscope='local'

Attributes added to an xi:include element created by tools such as the Include tool when this xi:include element is expected to be found several times, at different places, in the including document.

These attributes are used by an XInclude 1.1 feature called Attribute Copying.

See also command include in XMLmind XML Editor - Commands.