PageRenderTime 8ms CodeModel.GetById 2ms app.highlight 2ms RepoModel.GetById 2ms app.codeStats 0ms

/samples/sample.aat

http://txt2tags.googlecode.com/
Unknown | 289 lines | 193 code | 96 blank | 0 comment | 0 complexity | 245002f229b86ac6c4724204e292925a MD5 | raw file
  1
  2========================================================================
  3
  4
  5                          +-----------------+                           
  6                          | TXT2TAGS SAMPLE |                           
  7                          +-----------------+                           
  8
  9
 10                           +----------------+                           
 11                           | Aurelio Jargas |                           
 12                           +----------------+                           
 13
 14
 15                             +------------+                             
 16                             | 04/08/2012 |                             
 17                             +------------+                             
 18
 19
 20========================================================================
 21
 22This text is before the introduction.
 23
 24But it's OK.
 25
 26
 27                            +--------------+
 28                            | Introduction |
 29                            +--------------+
 30
 31Welcome to the txt2tags sample file.
 32
 33Here you have examples and a brief explanation of all
 34marks.
 35
 36The first 3 lines of the this file are used as headers,
 37on the following format:
 38
 39  line1: document title
 40  line2: author name, email
 41  line3: date, version
 42
 43Lines with balanced equal signs = around are titles.
 44
 45
 46                       +-----------------------+
 47                       | Fonts and Beautifiers |
 48                       +-----------------------+
 49
 50We have two sets of fonts:
 51
 52The NORMAL type that can be improved with beautifiers.
 53
 54The TYPEWRITER type that uses monospaced font for
 55pre-formatted text.
 56
 57We will now enter on a subtitle...
 58
 59
 60Beautifiers
 61===========
 62
 63The text marks for beautifiers are simple, just as you
 64type on a plain text email message.
 65
 66We use double *, /, - and _ to represent *bold*,
 67/italic/, -strike- and _underline_.
 68
 69The */bold italic/* style is also supported as a
 70combination.
 71
 72
 73Pre-Formatted Text
 74==================
 75
 76We can put a code sample or other pre-formatted text:
 77
 78    here    is     pre-formatted
 79  //marks// are  **not**  ``interpreted``
 80
 81And also, it's easy to put a one line pre-formatted
 82text:
 83
 84  prompt$ ls /etc
 85
 86Or use pre-formatted inside sentences.
 87
 88
 89More Cosmetics
 90==============
 91
 92Special entities like email (duh@somewhere.com) and
 93URL (http://www.duh.com) are detected automagically,
 94as long as the horizontal line:
 95
 96------------------------------------------------------------------------
 97
 98^ thin or large v
 99
100========================================================================
101
102You can also specify an explicit link[1]
103or an explicit email[2] with label.
104
105And remember,
106
107        A TAB in front of the line does a quotation.
108
109                More TABs, more depth (if allowed).
110
111
112Nice.
113
114
115                               +-------+
116                               | Lists |
117                               +-------+
118
119A list of items is natural, just putting a *dash* or
120a *plus* at the beginning of the line.
121
122
123Plain List
124==========
125
126The dash is the default list identifier. For sublists,
127just add *spaces* at the beginning of the line. More
128spaces, more sublists.
129
130- Earth
131  - America
132    - South America
133      - Brazil
134        - How deep can I go?
135  - Europe
136    - Lots of countries
137- Mars
138  - Who knows?
139
140The list ends with *two* consecutive blank lines.
141
142
143Numbered List
144=============
145
146The same rules as the plain list, just a different
147identifier (plus).
148
1491. one
1502. two
1513. three
152  - mixed lists!
153  - what a mess
154    1. counting again
155    2. ...
1564. four
157
158
159Definition List
160===============
161
162The definition list identifier is a colon, followed by
163the term. The term contents is placed on the next line.
164
165orange
166  a yellow fruit
167apple
168  a green or red fruit
169other fruits
170  - wee!
171  - mixing lists
172    1. again!
173    2. and again!
174
175
176                               +--------+
177                               | Tables |
178                               +--------+
179
180Use pipes to compose table rows and cells.
181Double pipe at the line beginning starts a heading row.
182Natural spaces specify each cell alignment.
183
184                +-----------+-------------+------------+                
185                | cell 1.1  |  cell 1.2   |   cell 1.3 |                
186                +-----------+-------------+------------+                
187                | cell 2.1  |  cell 2.2   |   cell 2.3 |                
188                +-----------+-------------+------------+                
189                | cell 3.1  |  cell 3.2   |   cell 3.3 |                
190                +-----------+-------------+------------+                
191
192  +-----------+-------------+------------+
193  | heading 1 |  heading 2  |  heading 3 |
194  +===========+=============+============+
195  | cell 1.1  |  cell 1.2   |   cell 1.3 |
196  +-----------+-------------+------------+
197  | cell 2.1  |  cell 2.2   |   cell 2.3 |
198  +-----------+-------------+------------+
199
200                +-----------+-------------+------------+                
201                | heading 1 $  cell 1.1   |   cell 1.2 |                
202                +-----------+-------------+------------+                
203                | heading 2 $  cell 2.1   |   cell 2.2 |                
204                +-----------+-------------+------------+                
205                | heading 3 $  cell 3.1   |   cell 3.2 |                
206                +-----------+-------------+------------+                
207
208  +-----------+-------------+------------+
209  | heading   $  heading 1  |  heading 2 |
210  +===========+=============+============+
211  | heading 1 $  cell 1.1   |   cell 1.2 |
212  +-----------+-------------+------------+
213  | heading 2 $  cell 2.1   |   cell 2.2 |
214  +-----------+-------------+------------+
215
216Without the last pipe, no border:
217
218                +-----------+-------------+------------+                
219                | cell 1.1  |  cell 1.2   |   cell 1.3 |                
220                | cell 2.1  |  cell 2.2   |   cell 2.3 |                
221                | cell 3.1  |  cell 3.2   |   cell 3.3 |                
222                +-----------+-------------+------------+                
223
224  +-----------+-------------+------------+
225  | heading 1 |  heading 2  |  heading 3 |
226  +-----------+-------------+------------+
227  | cell 1.1  |  cell 1.2   |   cell 1.3 |
228  | cell 2.1  |  cell 2.2   |   cell 2.3 |
229  +-----------+-------------+------------+
230
231                +-----------+-------------+------------+                
232                | heading 1 $  cell 1.1   |   cell 1.2 |                
233                | heading 2 $  cell 2.1   |   cell 2.2 |                
234                | heading 3 $  cell 3.1   |   cell 3.2 |                
235                +-----------+-------------+------------+                
236
237  +-----------+-------------+------------+
238  | heading   $  heading 1  |  heading 2 |
239  +-----------+-------------+------------+
240  | heading 1 $  cell 1.1   |   cell 1.2 |
241  | heading 2 $  cell 2.1   |   cell 2.2 |
242  +-----------+-------------+------------+
243
244
245                          +------------------+
246                          | Special Entities |
247                          +------------------+
248
249Because things were too simple.
250
251
252Images
253======
254
255The image mark is as simple as it can be: [filename].
256
257                      [img/photo.jpg]
258
259And with some targets the image is linkable :
260
261                      (img/photo.jpg)[3]
262
263- The filename must end in PNG, JPG, GIF, or similar.
264- No spaces inside the brackets!
265
266
267Other
268=====
269
270When the target needs, special chars like <, > and &
271are escaped.
272
273The handy %%date macro expands to the current date.
274
275So today is 20120408 on the ISO YYYYMMDD format.
276
277You can also specify the date format with the %? flags,
278as %%date(%m-%d-%Y) which gives: 04-08-2012.
279
280That's all for now.
281
282------------------------------------------------------------------------
283
284[img/t2tpowered.png] (sample.t2t[4])
285
286[1] http://duh.org
287[2] duh@somewhere.com
288[3] http://www.txt2tags.org
289[4] sample.t2t