/samples/sample.gwiki

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