Add a topic template

A topic template determines the structure of the topic object created when a user creates a topic. A topic template consists of a DITA topic source file, and a short description of what the topic should be used for.

This feature enables the administrator to create a specific structure for a topic so that the writer or SME can be guided on what information needs to be added. If your team produces content that describes the concept of how a feature works, you can include structural information acts as a prompt to the writer. For example, the topic could include a header saying "How this feature works". It can then be selected and "filled in" with appropriate content by writers and SMEs, or for more specific topic additions by an Information Architect.

  1. From the Administration menu, click Templates > Topic Templates.
  2. Click Add.
  3. In the Display Name field, enter a descriptive name for the topic.
  4. In the Description field, enter text that refers to the type of information expected in the topic.
  5. In the Source File field, choose a topic type appropriate for the document.
    Available topic types include:
    • concept: a topic to inform users about what a feature is
    • glossentry: a topic for holding individual glossary entries, used for defining individual terms
    • referable-content: a topic specifically for holding conref-able paragraphs or phrases intended for reuse
    • reference: a topic detailing the specifics values or settings for a feature
    • task: a topic conveying a step-wise procedure
    • topic: a generic, un-typed topic
    • troubleshooting: a topic to help a user solve a specific problem
  6. Select the types of Roles that the topic is applicable to.
  7. Click Save.
When a new topic template is created, the newly created topic template becomes available from a list of available templates for users.