PageRenderTime 6ms CodeModel.GetById 1ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

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