Configure the conditions used in the DITA CMS

Conditional attributes let users tailor the same document for different audiences and products. The DITA CMS supports the DITA attributes that let you hide portions of text—or even entire topics—that don't apply to a specific audience, product, platform, etc.

Users can apply conditions on objects in a map and then specify the conditions to display when they generate their output.

For example, when users click the Set conditions button, the Set conditions window lists the conditions that are currently configured in the CMS, grouped by attribute, as shown in the following diagram:


Set conditions dialog
Also, when users create Ditaval files through the DITA CMS, a list of conditions is displayed in the Create Ditaval dialog, as shown in the following diagram:
Create Ditaval dialog
As the DITA CMS system administrator, you need to configure the conditions that will be listed in these dialogs. You configure this information in the conditionaltext.xml file.

To configure conditions:

  1. Open the TEXTML Administration view.
  2. Connect to your server and docbase.
  3. Locate the conditionaltext.xml file in the repository's /system/conf collection.
  4. Check out the file.
  5. Open conditionaltext.xml with a text editor.
  6. For each condition to display in the dialogs, create a <category> entry, specifying the following information:
    <condtextsettings>    
        <category name="condition_name" xmlattribute="attribute_name">
            <allowedvalue>value1</allowedvalue>
            <allowedvalue>...</allowedvalue>
            <allowedvalue>valuen</allowedvalue>
        </category>
    </condtextsettings> 

    Where:

    Option Description
    condition_name Name of the condition as displayed in the dialogs
    attribute_name Name of the XML conditional attribute as defined by DITA 1.2
    value1, value n Value that can be set for this condition. Create one <allowedvalue> element per valid value.
    For example, to create the dialogs shown above, enter the following code:
    <condtextsettings>    
        <category name="Audience" xmlattribute="audience">
            <allowedvalue>end_user</allowedvalue>
            <allowedvalue>sys_admin</allowedvalue>
        </category>
        <category name="Platform" xmlattribute="platform">
            <allowedvalue>windows</allowedvalue>
            <allowedvalue>linux</allowedvalue>
        </category>
        <category name="Product" xmlattribute="product">
            <allowedvalue>Product A</allowedvalue>
            <allowedvalue>Product B</allowedvalue>
        </category> 
    </condtextsettings>
  7. Save, close, and check in the conditionaltext.xml file.