Working with Modular XML Files in the Master Files Context
oXygen helps you edit XML
modules referenced using XInclude or external entities. By customizing the XML Master
File, oXygen provides a context to address module validation, ID referencing,
understanding how modules are connected to each other, or using the Content Completion
Assistant to edit content.
A Detect Master Files contextual menu action is available on the
project root file that allows you to define the XML Master Files.
In the following illustration, you can see how the structure of a book project may
look like, where chapters and sections are organized as distinct modules. Setting the
root file as the Master File allows you to edit the modules in the correct
XML Module Validation
When you validate an XML document, oXygen automatically
determines the Master Files that reference that module and validates the entire
hierarchy of the assembled modules. This is especially useful, for example, when a
module references IDs that are declared in another part of this hierarchy.
XML Module Editing
The Content Completion Assistant uses the schema declarations
from the Master Files and only proposes elements and attributes that are valid in a
particular editing context.
An XML module does not ordinarily have a schema associated with it, which means
the Content Completion Assistant cannot offer element proposals. By defining the
Master Files for a module, oXygen automatically uses the schemas declared in the
Master Files, making it easier to edit a module since the Content Completion Assistant
proposes the elements that are valid in its context.
Also, after defining the Master Files, oXygen proposes entities declared in
the main files, both in the Content Completion Assistant and the Entities view.
Search/Refactor Support for ID/IDREFS
The Master Files defined for the current module determines the
scope of search and refactoring actions for ID/IDREFS values and for updating
references when renaming or moving a resource. oXygen performs search and
refactoring actions in the context that is determined by the Master Files, improving
the execution speed.
Read more about the ID/IDREFS support here: Search/Refactoring Support for
Module Connections Overview
The Resource Hierarchy/Dependencies view allows you to
visualize and understand the relationship between XML resources that are referenced
using XInclude and external entity
For example, if you edit a book that is composed of multiple modules, oXygen
displays the structure of the book in a dedicated side view where all the modules are
arranged in a tree-like structure. You can see what chapters are referenced from the
book and what sections make up each chapter. You can also easily navigate through this
hierarchy by double-clicking any of the modules.
Renaming or Moving an XML Module Updates its References
oXygen automatically updates all the references to a module
when the module is renamed or moved in the Project or Resource Hierarchy/Dependencies
When you move or rename a file or a folder from the Project view the references to
its resources are changed automatically. For example, if you rename a folder, the
references to its resources are also updated in a Preview window. The changes for each
of the modified files are highlighted and you can choose to accept or reject
oXygen uses the Master Files support to define the scope for rename or move
operations invoked at project level, improving the speed of execution.