/samples/sample.doku

  1===== TXT2TAGS SAMPLE =====
  2
  3**//Aurelio Jargas//**
  4
  5//02/28/2011//
  6
  7
  8===== Introduction =====
  9
 10Welcome to the txt2tags sample file.
 11
 12Here you have examples and a brief explanation of all
 13marks.
 14
 15The first 3 lines of the this file are used as headers,
 16on the following format:
 17
 18  line1: document title
 19  line2: author name, email
 20  line3: date, version
 21
 22Lines with balanced equal signs = around are titles.
 23
 24===== Fonts and Beautifiers =====
 25
 26We have two sets of fonts:
 27
 28The NORMAL type that can be improved with beautifiers.
 29
 30The TYPEWRITER type that uses monospaced font for
 31pre-formatted text.
 32
 33We will now enter on a subtitle...
 34
 35==== Beautifiers ====
 36
 37The text marks for beautifiers are simple, just as you
 38type on a plain text email message.
 39
 40We use double *, /, - and _ to represent **bold**,
 41//italic//, <del>strike</del> and __underline__.
 42
 43The **//bold italic//** style is also supported as a
 44combination.
 45
 46==== Pre-Formatted Text ====
 47
 48We can put a code sample or other pre-formatted text:
 49
 50    here    is     pre-formatted
 51  //marks// are  **not**  ``interpreted``
 52
 53And also, it's easy to put a one line pre-formatted
 54text:
 55
 56  prompt$ ls /etc
 57
 58Or use ''pre-formatted'' inside sentences.
 59
 60==== More Cosmetics ====
 61
 62Special entities like email ([[duh@somewhere.com]]) and
 63URL ([[http://www.duh.com]]) are detected automagically,
 64as long as the horizontal line:
 65
 66----
 67
 68^ thin or large v
 69
 70----
 71
 72You can also specify an [[http://duh.org|explicit link]]
 73or an [[duh@somewhere.com|explicit email]] with label.
 74
 75And remember,
 76
 77>A TAB in front of the line does a quotation.
 78>>More TABs, more depth (if allowed).
 79
 80Nice.
 81
 82===== Lists =====
 83
 84A list of items is natural, just putting a **dash** or
 85a **plus** at the beginning of the line.
 86
 87==== Plain List ====
 88
 89The dash is the default list identifier. For sublists,
 90just add **spaces** at the beginning of the line. More
 91spaces, more sublists.
 92
 93  * Earth
 94    * America
 95      * South America
 96        * Brazil
 97          * How deep can I go?
 98    * Europe
 99      * Lots of countries
100  * Mars
101    * Who knows?
102
103The list ends with **two** consecutive blank lines.
104
105==== Numbered List ====
106
107The same rules as the plain list, just a different
108identifier (plus).
109
110  - one
111  - two
112  - three
113    * mixed lists!
114    * what a mess
115      - counting again
116      - ...
117  - four
118
119==== Definition List ====
120
121The definition list identifier is a colon, followed by
122the term. The term contents is placed on the next line.
123
124orange
125  a yellow fruit
126apple
127  a green or red fruit
128other fruits
129    * wee!
130    * mixing lists
131      - again!
132      - and again!
133
134===== Tables =====
135
136Use pipes to compose table rows and cells.
137Double pipe at the line beginning starts a heading row.
138Natural spaces specify each cell alignment.
139
140^ heading 1 ^ heading 2 ^ heading 3 ^
141| cell 1.1 | cell 1.2 | cell 1.3 |
142| cell 2.1 | cell 2.2 | cell 2.3 |
143
144Without the last pipe, no border:
145
146^ heading 1 ^ heading 2 ^ heading 3 ^
147| cell 1.1 | cell 1.2 | cell 1.3 |
148| cell 2.1 | cell 2.2 | cell 2.3 |
149
150===== Special Entities =====
151
152Because things were too simple.
153
154==== Images ====
155
156The image mark is as simple as it can be: ''[filename]''.
157
158                      {{ img/photo.jpg }}  
159
160  * The filename must end in PNG, JPG, GIF, or similar.
161  * No spaces inside the brackets!
162
163==== Other ====
164
165The handy ''%%date'' macro expands to the current date.
166
167So today is 20110602 on the ISO ''YYYYMMDD'' format.
168
169You can also specify the date format with the %? flags,
170as ''%%date(%m-%d-%Y)'' which gives: 06-02-2011.
171
172That's all for now.
173
174----
175
176{{img/t2tpowered.png }} ([[sample.t2t|sample.t2t]])
177