DITA Best Practices : Creating or Modifying Product Attributes

Typically, Oxygen .PDF transformations are dictated by the product attribute assigned to the appropriate information container (ditamap). This procedure explains how to create or modify a product attribute. For example:

  • You need to create a new product attribute for use in the Oxygen .PDF transformation
  • Your product name has changed (e.g. Hosted Doc Services to Expere Document Services)

This involves manipulating the following files within TFS:

  • dita2fo-shell-wkfs-tw.xsl ($/FS.InfoDev/Dev/dita/DITA-OT/xsl)
  • cmn-project-names.dita ($/FS.InfoDev/Dev/conrefs)

dita2fo-shell-wkfs-tw.xsl

  1. Double-click the file to open it in a new TFS window. 
  2. To add a new product attribute, copy an existing <xsl:when/> statement; for example:
    <xsl:when test="//@product = 'docprep'">
     Document Preparation
    </xsl:when> 
  3. Paste the <xsl:when/> statement, preferably alphabetically within the existing list of products.
  4. Change the @product = variable; add the appropriate product name in the second line.
  5. To change an existing product attribute, locate the desired <xsl:when/> statement; change the @product = <product name>; change the product name in the second line.
  6. Navigate to the PREFACE FRONT MATTER section; to add a new product, copy an existing <xsl:when/> statement: for example:
    <xsl:when test="@product='docprep'">
    <xsl:text>VMP is a registered trademark of Wolters Kluwer Financial Services, Inc. </xsl:text>
    <xsl:text>All other trademarks are the property of their respective owners.</xsl:text>
    </xsl:when>
  7. Typically, any specific copyright information will reside within the first <xsl:text/> line. For example:
    <xsl:text>VMP is a registered trademark of Wolters Kluwer Financial Services, Inc. </xsl:text>
  8. Consult product management to determine the appropriate language for your product.
  9. Add a note at the top of dita2fo-shell-wkfs-tw.xsl stating the changes/additions.

cmn-project-names.dita

  1. Double-click the file to open it in a new TFS window. 
  2. To add a new project name, copy an existing <keyword/> statement; for example:
    <keyword id="expere-tools" product="expere-tools">Expere Engine</keyword> 
  3. Paste the <keyword> statement, preferably alphabetically within the existing list of products.
  4. Make the following modifications: 1.) Change the id= <"product name">; 2.) change the product=<product name>; 3.) change the text value (e.g. Expere Engine).
  5. To change an existing project name, locate the desired <keyword> statement. It is recommended that you just change the text value (e.g. Expere Engine).