Contents Previous Next

The .t2t document Areas

Txt2tags marked files are divided in 3 areas. Each area have its own rules and purpose. They are:

Header Area
Place for Document Title, Author, Version and Date information. (optional)
Config Area
Place for general Document Settings and Parser behavior modifiers. (optional)
Body Area
Place for the Document Content. (required)

As seen above, the first two Areas are optional, being Body Area the only required one.

The areas are delimited by special rules, which will be seen in detail on the next chapter. For now, this is a graphical representation of the areas on a document:

             ____________
            |            |
            |   HEADERS  |       1. First, the Headers
            |            |
            |   CONFIG   |       2. Then the Settings
            |            |
            |    BODY    |       3. And finally the Document Body,
            |            |
            |    ...     |          which goes until the end
            |    ...     |
            |____________|

In short, this is how the areas are defined:

HeadersFirst 3 lines of the file, or the first line blank for No Headers.
ConfigBegins right after the Header (4th or 2nd line) and ends when the Body Area starts.
BodyThe first valid text line (not comment or setting) after the Header Area.

Full Example

My nice doc Title
Mr. John Doe
Last Updated: %%mtime(%c)

%! Target  : html
%! Style   : fancy.css
%! Encoding: iso-8859-1
%! Options : --toc --enum-title

Hi! This is my test document.
Its content will end here.
Contents Previous Next