/samples/sample.spip

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