Define a new publishing tag

Publishing tags are properties that are applied to a map and its topics when a map is published.

Publishing tags appear when a user selects the Publish option for a map, as shown below. For example, a user can select the Version publishing tag and enter a new version number for the map being published. Once published, the new version value appears in the published DITA map's Version column.

Figure: Configured publishing tags



Publishing tag values are also written into each document's Custom Properties file; for example:
<version>4.0</version>

To define a new publishing tag:

  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 publishtags.xml file in the repository's /system/conf collection.
  6. Right-click the file and click Check Out.
  7. Double-click the file to open it in the editor.
  8. Create a new <tag> element; for example: 
    <tag cascade="true"  label="ISBN" mandatory="false" metaname="isbn">
</tag>
    Table 1. Tag element attributes
    Attribute Description Value
    cascade Determines whether the user-entered value is written to all children elements (true) or just to the map itself (false). true or false (default)
    label Determines the tag label displayed in the Publishing Tags dialog box. Any sequence of characters.
    mandatory Determines whether the user must enter a tag value.
    • true – user must enter a value to publish.
    • false (default) – publishes without user input.
    metaname Defines the element where the user input will be written in the Custom Properties file. Must be the same as the NAME attribute of the corresponding index definition.
    historical Uniqueness Index If present, TEXTML Server verifies that the publishing tag value is unique within the index. For example, for the version tag, this means that you won't be able to reuse a publication version when publishing. Must be the same as the name of the corresponding index definition. For example, to indicate that the version value entered by the user must be unique within the index, enter:
    historicalUniquenessIndex="version"
  9. Create one or more <classbehavior> elements to determine how the publishing tag values will be written into the Custom Properties file of each type of object, as follows: 
    <classbehavior ditaclass="- map/map" name="override" value="false"/>
<classbehavior ditaclass="- topic/topic" name="override" value="false"/>
    Table 2. Classbehavior element attributes
    Attribute Description Value
    ditaclass The class of document object.
    For maps, enter:
    - map/map
    For topics and images, enter:
    - topic/topic
    Note: In this file, an image is treated as a topic by the CMS. Publication information is written into its Custom Properties file.
    name Determines the action taken with respect to existing information in an object's Custom Properties file. Only override is supported. The implementation depends on the value attribute, described below.
    value Determines whether the override action is actually carried out.
    • true – existing publishing tags with the same metaname are overwritten.
    • false – the system adds another publishing tag with the same metaname to the object's Custom Properties file.
  10. Save, close, and check in the publishtags.xml file.
    The next time that a user publishes a document using the new tag, the tag value will be written to each document's Custom Properties file.
  11. 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.