Add a topic template

A topic template provides the structure for the topic object to make topic creation simpler for the user. A topic template consists of a DITA topic source file, and a short description of how the topic should be used.

This feature enables the system administrator to create a specific topic structure to guide writers or subject matter experts (SMEs) during authoring.

For example, if your team produces content that describes how a feature works, you can include conceptual structural information to act as a prompt, such as a header named How this feature works. Writers or SMEs then select and complete the section with appropriate content or submit the topic to an Information Architect for more specific additions.

To add a topic template:

  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 expected type of information in the topic.
  5. In the Source File field, choose a topic type appropriate for the document.
    Table 1. Available topic types
    Topic type Function

    Concept

    Provides intended audience with the context and general information about a primary idea or feature

    Note: This is one of the three primary DITA topic types.

    Glossentry

    Contains an individual glossary entry that defines an specific term used in the content

    Referable-content

    Links paragraphs or phrases reused in multiple locations within the document using a content reference (conref)

    Reference

    Acts as a repository for facts or constructs and can contains specific values, settings, operands, protocols or property tables

    Note: This is a very specific type of DITA structure that does not act as a concept or task.
    Note: This is one of the three primary DITA topic types.

    Task

    Acts as a repository for information used to complete a procedure as an ordered sequence of steps and choices.

    Note: This is one of the three primary DITA topic types.

    Topic

    Acts as a generic form of topic

    Troubleshooting

    Contains helpful information used to solve a specific problem
  6. Select the types of user Roles expected to interact with that topic type.
  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 with that role.