DelphiDabbler Code Snippets Database v2
REML Markup Language

Introduction

REML is a little markup language that can be used to style text. It is used in the Code Snippets collection's meta data for certain properties of a snippet.

The REML language is a SGML language similar to a greatly simplified XHTML. The are a small number of tags and character entities that can be used.

Tags

There are two types of tags: block level and in-line.

If an unrecognised tag is encountered an REML code the interpreter should report an error. However, providing start and end tags are matched, the interpreter may choose to simply ignore the tags.

Block Level Tags

Block level tags separate the enclosed text into paragraphs of some description. The supported tags are:

The following rules apply to the use of block level tags:

Here is a valid example:

<heading>Hello</heading>
<p>Hello World</p>

Strictly speaking, the following example is invalid code – all occurrences of wrong are in error because they are not contained within block tags.

wrong <heading>blah</heading> wrong <p>blah</p> wrong

However interpreting code may interpret this permissively. If this is done the text outside blocks must be interpreted as if it was enclosed in <p> and </p> tags. Therefore the above code would be interpreted as:

<p>wrong </p><heading>blah</heading><p>wrong </p><p>blah</p><p>wrong</p>

Inline Tags

In-line tags format the text enclosed between the start and end tags.

Here are the available in-line tags:

The following rules apply to the use of in-line tags:

Examples:

<p>Make stuff <strong>stand out</strong>.</p>
<p><em>Emphasised <warning>warning!</warning></em></p>
<p>Refer to a function <var>parameter</var>.</p>
<p>Use the: <mono>Windows</mono> unit.</p>
<p>See this <a href="http://example.com">example</a>.</p>

Character Entities

A few symbolic character entities are supported in REML. Here is the complete list:

To express other special symbols for which there is no symbolic character entity, numeric character entities can be used. For example to display the 'ΒΆ' character (Unicode pilcrow sign) use &#182;.