/samples/sample.doku

http://txt2tags.googlecode.com/ · Unknown · 177 lines · 113 code · 64 blank · 0 comment · 0 complexity · edece618b6c47441e88d3362908454d6 MD5 · raw file

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