×

Topic's export conditions

 
In this dialog window, you can define rules to include or exclude a topic in the exported document.
 
To access the dialog, select the topic in the topic tree and press in the Properties pane.
 
The following dialog window will appear:
 
 
The composite rule consists of several basic logical conditions. During export these conditions are evaluated to determine whether the topic should be included into final document.
 
There are two types of basic conditions:
  • Validating if the current Export format is included in the set of allowed formats.
  • Validating if the current value of a Variable meets a specific criterion.
 
By adjusting the values of various variables before export you can control which topics will be included into export. This approach enables exporting multiple documents that contain shared content from a single Dr.Explain project. For example, you can create User manual, Operator manual, and Administrator manual from the same Dr.Explain project.
 
The first logical condition is special. It contains the list of all possible formats that this topic is allowed to be exported into. All other conditions are added to this first one via logical operator AND.
 
If you need to set an export condition for a specific format (e.g. check variable's value), you must specify this format in both first block and the block with the variable.
 
 
The screenshot demonstrates the following set of conditions:
(Current HTML export format is HTML () OR DOCX () OR PDF ())
AND
(
  (Current export format is HTML) AND (OS variable contains text nix)
  OR
  (Current export format is DOCX OR PDF) AND (OS variable contains text win)
)
 
Thus, this topic:
  • will not be exported to CHM because the CHM () button is not active in the very first condition;
  • will be exported to HTML only if variable OS contains text nix;
  • will be exported to DOCX and PDF only if variable OS contains text win.
 
Similar interface is also used to setup export conditions for text blocks to include or exclude parts of the topic's content from export.
Made by Dr.Explain, software documentation tool