Paragraphs in PSML
Key point: Avoid in list items and table cells, okay in block labels.

Paragraphs are allowed in several context in PSML including block labels, list items, and table cells.

But they aren’t necessary for these to render correctly.

While you’re editing, the ’P’ icon in the editing toolbar indicates whether the content is within a paragraph. Click the ’P’ icon to add or remove the paragraph.

Usage in block labels

Block labels contain paragraphs by default. This is because block labels are more likely to contain multiple paragraphs and other block-level elements such as headings, lists or other block levels.

Even if your block label includes a paragraph, PageSeeder removes the bottom margin from the last element it contains so that it looks right.

Whether the paragraph needs to be there or not depends on the purpose of the block label.

Some block labels are designed to wrap block-level elements, or the content might be quite long, so in that case, using paragraphs is recommended.

Other block labels can be used to contain a single line or some short information. In that case, they can be used as an alternative to a paragraph. Both are correct so output formats need to cater for both situations.

For developers

If you use HTML as a reference, whether you have:

<div class="warning">DO NOT EDIT!</div>

Or

<div class="warning">
  <h4>Warning</h4>
  <p>Please, do not edit the following content.</p>
</div>

is based upon the intent of the <div> and both are acceptable.

Usage in table cells and list items

Table cells and list items aren't designed to contain paragraphs by default. Many lists and tables contain short pieces of content such as single words or numbers that don't need to be wrapped in a paragraph.

For developers

In HTML, lists and tables don't usually need a paragraph. For example:

<ul>
  <li>Neil Armstrong</li>
  <li>Buzz Aldrin</li>
</ul>

Paragraphs are allowed in case you need to have content that spans over multiple lines, but if you use paragraphs, it affects the vertical margins. If you mix table cells or list items with paragraphs with others without paragraphs, the vertical alignment might not be consistent.

Using line breaks instead of paragraphs might be a suitable alternative.

Using roles

If your tables or lists are susceptible to containing paragraphs, consider using a role to distinguish those that might contain paragraphs from those that don't.

Using a role on the table or list lets you attach validation rules to warn users and ensure that the content is consistent. You can also use the role when you format your output to handle paragraphs more consistently. Either way, it improves the quality of your content.