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 is designed to provide the structure for a particular topic type.
For example, if your team produces content that describes the concept of how a
feature works, you can structure that topic. It may include structural information
that can act as a prompt to the writer, by including 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.
To create a new topic template, do the following:
-
From the Administration menu, click .
-
Click Add.
-
In the Display Name field, enter a descriptive name for the topic.
-
In the Description field, enter text that refers to the type of information
expected in the topic.
-
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
-
Select the types of Roles that the topic is applicable
to.
-
Click Save.
When a new topic template is created, the newly-created topic template
becomes available from a list of available templates for users.
