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

/samples/sample.pmw

http://txt2tags.googlecode.com/
Unknown | 191 lines | 121 code | 70 blank | 0 comment | 0 complexity | 9785c8fe029bd3f38acfe44fa4ebd86c MD5 | raw file
  1(:Title TXT2TAGS SAMPLE:)
  2
  3(:Description Aurelio Jargas:)
  4
  5(:Summary 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[@
 19  line1: document title
 20  line2: author name, email
 21  line3: 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[@
 61  prompt$ ls /etc
 62@]
 63
 64Or use @@pre-formatted@@ inside sentences.
 65
 66!! More Cosmetics 
 67
 68Special entities like email (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 [[explicit link -> http://duh.org]]
 79or an [[explicit email -> mailto:duh@somewhere.com]] with label.
 80
 81And remember,
 82
 83	->
 84A TAB in front of the line does a quotation.
 85
 86		->
 87More TABs, more depth (if allowed).
 88		
 89
 90
 91	
 92
 93
 94Nice.
 95
 96! Lists 
 97
 98A list of items is natural, just putting a '''dash''' or
 99a '''plus''' at the beginning of the line.
100
101!! Plain List 
102
103The dash is the default list identifier. For sublists,
104just add '''spaces''' at the beginning of the line. More
105spaces, more sublists.
106
107* Earth
108** America
109*** South America
110**** Brazil
111***** How deep can I go?
112** Europe
113*** Lots of countries
114* Mars
115** Who knows?
116
117The list ends with '''two''' consecutive blank lines.
118
119!! Numbered List 
120
121The same rules as the plain list, just a different
122identifier (plus).
123
124# one
125# two
126# three
127** mixed lists!
128** what a mess
129### counting again
130### ...
131# four
132
133!! Definition List 
134
135The definition list identifier is a colon, followed by
136the term. The term contents is placed on the next line.
137
138: orange:
139a yellow fruit
140: apple:
141a green or red fruit
142: other fruits:
143** wee!
144** mixing lists
145### again!
146### and again!
147
148! Tables 
149
150Use pipes to compose table rows and cells.
151Double pipe at the line beginning starts a heading row.
152Natural spaces specify each cell alignment.
153
154||! '''heading 1''' ||!'''heading 2''' ||!'''heading 3'''||
155||cell 1.1 ||cell 1.2 ||cell 1.3||
156||cell 2.1 ||cell 2.2 ||cell 2.3||
157
158Without the last pipe, no border:
159
160||! '''heading 1''' ||!'''heading 2''' ||!'''heading 3'''||
161||cell 1.1 ||cell 1.2 ||cell 1.3||
162||cell 2.1 ||cell 2.2 ||cell 2.3||
163
164! Special Entities 
165
166Because things were too simple.
167
168!! Images 
169
170The image mark is as simple as it can be: @@[filename]@@.
171
172                      img/photo.jpg  
173
174* The filename must end in PNG, JPG, GIF, or similar.
175* No spaces inside the brackets!
176
177!! Other 
178
179The handy @@%%date@@ macro expands to the current date.
180
181So today is 20110602 on the ISO @@YYYYMMDD@@ format.
182
183You can also specify the date format with the %? flags,
184as @@%%date(%m-%d-%Y)@@ which gives: 06-02-2011.
185
186That's all for now.
187
188----
189
190img/t2tpowered.png ([[sample.t2t -> sample.t2t]])
191