tests/ctags/sample.t2t

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