Edit online

Detecting Main Files

Oxygen XML Author allows you to detect the main files using the Detect Main Files option. This action applies to the folders you select in the project.

To detect main files over the entire project, do one of the following:
  • Right-click the root of the project and select Detect Main Files.
  • Use the Detect Main Files from Project option, available in the contextual menu of the Main Files folder.
Both of these options display the Detect Main Files wizard. The detected main files are presented in a tree-like fashion. The resources are grouped into three categories:
  • Possible main files - The files presented on the first level in this category are not imported or included from other files. These files are most likely to be set as main files.
    Note: For DITA projects, only DITA Maps are reported as possible main files.
  • Cycles - The files that are presented on the first level have circular dependencies between them. Any file presented on the first level of a cycle is a possible main file.
  • Standalone - Files that do not include or import other files and are also not included or imported themselves. It is not necessary to set them as main files.

To set them as main files, simply select their checkboxes. Oxygen XML Author marks all the children of a main file as modules. Modules are rendered in gray and their tool-tip presents a list of their main files. A module can be accessed from multiple main files.

The next panel displays a list with the selected main files. Click the Finish button to add the main files in the Main Files folder.

You can use the Select Main Files option to automatically mark all main files. This action sets all the resources from the Possible Main Files category and the first resource of each Cycle as main files. The Deselect All button simply removes all of your selections.
Tip: It is recommended that you only add top-level files (files that are at the root of the include/import graph) in the Main Files directory.
Attention: If the Main Files Support is disabled, the Main Files directory is rendered only if it contains main files.