8.4. Using the "Document Set" tool

Note

The FileDocument Set submenu is hidden by default. You need to enable it by checking "Enable the 'File|Document Set' Submenu" in OptionsPreferences, Features section.

This tool is displayed after you select a file specifying a document set using FileDocument SetOpen Document Set.

Figure 7.4. The "Document Set" tool showing the document set corresponding to the map of our DITA tutorial

The "Document Set" tool showing the document set corresponding to the map of our DITA tutorial

Toolbar buttons:

Edit document set specification

Edit in XXE the XML document used to specify this document set. This XML document is typically a DITA map or a DocBook master document.

This button is disabled when the document set is specified by a glob pattern (e.g. "file:/home/john/site/*.html").

Document set options

Display a dialog box allowing to change the options, if any, of this document set.

Changing the options of a document set automatically brings this document set up-to-date.

This button is disabled for all kinds of document set, except when the document set is specified by a DITA map. In such case, this button displays a dialog box allowing to associate a conditional processing profile (a .ditaval file) and a target medium (print or screen) to the underlying DITA map. These settings also have a direct effect on the list of member documents and on the visual representation of the document set[17].

Update document set

Update the list of member documents belonging to this document set and at the same time rebuild its visual representation.

This button must be clicked after the XML document used to specify this document set (typically a DITA map or a DocBook master document) has been modified.

There is no need to click this button after modifying member documents in XXE. When a member document is modified and the changes are saved to disk, the visual representation of the document set is automatically updated.

Below the toolbar is found an interactive pane containing a visual representation of the document set:

Notice that the tabs of documents belonging to the same document set are all given the same background color as the corresponding "Document Set" tool.



[17] And also on the key space, when the DITA map contains key definitions. See About document sets and the DITA key-reference mechanism.