Create a new map template

Map templates allow users to produce documents with a consistent structure and appearance, without duplication of effort. For example, you can set up map templates with the company's standard cover, legal notices, and frontmatter, to which members of the documentation team can add content.

You can also incorporate variables into the map template which can be replaced by actual values when a map is created. The variables act as placeholders for content entered or selected by users as they create a map.

The names of the variables contained in the template are made available in the Create Map dialog box when the user clicks IXIASOFT CCMS > Create Map.

To create a map template:

  1. Create a map with the required cover and frontmatter, plus any other content that will be common to all documents based on this template.
    Tip: If using an existing map as your starting point, clone it first and rename it (for example, ProductATemplate).
    CAUTION: Do not include topics or images that can vary from document to document, because if these or their dependent images are deleted, maps created with the template will have errors.
  2. Right-click the map and select Generate Output.
    The Generate Output window appears.
  3. From the Output Format drop-down menu select Export and click Create.
  4. In the Save As dialog, choose a path to a local folder. Click Save.
    The file is saved and given a system name (typically a numerical string) and the suffix ditamap.
  5. Rename the exported map filename so the template can be easily recognized by users.
  6. Open the template map in a text editor.
  7. Strip out all references to codeph and the number that follows it within the topic.
    For example: ixia_locid="6", along with all other instances. If you are using an editor that uses regular expressions, you can use the following expression to find all instances of ixia_locid and its following number: \b(ixia_locid)( |=)=? ?"\d+\b". The matches all occurrences of the ixia_locid attribute in content, along with values of any number of digits.
  8. If the template will only be used in IXIASOFT CCMS Desktop, add template variables:
    Important: The map template MUST include the ID, language, and title variables, or the map created from the template will be invalid.
    1. Delete the existing map ID attribute value and replace it with the following variable: {{ixia.id}}
      For example: 
      <bookmap id="{{ixia.id}}" xml:lang="{{ixia.xml:lang}}">
    2. Delete the existing xml:lang attribute value and replace it with the following variable: {{ixia.xml:lang}}
      For example: 
      <bookmap id="{{ixia.id}}" xml:lang="{{ixia.xml:lang}}">
    3. Delete the existing title and replace it with the following variable: {{ixia.title}}
      For example: 
      <title>{{ixia.title}}</title>
    4. If your organization has custom template variables, add those variables to the template.
  9. If the template will be used in IXIASOFT CCMS Web, ensure the template does not include any of the variables mentioned in the previous step.
    Important: Template variables are not yet supported in CCMS Web. Omit variables in the template source files that will be used as map templates or topic templates in CCMS Web.
  10. Save the template.
  11. 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 > Perspective > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click Open.
  12. 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.
  13. When the Connect as dialog opens, type your username and password and click OK.
  14. Double-click the name of your Content Store to open a connection to it.
  15. Navigate to /system/templates/maps.
  16. Navigate to a subfolder such as web or desktop to differentiate between templates used for the IXIASOFT CCMS and CCMS Web.
    If the subfolders do not exist, you can create them by right-clicking the maps folder and selecting Create Collection.
  17. Right-click the maps collection and select Insert Documents.
    The Insert Documents Dialog window appears.
  18. Click Add File and browse to your desktop.
    1. Select the file.
    2. Right-click the file and rename it (for example, ProductATemplate.ditamap); press Enter.
    3. Click Open.
    The file path and name appear under Import As.
    Figure: Importing a map


  19. Click OK.
    The file is imported into the /templates/maps collection.
  20. Inform users of the changes and request that they close and reopen their CCMS Desktop to apply the changes.