Configure the Document Types panel

You can configure the contents of the Document Types panel in the Search View.

In the default configuration, the Document Types panel looks as follows (when the Maps type is selected):
Default Document Types panel
The Document Types panel is configured in the equivalence.xml file. This file determines how DITA and custom objects are handled by the CCMS interface. Objects that are designated as equivalent to topics, for example, display the same right-click menu options and are searched in a similar manner.
The following code shows the default configuration in the equivalence.xml file for the Maps document type:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE equivalences PUBLIC "-//ixiasoft.com//cms//config//equivalence" "equivalence.dtd">

<equivalences>
   <equivalence type="map" standardSearch="true" groupName="Maps">
      <object type="map"/>
      <object type="bookmap" icon="/system/conf/icons/bookmap-icon.png"/>
      <object type="subjectScheme"/>
   </equivalence>
	
...
</equivalences>

The following table describes the elements and attributes used to configure the Document Type panel:

Table 1. Elements and attributes of the equivalence.xml file
Element Description
<equivalence>

Defines a top-level document type in the Document Type panel (for example, Maps, Topics, etc.)

It has the following attributes:
Attribute Description
type Type of the object. This must be a valid type (for example, map, topic, resource, etc.).

Mandatory.
standardSearch Indicates if this type is displayed in the Document Type panel.

Valid values are true (type is displayed) and false (type is not displayed). This attribute is optional; if not specified, it defaults to true.

groupName Label displayed in the Document Type panel.
This attribute is optional; if not specified, it defaults to the value of the type attribute. All the <equivalence> objects with the same group name will be organized in the same drop-down list. For example, consider the following configuration:
<equivalence type="project" standardSearch="true" 
             groupName="Others">
   <object type="project"/>
</equivalence>

<equivalence type="snapshot" standardSearch="true" 
             groupName="Others">
   <object type="snapshot"/>
</equivalence>
Both project and snapshot will appear in the Others drop-down list.
<object> Defines the items in the document type's drop-down list.

It has the following attributes:
Attribute Description
type Type of the object. This must be a valid type (for example, map, topic, resource, etc.).

Mandatory.
icon
Specifies a link to the icon that should be used for this object in the view. The image must be stored in the Content Store. For example:
<object type="bookmap" icon="/system/conf/icons/bookmap-icon.png"/>

To configure the Document Types panel:

  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click OK.
  2. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
  3. When the Connect as dialog opens, type your username and password and click OK.
  4. Double-click the name of your docbase to open a connection to the Content Store.
  5. Locate the equivalence.xml file in the repository's /system/conf collection.
  6. Check out the file.
  7. Open equivalence.xml with a text editor.
  8. Make the necessary changes in the file.
  9. Save, close, and check in the equivalence.xml file.
  10. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their . Users can also apply the changes without restarting their IXIASOFT CCMS Desktop by clicking DITA CMS > Synchronize Configuration.