Defining a master list of keys is useful when you want to enforce consistency for the
keywords or external links used in a documentation set.
About this task
Rather than each user creating their own keys, you can define a list of the commonly-used or
company-approved keys that users can insert into their maps using the DITA Map
view.
Once inserted into a map, the keys can be used within topics attached to the map.
Users can also edit the definition of a key within the map, although the default
definition within the master list remains unchanged.
This master list of keys is available only in CCMS
Desktop.
Important: Make configuration changes in a test
environment and confirm they work before copying them to a production
environment.
Procedure
-
In the TEXTML Administration perspective, connect to your server.
-
Check out and open the /system/conf/keydefnames.xml
file.
-
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, to create a key for the company's name, add the following in the
section labeled keyword:
<keydefname name="company" default-value="Acme, Inc."/>
To create a key for a link to the company's support site, add the following
in the section labeled External links
<keydefname name="support-site" default-value="http://www.acmeinc.com/support"/>
When a user adds a key from the External links list to a
topic, the CCMS automatically adds the
@scope="external" attribute, as required.
-
Save, close, and check in the file.
-
Inform users of the changes and ask them to close and reopen their CCMS Desktop to apply the changes.
