Block label
Key point: Use block labels to give a specific meaning or purpose to a block of content.

Block labels have a name and can wrap a block of content such as a paragraph or a list. By wrapping them, you can associate semantics with them and make them appear inside a colored block in the user interface.

A block label is the equivalent of paragraph style in most unstructured document editing and publishing applications, which is a collection of format settings under an arbitrary name so a user can apply the identical settings elsewhere.

To use a label inside a portion of text, use an inline label instead.

Block labels use the icon in the editor.

Usage

Block labels are useful to create notes, cautions, and warnings.

For example, you can configure your document or group to use a block label named “note”. Any content that you wrap with that label now appears inside a colored “note” block.

Apart from showing the content inside a colored block in PageSeeder, block labels are also available to the publishing engine and third-party tools.

For example, if you publish your document to a website with a “warning” label, your website might apply some formatting to display a warning icon and red or orange color.

Avoid wrapping block labels inside block labels. Although PageSeeder accepts this, it is often confusing and can be a sign that your content is overly complex.

Adding/removing block labels from content

For information on adding/removing block labels from content, see block labels with the default editor.

Configuration

Project managers can define block labels:

  • As part of the document type, in which case they are only available for that type of document.
  • As part of the project configuration, in that case, they are available for any document in all the groups within that project.
  • As part of the global template, which makes them globally available.

You can configure your block labels to use different colors, so that they can be more easily distinguished. 

For developers

In PSML, block labels are represented using the <block> element.

For more information, see the block element in the PSML reference on the PageSeeder developer’s website.