loading table of contents...

2.3.2. Root folders

The content workspace shows the hierarchical structure of the product documentation. Following folders are displayed as 1st-level folders in the content workspace:
screen_root_nodes

Figure 2.3.6. Root nodes in the content workspace

callout_1 Content
This is the top-level section of the complete product documentation. It contains section- and content-nodes which make up the structure and content of the product documentation. A section can itself contain sub-sections, content-nodes and folders, thereby forming the hierarchical structure of the product documentation.
callout_2 "Media" folder
The "Media" folder can be used to store images which are referenced from within the product documentation. This allows you to separate the image files from the text-based content. The "Media" root folder should be used when the storage structure of the images has to be different from the hierarchical structure of the content. For example, if all screenshots within the product documentation shall be stored in one single folder, then an image folder named "screenshots" could be created as a sub-folder of the "Media" root folder (see Section 2.3.4.1, “Inserting and editing nodes” on how to create image folders).
Alternatively, the images could be stored within the content structure. To do this, create an image folder as a sub-folder of a section. For example, if images are only referenced from within a single section, then an image folder could be created as a sub-folder within this section, and all referenced images could be placed inside this image folder.
callout_3 "Files" folder
The "Files" folder can be used to store the "non-visible" parts of a documentation. For example, normally only bitmap images are included in the content of the product documentation. Nevertheless, it could be useful to still have the vector-graphic source files available as part of the product documentation, e.g. in cases where the bitmap images have to be reworked. Therefore, the vector-graphic images could be stored in the "Files" folder. As another example, the "Files" folder could be used to store any documents that were used as input for the documentation (e.g. a requirements specifications).
Beside using the "Files" root folder, you are also allowed to create your own file folders at nearly any location, e.g. as a sub-folder of a section or as a sub-folder of an image folder. Of course, a file folder can itself contain file-folders, i.e. making up a directory structure similar to a filesystem. See Section 2.3.4.1, “Inserting and editing nodes” on how to create file folders.
Although a file folder is intended to store the "non-visible" parts of the documentation, it is allowed to store content nodes and sections within a file folder. For example, a section could be moved temporarily into a file folder to exclude it from the "official" product documentation (i.e. make it invisible).
callout_4 "System" folder
The "System" folder contains configuration data which can be adapted to allow product-specifc customizations. When a new product is created, the "System" folder initially contains following sub-nodes (see screenshot above):
  • "HTML customization"
  • "Images"
  • "Templates"
  • "gentext.properties"
The usage of the "gentext.properties" file () is described in Section 2.3.6, “Gentext configuration”. Following a description of the other nodes:
callout_5 "HTML customization"
This folder contains customization files that are used for HTML and Web-Help export.
"Images"
This file contains images that may automatically be added to exported publications. For example, this folder contains the watermark image that is used to mark draft publications.
"Templates"
The "Templates" section contains content-nodes which are selectable as templates from within the content editor. See Section 2.3.8.12, “Templates” for details on how to insert template content. This folder initially contains some example templates. You can edit these examples and/or add your own templates by adding new content-nodes to the "Templates" folder. See Chapter 1.9, Templates for an introduction on using templates.
Important!
The "Templates" section is located by Docmenta through its alias name "system_templates". Therefore do not change or delete this alias name!