53. masterDocumentControl

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

This command allows to create a document set containing a master document of any kind[4] 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:

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 masterDocumentControl with option toggle is used to implement ToolsUse 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 masterDocumentControl with option refresh is automatically used when the master document is saved to disk using FileSave.

reset

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

Command masterDocumentControl with option reset is automatically used when the master document is saved to disk using FileSave As.

Examples:

masterDocumentControl toggle
masterDocumentControl state


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