DITA Best Practices : Using paragraph elements

  • This section explains how to use a paragraph, or <p>, element. The <p> element identifies a string of text that has a single main idea.

Within concepts

Concepts allow a degree of flexibility when using concepts; in other words, the DITA schema places fewer restrictions when inserting paragraph elements. Basically, keep your cursor position inside the conbody element to insert paragraphs.

Within a concept, place the cursor either within the paragraph element. Click Enter and select New p at the top of the resulting list.

Within tasks

Tasks do not provide the same flexilibity when using paragraph elements. The DITA schema requires you to use certain parent elements first before inserting paragraph elements.

   

If attempting to add a paragraph in a location not specified within the DITA schema, the following message appears:
This element cannot be inserted at this position. However, if chosen, alternative insert solutions will be proposed.    

 

Within a task, you can use a paragraph element in the following locations:

  • Within a <context> element; you can insert multiple paragraph elements within the context element
  • Within an <info> element; place your cursor outside the command <cmd> element and click Enter. Type p to display those elements that start with the letter p; the paragraph <p> element will appear at the top of the list.
  • Within a post-requisite <postreq> element; place your cursor within the post-requisite element and click Enter. Type p to display those elements that start with the letter p; the paragraph <p> element will appear at the top of the list.