Configure a preset list of keys

Defining a preset list of keys is useful when you want to enforce consistency for the keywords or external links used in a documentation set.

Rather than each user creating their own keys, you can define a list of the commonly-used or company-approved keys that users can access in the DITA Map view and insert into their maps.

The list is defined in the keydefnames.xml configuration file in system/conf. The file contains two types of keys:
  • Keywords, which are listed in the following section:
    <type label="Keyword" name="keyword">
  • External links, which are listed in the following section:
    <type label="External links" name="xref">

Each key is defined as a <keydefname> element in the appropriate section. Each <keydefname> element contains attributes defining the name of the key and its default value. For example:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE keydefnames PUBLIC "-//ixiasoft.com//cms//config//keydefnames" "keydefnames.dtd">
<keydefnames>
	<type label="Keyword" name="keyword">
		<keydefname name="company" default-value="IXIASOFT"/>						
	</type>
	<type label="External links" name="xref">
	<keydefname name="companyweb" default-value="www.ixiasoft.com"/>						
	</type>
</keydefnames>

To define the list of keys:

  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. Expand the Content Store's Repository node and browse to /system/conf/ to locate the keydefnames.xml file.
  6. Right-click keydefnames.xml and click Check Out.
  7. Double-click the file to open it in the XML editor area.
  8. For each new keyword or external link that you want to specify, insert a new line in the appropriate section using the format <keydefname name="[key name]" default-value="[key value]"/>.
    For example, if you wanted to create a key for the company's name, you would add the following in the section labeled keyword:
    <keydefname name="company" default-value="IXIASOFT"/>
  9. Save, close, and check in the keydefnames.xml file.
  10. Inform users of the changes and request that they close and reopen their IXIASOFT CCMS Desktop to apply the changes.