DITA Best Practices : Using Notes in a Task

Use the <note> element to call attention to a particular point. The <note> can be designated as a caution, warning, or note depending on the attribute you select for the element. Tasks place increased restrictions when using the <note> element compared to a concept. The more common locations are presented below:

  • Inside a <step> and <cmd> element, place the <note> element inside an <info> element.
  • Inside a <p> element within the <context> element.
  • Inside a <stepresult> element.
  • Inside a <postreq> element after the <steps> element.

NOTE: The <note> can be designated as a caution, warning, or note depending on the [value of the type] attribute you select for the element. 

Steps

To add a note

  1. Place your cursor in the desired location and click the Enter key. This step assumes your carat is located in the correct location with your concept, task, or reference and complies with the DITA schema for your information type. See above for more information.
  2. Enter "n" in the search box, select Note, and press Enter