Paragraphs (and other block elements) within notes

Avoid using block elements within notes. Only when a note is comprised of more than one idea or point should child block elements be used.

The note element can contain one or more paragraph (p) or other block data elements. Both note and p are block elements.

Mark-up options of:

 There are four forced induction models.


 <p>There are four forced induction models.</p>

are both valid, but using both mark-up options will result in inconsistency.

It is arguable that the two options are semantically different. A paragraph is a self-contained unit dealing with a single idea. A note has a separate semantic purpose, to highlight ancillary or associated ideas. A single note therefore has no need to contain a paragraph. However, in many cases, there will be more than one ancillary (note) idea, resulting in a need to break the note text into constituent blocks.

The simplest form of mark-up reflects the best practice.

If there is just one block of text in the note, then the note should be left as string-only. This stores the minimum of mark-up, and simplifies the processed output. If there are multiple blocks in the note, then paragraphs, lists (or other block elements) should be used. Never start with string data followed by a block.

In a set of notes, if there is a need for one note to include block elements, then all notes in the set should be consistently treated. Using mixed mark-up methods (blocks in some notes and string-only in others) are likely to result in inconsistent rendering of the output.

String-only text should not be used in the same note alongside block elements.