Topic Elements

You can include any of these elements in a topic. The DITA rules define where you can insert an element and controls the list of available elements in the Insert menu based on the location of the cursor.

See Also
Toolbar

The descriptions in this table apply to elements added from one of the sections of the Insert menu.

  • When you add tables, images, and any element from the Containers section, the element is created within the topic.
  • When you add an item from the References section, its source is at a different location in this topic, or in another topic or key. The reference loads the content into the topic and includes it in the published document.

For descriptions of the XML elements, see XML Element Reference.

Element Description
Topic Title The name you entered in the map pane as the topic title. You can edit and format the text for the title as required, and add phrases or images. When you save the topic, the app updates the name in the map to match.

When the document map is published, each topic's title becomes the table of contents entry for that topic.

For more information, see Creating Topics.
Body The body contains all the elements. You do not create or edit the body; it is used only as a container.
Paragraph The basic element used in topics. Format the text as required. Include key phrases, images, and cross-references. Editing text in paragraphs works the same as in most word-processing apps.

The paragraph symbol () indicates an empty paragraph. When you start entering text, the text replaces the symbol. Press Enter to start a new paragraph.

If you enter double spaces anywhere, the next time the app opens the topic it removes one of the spaces.
Preformatted Paragraph A preformatted paragraph works similar to a normal paragraph, except that when published the text uses a fixed-width font.

When you press Enter in a preformatted paragraph, the app adds a new line to the preformatted block, it does not start a new paragraph. You can format the text and add phrases and cross references, but you cannot add items such as images, tables, and lists. If you add an unsupported element, the app inserts that element after the preformatted block.
Note When you add a note, the app adds a container that includes a list with a line above and below it. You can include any number of paragraphs, lists, and images within the note container.

Select the type of note you want to insert:

  • Note
  • Tip
  • Fastpath
  • Restriction
  • Important
  • Remember
  • Attention
  • Caution
  • Notice
  • Danger
  • Warning
  • Trouble

For attention, caution, danger, trouble, and warning, the app adds a warning symbol.
Image You can include GIF, SVG, PNG, and JPEG images.

When you insert an image, you select a file and define the alternate text.

For more information, see Working with Images.
Bulleted List A bulleted list, also called an unordered list. Click and the app adds the first bullet. When you press Enter, the app adds the next bullet. In the breadcrumb trail, the list shows with the element name "Unordered list," and each bullet shows as "List item \ Para."

To end the list, press Enter then click to disable the bullets.
Numbered List

A numbered list, also called an ordered list. Click and the app adds 1. to the topic. When you press Enter, the app adds the next number. In the breadcrumb trail, the list shows with the element name "Ordered list," and each number shows as "List item \ Para."
Table Adds a table: rows and columns, plus a table header. You can add tables within other elements such as sections and lists, but not within the title or short description.

When you insert a table, you select the number of columns. You can add additional rows and columns as required. Cells in the table can contain text, images, lists, and more. With the cursor placed in a cell, you can click the Insert menu to see what can be added to cells, and right-click to see the context menu.

For more information, see Creating Tables.
Figure Figures let you associate titles and numbers with images and tables. The numbers start at 1 for a topic, but when a document map that includes the topic is published, the figure numbers are continued from prior topics. You cannot create separate numbering sequences for images and tables.

When you insert a figure, the app adds an auto-number and an empty field where you enter the figure Title. In the paragraph after the title, insert an image or a table. You can also insert paragraphs, notes, content references, and other elements available in the Insert menu.

You can click Figure in the breadcrumb trail to see the container that includes all the elements added to the figure.

For more information, see Inserting Figures.
Footnote A footnote to the current element. The app adds a superscript number as a cross-reference indicator at the cursor location and the footnote container at the bottom of the topic. You can enter a specific footnote callout used instead of a number.

When you add additional footnotes, the app updates all the numbers depending on the location of the new footnote. The app numbers footnotes consecutively within a topic and restarts at 1 for each topic. The footnote sequence is not carried over to other topics when the document map is published.

For more information, see Using Footnotes.
Section Subdivides a topic. Sections contain titles, paragraphs, lists, images, tables, and more. When you use sections in a topic, all content in the topic (except for the title and short description), must be contained within a section.

When you insert a section, the app adds an auto-number (starts at 1 for the first section in a topic) with a field. Additional sections are numbered consecutively.