Skip to main content

By clicking Submit, you agree to the developerWorks terms of use.

The first time you sign into developerWorks, a profile is created for you. Select information in your profile (name, country/region, and company) is displayed to the public and will accompany any content you post. You may update your IBM account at any time.

All information submitted is secure.

  • Close [x]

The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerworks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

By clicking Submit, you agree to the developerWorks terms of use.

All information submitted is secure.

  • Close [x]

Frequently Asked Questions about the Darwin Information Typing Architecture

Answers about the XML-based Darwin Information Typing Architecture (DITA) for documentation

Return to article

The structure of a DITA topic

A topic is structured by required elements (shown here with orange labels) and optional elements (shown with purple labels). The body of a topic allows for rich description (blue text fields and green containing blocks). A topic may directly include one or more child topics in its {include zone}.


 

[topic]

[title]Title for the topic
{document metadata}

 
[body]
 
  [p]A topic may contain nearly any combination of text elements, including lists...
 
[ul]
  • [li]List item.
  • [li]List item.

[p]definition lists...
 
[dl]
[dt]Term
[dd]And its definition...

[p]and so on.

{include zone}

And here is how that topic might appear in a structured editor in its "tags-on" mode:

{short description of image}

Return to article