REML is CodeSnip's own little markup language that can be used to style the text of a snippet's description and / or extra information.
The REML language is a SGML language similar to a greatly simplified XHTML. The are a small number of tags you can use. Firstly there are two block-level tags that render text in paragraphs, while the other tags format text inline or embed hyplerlinks.
The following rules apply to the use of <p> and <heading>
Here are some valid examples:
Srictly speaking, the following example is invalid code – the highlighted sections are in error, because they are not contained within block tags.
blah <heading>blah</heading> blah <p>blah</p> blah
However, CodeSnip is quite permissive and, in many cases, automatically adds <p>...</p> tags for text that is not enclosed in block level tags. The above code is interpreted as:
<p>blah </p>
<heading>blah</heading>
<p>blah </p>
<p>blah</p>
<p>blah</p>
Here are the available inline tags:
The "<" and "&" characters are special within the markup and must not be used directly, even when you are just entering plain text. You must use the < character entity in place of "<" and & instead of "&".
A few other character entities are supported for convenience. Here is the complete list:
<
for <
>
for >
"
for "
&
for &
©
for ©
By way of an example, if you want to display x < y, use:
x < y
No other symbolic character entities are supported. However, numeric character entities can be used to insert other characters by specifying its code. For example @ is equivalent to "@".
Numeric entities should be used with caution. Using a code that is specific to an ANSI character set may cause unexpected results because CodeSnip uses Unicode internally and the specified character code may not represent the same character in ANSI and Unicode.