Hints for LW-DITA elements

Common topic elements

prolog

Use the prolog section to provide meta-information using the data element.

section

Use sections to organize subsets of information that are directly related to a topic.

dl

Use a definition list to provide definitions for specific terms. The term is specified in a definition term (dt element) and the definition is marked with a definition description (dd element).

fig

A figure defines a display context with an optional title and diverse content, which usually includes an image element.

object

Use an external object to refer to external resources, a video for example. To specify the video URL use a parameter with name src.

simpletable

Use simple table for tables with regular structure and without a caption.

p

Normal paragraph content.

pre

Preformated content, preserves line breaks and spaces.

ul

Unordered list.

ol

Ordered list.

DITA Topic elements

topic

A lightweight DITA topic.

title

The topic title must clearly convey the content found in the topic.

shortdesc

Use the short description to expand the title, providing additional information about the content of the topic. It should always be composed of complete sentences and form a comprehensive thought.

body

The topic body contains the content of this topic. This may start with paragraphs, lists, tables, etc. and then optionally follow with one or more sections.