Zettelmarkup: Inline-Structured Elements

00001007040000 · Info · (manual) · #manual #zettelmarkup #zettelstore (all)

Most characters you type is concerned with inline-structured elements. The content of a zettel contains is many cases just ordinary text, lightly formatted. Inline-structured elements allow to format your text and add some helpful links or images. Sometimes, you want to enter characters that have no representation on your keyboard.

Text formatting: Every text formatting element begins with two same characters at the beginning. It lasts until the same two characters occurred the second time. Some of these elements explicitly support attributes.
Literal-like formatting: Sometime you want to enter the text as it is.; This is the core motivation of literal-like formatting.
Reference-like text: You can reference other zettel and (external) material within one zettel. This kind of reference may be a link, or an images that is display inline when the zettel is rendered. Footnotes sometimes factor out some useful text that hinders the flow of reading text. Internal marks allow to reference something within a zettel. An important aspect of all knowledge work is to reference others work, e.g. with citation keys. All these elements can be subsumed under reference-like text.

Other inline elements

Comment

A comment begins with two consecutive percent sign characters (“%”, U+0025). It ends at the end of the line where it begins.

Backslash

The backslash character (“\”, U+005C) gives the next character another meaning.

If a space character follows, it is converted in a non-breaking space (U+00A0).
If a line ending follows the backslash character, the line break is converted from a soft break into a hard break.
Every other character is taken as itself, but without the interpretation of a Zettelmarkup element. For example, if you want to enter a “]” into a footnote text, you should escape it with a backslash.

Entities & more

Sometimes it is not easy to enter special characters. If you know the Unicode code point of that character, or its name according to the HTML standard, you can enter it by number or by name.

Regardless which method you use, an entity always begins with an ampersand character (“&”, U+0026) and ends with a semicolon character (“;”, U+003B). If you know the HTML name of the character you want to enter, put it between these two character. Example: & is rendered as &.

If you want to enter its numeric code point, a number sign character must follow the ampersand character, followed by digits to base 10. Example: & is rendered in HTML as &.

You also can enter its numeric code point as a hex number, if you put the letter “x” after the numeric sign character. Example: & is rendered in HTML as &.

According to the HTML Standard, some numeric code points are not allowed. These are all code point below the numeric value 32 (decimal) or 0x20 (hex) and all code points for noncharacter values.

Since some Unicode character are used quite often, a special notation is introduced for them:

Two consecutive hyphen-minus characters result in an en-dash character. It is typically used in numeric ranges. pages 4--7 will be rendered in HTML as: pages 4–7. Alternative specifications are: –, &x8211, and &#x2013.