<note>: How do you use the <note> element to add informative notes or sidebars within the content of a DITA topic?

November 10, 2023
|By Bryan Tipper

The <note> element in DITA XML allows you to add informative notes or sidebars within the content of a DITA topic. These notes can provide additional context, explanations, or insights related to the main content, making it easier for readers to understand and engage with the information presented.

Usage of <note> Element

To use the <note> element, you typically place it within the <body> of a DITA topic. The <note> element can have various attributes, such as “type” to specify the type of note (e.g., “tip,” “important,” “warning”), and “title” to provide a title for the note. The content of the note is placed within the <p> (paragraph) element or other appropriate elements to structure the note’s content.

Example:

Here’s an example of how to use the <note> element to add an informative note to a DITA topic:


<topic id="example_topic">
  <title>Using Advanced Features</title>
  <body>
    <p>This topic covers advanced features that can greatly enhance your productivity when using the software.</p>
    
    <note type="tip" title="Pro Tip">
      <p>Consider using keyboard shortcuts to speed up your workflow.</p>
    </note>
    
    <p>These advanced features provide powerful capabilities for experienced users, but they may require some practice to master.</p>
  </body>
</topic>

In this example, the <note> element is used to insert a “Pro Tip” sidebar note within the topic’s content. It provides a quick and valuable tip for readers to consider while engaging with the main content.