Skriftlig InfoDITA publishingDITA topicsCreating a new DITA topic from a template

Creating a new DITA topic from a template

All information in a DITA publication is placed in topics. A topic is thus an object that contains information. It is important to keep in mind that this object is stand-alone. To create a new topic, one option is to create it from a template.

(This procedure is based on the Tridion Docs database repository and Oxygen XML editor. Other tools have similar functionality.)

Prerequisites

You have all the tools available, and the relevant access rights to develop new content.

Context

A DITA topic is defined as follows:

DITA topic

A DITA topic is a stand-alone data module that contains multimodal text. The module has a title and enough information to explain a specific procedure or concept. Each topic is written in such a way that it is independent of other topics and can be reused in different publications whenever appropriate. The content of the topic is presented in a flat structure. Structure and context are established when the topic is inserted into a topic map together with other topics.

The most important topic types are:

Procedure

  1. From the editor's main menu, select Tridion DocsBrowse repository.
  2. In the database structure, navigate to the folder where you want to establish a new topic.
  3. If necessary, create a new folder: Tridion Docs / Add folder
    1. Right-click on a selected folder and select NewFolder.
    2. In the dialogue box that opens, give the new folder a sensible name.
    3. Set Content type to Topic.
    4. Click OK.
  4. To create the new topic:
    1. Open the folder in which you want to create the new topic.
    2. On the toolbar on the right hand side, click the green + symbol to bring up relevant templates.

      Tridion Docs / Browse repository toolbar

    3. Select the desired template for Task, Concept or Reference topic.
    4. In the dialogue box that opens, fill in all relevant metadata fields.

      Pay special attention to the metadata title. Create a title that meets all relevant naming rules.

    5. Click OK.
  5. Right-click on the new object and select Check out.
  6. Enter the desired content.
  7. Recommended: Before you finalize the topic, do this:
    1. Add two <comment> elements just below the <title>.
    2. Copy the topic's metadata title into the top <comment>.
    3. Copy the topic's GUID identifier into the next <comment>.

    Like this:

    <title>The topic's title (shown in the publication)</title>
    <comment>The topic's metadata title</comment>
    <comment>The topic's GUID identifier</comment>
    

    The information in the comments is displayed when you preview the topic. When you import the topic into a topic map, copy these comments into the map. This allows you to clearly see which topic you have linked to.

  8. From the editor's main menu, select Tridion DocsCheck in.

Related concepts

About DITA topics

Topic content and structure

DITA Task topic

DITA Concept topic

DITA Reference topic

DITA Glossary topic

Stem topic


All external links open in a new window. I take no responsibility for information on external websites, even if I have linked to them. Please report links that do not work.

The information on this page represents my personal opinions and my understanding of the topic being described. Feel free to link to the page, but do not copy large parts of the content without permission. I take no responsibility for any errors, misunderstandings or missing information. I also take no responsibility for any mistakes you may make or cause as a result of incorrect or missing information. You are welcome to contribute with comments, relevant experiences or additional information. See Editor and contact information.

2022-11-29