/samples/sample.aap
Unknown | 480 lines | 300 code | 180 blank | 0 comment | 0 complexity | 88348f090f21d624fc108df051a3a231 MD5 | raw file
1================================================================================ 2 3 4 5 +-----------------+ 6 | TXT2TAGS SAMPLE | 7 +-----------------+ 8 9 10 11 +----------------+ 12 | Aurelio Jargas | 13 +----------------+ 14 15 16 17 +------------+ 18 | 04/08/2012 | 19 +------------+ 20 21 22 23 24================================================================================ 25================================================================================ 26 TXT2TAGS SAMPLE 1/19 27 TXT2TAGS SAMPLE 28 Aurelio Jargas 04/08/2012 29================================================================================ 30 31 32 This text is before the introduction. 33 34 But it's OK. 35 36 37 38 39 40 41 42 43 44 45 46 47 48================================================================================ 49================================================================================ 50 TXT2TAGS SAMPLE 2/19 51 Introduction 52 Aurelio Jargas 04/08/2012 53================================================================================ 54 55 Welcome to the txt2tags sample file. 56 57 Here you have examples and a brief explanation of all 58 marks. 59 60 The first 3 lines of the this file are used as headers, 61 on the following format: 62 63 line1: document title 64 line2: author name, email 65 line3: date, version 66 67 Lines with balanced equal signs = around are titles. 68 69 70 71 72================================================================================ 73================================================================================ 74 TXT2TAGS SAMPLE 3/19 75 Fonts and Beautifiers 76 Aurelio Jargas 04/08/2012 77================================================================================ 78 79 We have two sets of fonts: 80 81 The NORMAL type that can be improved with beautifiers. 82 83 The TYPEWRITER type that uses monospaced font for 84 pre-formatted text. 85 86 We will now enter on a subtitle... 87 88 89 Beautifiers 90 =========== 91 92 The text marks for beautifiers are simple, just as you 93 type on a plain text email message. 94 95 96-------------------------------------------------------------------------------- 97================================================================================ 98 TXT2TAGS SAMPLE 4/19 99 Fonts and Beautifiers 100 Aurelio Jargas 04/08/2012 101================================================================================ 102 103 We use double *, /, - and _ to represent *bold*, 104 /italic/, -strike- and _underline_. 105 106 The */bold italic/* style is also supported as a 107 combination. 108 109 110 Pre-Formatted Text 111 ================== 112 113 We can put a code sample or other pre-formatted text: 114 115 here is pre-formatted 116 //marks// are **not** ``interpreted`` 117 118 119 120-------------------------------------------------------------------------------- 121================================================================================ 122 TXT2TAGS SAMPLE 5/19 123 Fonts and Beautifiers 124 Aurelio Jargas 04/08/2012 125================================================================================ 126 127 And also, it's easy to put a one line pre-formatted 128 text: 129 130 prompt$ ls /etc 131 132 Or use pre-formatted inside sentences. 133 134 135 More Cosmetics 136 ============== 137 138 Special entities like email (duh@somewhere.com) and 139 URL (http://www.duh.com) are detected automagically, 140 as long as the horizontal line: 141 142 ------------------------------------------------------------------------------ 143 144-------------------------------------------------------------------------------- 145================================================================================ 146 TXT2TAGS SAMPLE 6/19 147 Fonts and Beautifiers 148 Aurelio Jargas 04/08/2012 149================================================================================ 150 151 ^ thin or large v 152 153 ============================================================================== 154 155 You can also specify an explicit link (http://duh.org) 156 or an explicit email (duh@somewhere.com) with label. 157 158 And remember, 159 160 161 162 163 164 165 166 167 168-------------------------------------------------------------------------------- 169================================================================================ 170 TXT2TAGS SAMPLE 7/19 171 Fonts and Beautifiers 172 Aurelio Jargas 04/08/2012 173================================================================================ 174 175 +----------------------------------------------+ 176 | A TAB in front of the line does a quotation. | 177 +----------------------------------------------+ 178 179 +-------------------------------------+ 180 | More TABs, more depth (if allowed). | 181 +-------------------------------------+ 182 183 184 Nice. 185 186 187 188 189 190 191 192================================================================================ 193================================================================================ 194 TXT2TAGS SAMPLE 8/19 195 Lists 196 Aurelio Jargas 04/08/2012 197================================================================================ 198 199 A list of items is natural, just putting a *dash* or 200 a *plus* at the beginning of the line. 201 202 203 Plain List 204 ========== 205 206 The dash is the default list identifier. For sublists, 207 just add *spaces* at the beginning of the line. More 208 spaces, more sublists. 209 210 211 212 213 214 215 216-------------------------------------------------------------------------------- 217================================================================================ 218 TXT2TAGS SAMPLE 9/19 219 Lists 220 Aurelio Jargas 04/08/2012 221================================================================================ 222 223 +------------------------------+ 224 | * Earth | 225 | * America | 226 | * South America | 227 | * Brazil | 228 | * How deep can I go? | 229 | * Europe | 230 | * Lots of countries | 231 | * Mars | 232 | * Who knows? | 233 +------------------------------+ 234 235 The list ends with *two* consecutive blank lines. 236 237 238 Numbered List 239 ============= 240-------------------------------------------------------------------------------- 241================================================================================ 242 TXT2TAGS SAMPLE 10/19 243 Lists 244 Aurelio Jargas 04/08/2012 245================================================================================ 246 247 248 The same rules as the plain list, just a different 249 identifier (plus). 250 251 +-----------------------+ 252 | 1. one | 253 | 2. two | 254 | 3. three | 255 | * mixed lists! | 256 | * what a mess | 257 | 1. counting again | 258 | 2. ... | 259 | 4. four | 260 +-----------------------+ 261 262 Definition List 263 =============== 264-------------------------------------------------------------------------------- 265================================================================================ 266 TXT2TAGS SAMPLE 11/19 267 Lists 268 Aurelio Jargas 04/08/2012 269================================================================================ 270 271 272 The definition list identifier is a colon, followed by 273 the term. The term contents is placed on the next line. 274 275 +------------------------+ 276 | orange | 277 | a yellow fruit | 278 | apple | 279 | a green or red fruit | 280 | other fruits | 281 | * wee! | 282 | * mixing lists | 283 | 1. again! | 284 | 2. and again! | 285 +------------------------+ 286 287 288================================================================================ 289================================================================================ 290 TXT2TAGS SAMPLE 12/19 291 Tables 292 Aurelio Jargas 04/08/2012 293================================================================================ 294 295 296 Use pipes to compose table rows and cells. 297 Double pipe at the line beginning starts a heading row. 298 Natural spaces specify each cell alignment. 299 300 +-----------+-------------+------------+ 301 | cell 1.1 | cell 1.2 | cell 1.3 | 302 +-----------+-------------+------------+ 303 | cell 2.1 | cell 2.2 | cell 2.3 | 304 +-----------+-------------+------------+ 305 | cell 3.1 | cell 3.2 | cell 3.3 | 306 +-----------+-------------+------------+ 307 308 309 310 311 312-------------------------------------------------------------------------------- 313================================================================================ 314 TXT2TAGS SAMPLE 13/19 315 Tables 316 Aurelio Jargas 04/08/2012 317================================================================================ 318 319 +-----------+-------------+------------+ 320 | heading 1 | heading 2 | heading 3 | 321 +===========+=============+============+ 322 | cell 1.1 | cell 1.2 | cell 1.3 | 323 +-----------+-------------+------------+ 324 | cell 2.1 | cell 2.2 | cell 2.3 | 325 +-----------+-------------+------------+ 326 327 +-----------+-------------+------------+ 328 | heading 1 $ cell 1.1 | cell 1.2 | 329 +-----------+-------------+------------+ 330 | heading 2 $ cell 2.1 | cell 2.2 | 331 +-----------+-------------+------------+ 332 | heading 3 $ cell 3.1 | cell 3.2 | 333 +-----------+-------------+------------+ 334 335 336-------------------------------------------------------------------------------- 337================================================================================ 338 TXT2TAGS SAMPLE 14/19 339 Tables 340 Aurelio Jargas 04/08/2012 341================================================================================ 342 343 +-----------+-------------+------------+ 344 | heading $ heading 1 | heading 2 | 345 +===========+=============+============+ 346 | heading 1 $ cell 1.1 | cell 1.2 | 347 +-----------+-------------+------------+ 348 | heading 2 $ cell 2.1 | cell 2.2 | 349 +-----------+-------------+------------+ 350 351 Without the last pipe, no border: 352 353 +-----------+-------------+------------+ 354 | cell 1.1 | cell 1.2 | cell 1.3 | 355 | cell 2.1 | cell 2.2 | cell 2.3 | 356 | cell 3.1 | cell 3.2 | cell 3.3 | 357 +-----------+-------------+------------+ 358 359 360-------------------------------------------------------------------------------- 361================================================================================ 362 TXT2TAGS SAMPLE 15/19 363 Tables 364 Aurelio Jargas 04/08/2012 365================================================================================ 366 367 +-----------+-------------+------------+ 368 | heading 1 | heading 2 | heading 3 | 369 +-----------+-------------+------------+ 370 | cell 1.1 | cell 1.2 | cell 1.3 | 371 | cell 2.1 | cell 2.2 | cell 2.3 | 372 +-----------+-------------+------------+ 373 374 +-----------+-------------+------------+ 375 | heading 1 $ cell 1.1 | cell 1.2 | 376 | heading 2 $ cell 2.1 | cell 2.2 | 377 | heading 3 $ cell 3.1 | cell 3.2 | 378 +-----------+-------------+------------+ 379 380 381 382 383 384-------------------------------------------------------------------------------- 385================================================================================ 386 TXT2TAGS SAMPLE 16/19 387 Tables 388 Aurelio Jargas 04/08/2012 389================================================================================ 390 391 +-----------+-------------+------------+ 392 | heading $ heading 1 | heading 2 | 393 +-----------+-------------+------------+ 394 | heading 1 $ cell 1.1 | cell 1.2 | 395 | heading 2 $ cell 2.1 | cell 2.2 | 396 +-----------+-------------+------------+ 397 398 399 400 401 402 403 404 405 406 407 408================================================================================ 409================================================================================ 410 TXT2TAGS SAMPLE 17/19 411 Special Entities 412 Aurelio Jargas 04/08/2012 413================================================================================ 414 415 Because things were too simple. 416 417 418 Images 419 ====== 420 421 The image mark is as simple as it can be: [filename]. 422 423 [img/photo.jpg] 424 425 And with some targets the image is linkable : 426 427 (img/photo.jpg) (http://www.txt2tags.org) 428 429 430 431 432-------------------------------------------------------------------------------- 433================================================================================ 434 TXT2TAGS SAMPLE 18/19 435 Special Entities 436 Aurelio Jargas 04/08/2012 437================================================================================ 438 439 +-------------------------------------------------------+ 440 | * The filename must end in PNG, JPG, GIF, or similar. | 441 | * No spaces inside the brackets! | 442 +-------------------------------------------------------+ 443 444 Other 445 ===== 446 447 When the target needs, special chars like <, > and & 448 are escaped. 449 450 The handy %%date macro expands to the current date. 451 452 So today is 20120408 on the ISO YYYYMMDD format. 453 454 455 456-------------------------------------------------------------------------------- 457================================================================================ 458 TXT2TAGS SAMPLE 19/19 459 Special Entities 460 Aurelio Jargas 04/08/2012 461================================================================================ 462 463 You can also specify the date format with the %? flags, 464 as %%date(%m-%d-%Y) which gives: 04-08-2012. 465 466 That's all for now. 467 468 ------------------------------------------------------------------------------ 469 470 [img/t2tpowered.png] (sample.t2t (sample.t2t)) 471 472 473 474 475 476 477 478 479 480================================================================================