The Unidoc manual.

Unidoc is a text-oriented markup language in the type of Asciidoc or Markdown. It was designed to be simple and parseable with an Aurochs grammar, while providing a header with structured metadata. Content on this site is written in Unidoc.

INCOMPLETE, TO BE COMPLETED

Structure

A Unidoc document is made of the following parts, all of which are mandatory:

Title

The title takes exactly one line (which can be arbitrarily long). It contains no special markup. It must be followed by a single blank line .

Header block

The header block is made of key-value pairs. Values are one-liners. No markup is allowed. The following keys are mandatory:

Id

An identifier string giving a unique, permanent ID for this document.

Tags

A comma-separated list of keywords.

Created

Creation date of the document, in YYYY-MM-DD format.

Author

Author. Multiple entries allowed.

The header block must be followed by a single blank line .

Abstract

The abstract gives a short summary of the document. This summary will be displayed as a preview of the document. Although markup is allowed in the abstract, it is better to keep it to a minimum.

The abstract must start with a single line containing "Abstract". This line must be followed by a blank line. Then follows the abstract, which can be one or more blank-line-separated blocks of text.

The abstract must end by a single line containing " *** ", followed by a blank line.

Body

The body follows the abstract until the end of file. It is made of one or more blocks of text.

Blocks

Blocks are generally separated by a blank line.

Header blocks

These are obtained by "underlining" a line of text with equal signs for level 1 headers, dashes for level 2 headers, or tildes for level 3 headers. There must be at least four such symbols.

Quotation blocks

Usually intended to be rendered as BLOCKQUOTE tags, these are defined by enclosing a block between `` and '' characters.

TO BE COMPLETED

References

2009-02-03