DITA topics

Understand what are DITA topics in FrameMaker

DITA uses a topic-based approach to authoring. A topic in DITA is the most granular entity of information. According to the DITA specifications, a topic should be short enough to be easily readable, but long enough to make sense on its own.

To cover separate content such as concepts, tasks, reference, the DITA standard specifies different information types. Each information type defines structured elements that aid in authoring the relevant content. For example, the task type defines elements such as <context>, <example>, <steps>, and <result>.

Create a DITA topic

Learn how to create a DITA topic in FrameMaker, manage a DITA topic in FrameMaker

  1. On the File menu, go to New > DITA.

    The DITA sub-menu displays the types of DITA topics and map types that you can create.

    FrameMaker supports the following DITA topic types:

    topic

    For specific content, use task, concept, reference, glossentry, glossgroup types.

    See the specifications on DITA topics.

    task

    For task related content such as how-to or procedures.

    See the specifications on Task topics.

    concept

    For content such as “what is?”. It covers conceptual information about a feature or function.

    See the specifications on Concept topics.

    reference

    For reference content. For example, product specifications, API reference, and equipment or part lists.

    See the specifications on Reference topics.

    glossentry

    For a single glossary term and definition.

    See the specifications on Glossary Entry topics.

    glossgroup

    For a group of glossentry elements.

    The glossgroup can also contain other glossgroup elements to create a hierarchical glossary structure.

    See the specifications on Glossary Group topics.

    ditabase

    A top-level container element that can include the topic types described above.

    See the specifications on DITA container.

  2. Select a topic type.

  3. To view the hierarchical structure of the created topic, choose Structure > Structure View.

  4. A DITA topic is a structured document. This means that in FrameMaker you work with the DITA topic structure in the same way that you work with the structured documents based on other structured applications.

    For details on how to create content in a structured topic, see frm_structauth_sa.html#WS053b9687b4c35b124e2fd7a146eb68148c-8000.

Add links to related content

See how you can add links to related content using DITA link dialog in FrameMaker

DITA Link dialog

Use the DITA Link dialog to insert direct and indirect link to DITA content.

Dita Link dialog
Using the DITA Link dialog to insert direct and indirect link to DITA content

Use the DITA Link dialog to:

A (DITA Element):

Choose the link element to use.

By default, the element is <link>.

See the specifications on link.

B (Target > File):

Check this option to create a link using direct referencing.

See Create a DITA link.

C (Target > Key):

Check this option to create a link using indirect referencing and choose a key from the Key Settings drop-down list.

See Create a DITA link.

D (Target > Both):

Check this option to create a link using direct or indirect referencing.

E (File/Key Settings):

If the target is set to File, select a DITA topic from the list of currently opened topics for direct references. You can also browse to select a topic that is not currently opened.

If the target is set to Key, select a key for indirect reference. You can also open the DITA Keyspace Manager dialog. In this dialog, you Create a keyspace and Set the default keyspace for the current topic.

F (Filter Text):

Search for the required topic or key that you want to create a link to. This smart search filters the elements as you start typing in the Filter Text box. You can filter content on the basis of the element tag, ID, or text (content).

Once you have found the required topic, select an element to include as a link. The link element defines a relationship to another topic.

G (Display Using):

Choose the element that provides the literal label or line of text for a link.

By default, the element is <linktext>.

See the specifications on linktext.

H (Display Using):

Choose the element that provides the literal label or line of text for a link.

By default, the element is <linktext>.

See the specifications on linktext.

H (Text)

Specify the link text to display as literal text.

I (Format)

Choose Format and select a link format from the drop-down list:

DITA Default Format

Display the title of the reference topic.

See_Title_and_Page

Display See <topic title> on <page number>.

Title_and_Page

Display <topic title> on <page>

J (External Link)

Insert a link to an external (non-DITA) resource. In the DITA External Link dialog, provide the source for the external link - Refer to Key or Link Target (href) field.

Optionally, you can specify a link text. Else, the link entered in the Link Target (href) field is used for the link text. You can also insert an external link through the main menu Insert > External Reference or the context menu.

Create a DITA link

  1. If you are inserting the first link in the related-links element, place the insertion point to the right of the related-links element.

    Place insertion point to the right of related-links element
    Placing the insertion point to the right of the related-links element

  2. From the Elements panel (View > Panels > Element Catalog), insert the <link> element.

    The DITA Link dialog is displayed.

  3. Choose the DITA link Element to use.

  4. Choose a link target.

    You can choose to add a link as a direct or indirect reference to the target content. For details, see DITA referencing.

    To add a direct link, you choose the DITA topic (.xml file) to which you want to create the link:

    1. Select the File option for the Target and choose the file containing the reference topic.

      You can select a reference topic from the current topic, any currently opened topic, or use the browse button to select an unopened topic.

    2. In the element list, select the topic to reference.

    To add an indirect link, you need to use DITA key-references. For more details on key-references, see Using keyspaces to manage DITA key references.

    1. Select the Key option for the Target and click Keyspace Manager.

    2. In the DITA Keyspace Manager dialog, select the key in the defined keys list and click OK.

  5. In the Display Using drop-down, choose the element to display the link text.

  6. Specify the text or format to display in the link.

  7. Click Insert.

February 2, 2022

Legal Notices | Online Privacy Policy