123. XXE.masterDocumentControl

123. XXE.masterDocumentControl
	Chapter 6. Commands written in the Java™ programming language

'set' | 'unset' | 'toggle' | 'state' | 'refresh' | 'reset'

This command allows to create a document set containing a master document of any kind^[6] and its module documents.

By grouping a master document and its module documents, you inform XMLmind XML Editor (XXE) that all the module documents referenced or included, directly or indirectly, by the master document are related. When XXE knows that some of the opened documents are related:

it will more thoroughly check the cross-references which may exist between these documents;
it will make it easier creating cross-references between these documents;
it will make it easier following cross-references between these documents;
if a DITA map contains key definitions, then this map acts not only as a cross-reference creation/validation context for its topics, but it also acts as a key space;
if the "Easy Profiling" add-on has been installed, then the conditional processing profile selected for the master document is automatically shared by all module documents;
if the document view area is split in two parts, the module documents opened from a master document will appear at the opposite of this master document. This allows to use the view of the master document as a rudimentary navigation pane.

Options:

set

Create the document set specified by the master document being edited.

For this option to work, a documentSetFactory in XMLmind XML Editor - Configuration and Deployment element must have been declared in the configuration of the document being edited.

unset

Delete the document set containing the document being edited. This document may be a module document or a master document.

toggle

Create the document set specified by the master document being edited if this set does not already exist; delete the set otherwise. This option requires the document being edited to be a master document, not a module document.

Command XXE.masterDocumentControl with option toggle is used to implement Tools → Use as Master Document.

state

Returns "on" if the document being edited is contained in a document set. Returns "off" otherwise.

refresh

Update the document set containing the document being edited. This document may be a module document or a master document.

Command XXE.masterDocumentControl with option refresh is automatically used when the master document is saved to disk using File → Save.

reset

Recreate the document set containing the document being edited. This document may be a module document or a master document.

Command XXE.masterDocumentControl with option reset is automatically used when the master document is saved to disk using File → Save As.

Examples:

XXE.masterDocumentControl toggle
XXE.masterDocumentControl state

^[6]DITA map, DocBook 5.1+ assembly, Ebook, DocBook modular document such a book including chapters by the means of XInclude, etc.


122. XXE.editInclusion		124. XXE.new