Home

News

International

Screen Shots

Documentation

Download

Build

License

Credits

Contact

SourceForge Project

Tintware Documentation : Tint Documentation Tools : tml

TML File Format

TML is strict XML; it resembles HTML, but it is not HTML. A TML file consists of an opening <pages> tag followed by one or more pages and then a closing </pages> tag. A page starts with an opening <page name="An Example"> tag; the tag must contain a name attribute which specifies the name of the page. Within a <page> tag there must be one or more paragraph level elements. Finally, a page is ended with a closing </page> tag. Pages are arranged into a tree with a single parent and zero or more children.

Paragraph level elements can be paragraphs (<p>), first level headers (<h1>), second level headers (<h2>), third level headers (<h3>), and preformatted paragraphs (<pre>). These all work basically the same way as in HTML. Any attributes are ignored. All opening tags must have a closing tag, without exception. All paragraph level elements contain text.

Paragraphs (<p>) can contain also contain additional markup of the text. <i> indicates italics text. <b> indicates bold text. <tt> indicates typewriter text. Finally, <a> are used to create links. There are two types of links. To link to an arbitrary url, use an attribute href to specify the url: <a href="www.sourceforge.org">. To link to another page within the pdb file, use an attribute pref to specify the name of the other page: <a pref="Important Information">. Again, all opening tags must have a closing tag, without exception.

There is one additional paragraph level element, <contents>, which is used to create the tree of nodes. The <item> elements within the <contents> specify the children of a particular page. A <contents> tag then contains one or more <item> tag. Each <item pref="A Page Name"> must have a pref attribute which specifies the name of a page.

Finally, to include an < in text, use &lt; To include an > in text, use &gt; To include an & in text, use &amp;

An Example Here is an example.

An Example Source And here is the source to the example.

Building An Example Finally, here is how to generate an info file and html files from the example.