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