HowTo_make_a_new_database_transforms >> _bug0010_transforms >> Sound_tests_transforms >> Virtual_Exercise_Tour_transforms 

TB Wiki

Login

navigation
search
toolbox
  article   edit this page   history  

Regression Test

Expected HTML for page "DocBasicSyntax"


expected html
nothing
t1Here is information about basic syntax for TBWiki:t
2 
3<table align="right"><tr><td><div class="toc">
4Contents:
5<ul>
6  <li><a href="#General_markup">General&nbsp;markup</a></li>
7  <li><a href="#Headings">Headings</a></li>
8  <ul>
9    <li><a href="#2nd_level_heading">2nd&nbsp;level&nbsp;heading</a></li>
10    <ul>
11      <li><a href="#3rd_level_heading">3rd&nbsp;level&nbsp;heading</a></li>
12      <ul>
13        <li><a href="#4th_level_heading">4th&nbsp;level&nbsp;heading</a></li>
14      </ul>
15    </ul>
16  </ul>
17  <li><a href="#Bullet_Lists">Bullet&nbsp;Lists</a></li>
18  <li><a href="#Definition_lists">Definition&nbsp;lists</a></li>
19  <li><a href="#Images">Images</a></li>
20  <ul>
21    <li><a href="#image_options">image&nbsp;options</a></li>
22  </ul>
23  <li><a href="#Links">Links</a></li>
24  <li><a href="#Special_marks">Special&nbsp;marks</a></li>
25  <li><a href="#Preformatted_text">Preformatted&nbsp;text</a></li>
26  <li><a href="#Blocks">Blocks</a></li>
27  <li><a href="#Macros_and_processors">Macros&nbsp;and&nbsp;processors</a></li>
28  <ul>
29    <li><a href="#Macros">Macros</a></li>
30    <ul>
31      <li><a href="#Common_Macros">Common&nbsp;Macros</a></li>
32      <li><a href="#System_Macros">System&nbsp;Macros</a></li>
33    </ul>
34    <li><a href="#Processors">Processors</a></li>
35    <ul>
36      <li><a href="#Useful_processors">Useful&nbsp;processors</a></li>
37      <li><a href="#Demonstration_processors">Demonstration&nbsp;processors</a></li>
38      <li><a href="#In-progress_processors">In-progress&nbsp;processors</a></li>
39      <li><a href="#Testing_processors">Testing&nbsp;processors</a></li>
40    </ul>
41  </ul>
42</ul>
43</div></td></tr></table>
44<p>
45<h1><a name="General_markup">General markup</a>
46<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=General_markup">edit section</a>]</font></span>
47</h1>
48<ul><li>a blank line = a paragraph break
49<li>4 or more dashes alone on line = a horizontal rule
50<ul><li>number of dashes = thickness of line
51</ul>
52</ul>
53<p>
54(below this is a thin line, formed with ----)
55<hr size=2>
56(below this is a thick line, formed with ----------)
57<hr size=8>
58<p>
59<ul><li><i>italic</i> = surround text by two single-quotes
60</ul>
61<p>
62''italic'' = <i>italic</i>
63<p>
64<ul><li><b>bold</b> = surround text by three single-quotes
65</ul>
66<p>
67'''bold''' = <b>bold</b>
68<p>
69<ul><li><code>code (monospaced font)</code> = surround text by two backticks
70</ul>
71<p>
72``code`` = <code>code</code>
73<p>
74<h1><a name="Headings">Headings</a>
75<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Headings">edit section</a>]</font></span>
76</h1>
77<ul><li>leading and trailing '=' at start of line =&gt; headings
78<ul><li>number of '=' = heading level
79</ul>
80</ul>
81<p>
82<h2><a name="2nd_level_heading">2nd level heading</a>
83<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=2nd_level_heading">edit section</a>]</font></span>
84</h2>
85was made with == 2nd level heading ==<p>
86<h3><a name="3rd_level_heading">3rd level heading</a>
87<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=3rd_level_heading">edit section</a>]</font></span>
88</h3>
89was made with === 3rd level heading ===<p>
90<h4><a name="4th_level_heading">4th level heading</a>
91<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=4th_level_heading">edit section</a>]</font></span>
92</h4>
93was made with ==== 4th level heading ====<p>
94<h1><a name="Bullet_Lists">Bullet Lists</a>
95<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Bullet_Lists">edit section</a>]</font></span>
96</h1>
97You uses '*' or '-' with indentation, to create bullet lists:
98<p>
99<ul><div style="background-color:lightgrey; padding:5px; border-style: solid solid solid solid; border-width: 1px 1px 1px 1px;">
100<pre> * space and '*' = bullet
101   * indentation = bullet level
102 * indentation back to previous level does the right thing
103 
104 - you can use multiple lines for the content on
105   the same bullet level, by indenting them the same level
106   as the starting text
107   - this is indented for a second-level bullet
108     item, with multi-line text</pre></div></ul>
109 
110<p>
111Produces this:
112<p>
113<ul><li>space and '*' = bullet
114<ul><li>indentation = bullet level
115</ul><li>indentation back to previous level does the right thing
116</ul>
117<p>
118<ul><li>you can use multiple lines for the words on
119   the same bullet level, by indenting them the same level
120   as the starting text
121<ul><li>this is indented for a second-level bullet
122     item, with multi-line text
123</ul>
124</ul>
125<p>
126<h1><a name="Definition_lists">Definition lists</a>
127<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Definition_lists">edit section</a>]</font></span>
128</h1>
129You can create definition lists with the following syntax:
130<pre>; word: definition
131</pre>
132<p>
133example:
134<dl><dt> Red Baron</dt>
135<dd> a very good pilot in world war I</dd>
136<dt> Snoopy</dt>
137<dd> a dog from the <i>Peanuts</i> cartoon</dd>
138</dl>
139<p>
140Definition lists should end with a blank line.
141<p>
142<h1><a name="Images">Images</a>
143<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Images">edit section</a>]</font></span>
144</h1>
145You can add inline images on a page with the syntax:
146<ul><li>[<b></b>[image:image-name.jpg]]
147or
148<li>[<b></b>[image:ht<b></b>tp://server/remote-image.jpg]
149</ul>
150<p>
151The image name can refer to a local file or a remote file.  If the image name
152starts with 'http', it is treated as a full URL to a remote site.
153A local file refers to a filename in this wiki's files area area
154(where uploaded files reside).
155<p>
156<h2><a name="image_options">image options</a>
157<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=image_options">edit section</a>]</font></span>
158</h2>
159You can optionally add options to control image display and handling,
160by placing a vertical bar after the image filename, followed by image options.  The following options are supported:
161<ul><li>width="xxx"
162<li>height="yyy"
163<li>alt="alternate text"
164</ul>
165<p>
166If multiple attributes are used, they should be separated by a spaces.
167<p>
168Note that this is the same syntax as used for HTML &lt;img&gt; tags.
169<p>
170Example:
171<ul><li>[<b></b>[image:image-name.jpg|height="200" alt="This is neat"]]
172</ul>
173<p>
174<h1><a name="Links">Links</a>
175<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Links">edit section</a>]</font></span>
176</h1>
177Links are either interpreted from plain text, when the part before the colon
178is a recognized URL prefix (ht<b></b>tp: or ht<b></b>ttps:), or are specified with surrounding double square brackets.
179<p>
180<ul><li><a href="https:/server/page">https:/server/page</a> - automatically converted to link
181<li>double-square bracket - link to local page e.g. [<b></b>[FrontPage]] =&gt; <a href="/tbwiki/FrontPage">FrontPage</a>
182<li>double-square bracket with remote url - [ [ht<b></b>tp://google.com/]] =&gt; <a href="http://google.com/">http://google.com/</a>
183<li>vertical bar inside brackets = separates link from cover text
184<ul><li>[<b></b>[FrontPage|go to the Front Page]] =&gt; <a href="/tbwiki/FrontPage">go to the Front Page</a>
185<li>[ [ht<b></b>tp://google.com|Google search engine]] =&gt; <a href="http://google.com">Google search engine</a>
186</ul><li>link to local files: [<b></b>[file:filename.doc]] =&gt; <a style="color:red;" href="/tbwiki/DocBasicSyntax?action=upload_one&dest_fn=filename.doc">file:filename.doc</a>
187<li>link from image: [<b></b>[image:image-name.jpg|FrontPage]]
188<li>link from remote image to local page: [<b></b>[image:ht<b></b>tp://server/image-name.jpg|FrontPage]]
189<li>link from local image to remote page: [<b></b>[image:image-name.jpg|ht<b></b>tp://server/other-page.html]]
190</ul>
191<p>
192<h1><a name="Special_marks">Special marks</a>
193<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Special_marks">edit section</a>]</font></span>
194</h1>
195The following special mark is supported:
196<ul><li>caret-slash
197</ul>
198<p>
199<pre>
200 ^/ shows a green checkmark
201</pre>
202<p>
203Here is an example:
204<p>
205<p>
206<img src="/tbw-files/green-checkmark.jpg" alt="checkmark"> green checkmark supported!
207<p>
208<h1><a name="Preformatted_text">Preformatted text</a>
209<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Preformatted_text">edit section</a>]</font></span>
210</h1>
211Use triple braces to indicate text that should be output in
212pre-formatted format.  That is, the word wrappings and leading
213spaces will be preserved.
214<p>
215<pre>
216{{{
217  this
218    is
219      preformatted
220    text
221} }}
222</pre>
223<p>
224Will display as this:
225<pre>
226  this
227    is
228      preformatted
229   text
230</pre>
231<p>
232Note that markup will not be processed inside a block of preformatted text:
233<p>
234<pre>
235{{{
236  Here's a [[link]]
237} }}
238</pre>
239<p>
240Yields:
241<p>
242<pre>
243  Here's a [[link]]
244</pre>
245<p>
246<h1><a name="Blocks">Blocks</a>
247<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Blocks">edit section</a>]</font></span>
248</h1>
249<ul><li>preformatted text - use triple braces, and no name
250<li>named block - use triple braces and a name on the top line
251<li>hidden block - use triple braces and a leading '#' in the name
252<li>processor block - put the processor name after #! on the top line
253<li>named table block - put the table name after the #!Table processor directive
254</ul>
255<p>
256named block
257<pre>
258{{{MyData
259&lt;put data here&gt;
260}} }
261</pre>
262<p>
263hidden block
264<pre>
265{{{#HyHiddenData
266&lt;this data won't display on the page
267}} }
268</pre>
269<p>
270processor
271<pre>
272{{{#!PigLatin
273This will display as pig latin!
274}} }
275</pre>
276<p>
277named table block
278<pre>
279{{{#!Table:BlockName
280&lt;table spec and data&gt;
281}} }
282</pre>
283<p>
284<h1><a name="Macros_and_processors">Macros and processors</a>
285<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Macros_and_processors">edit section</a>]</font></span>
286</h1>
287Macros are invoked with double braces.  Processors use triple braces, and #! preceding the processor name.
288<p>
289<h2><a name="Macros">Macros</a>
290<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Macros">edit section</a>]</font></span>
291</h2>
292<p>
293<h3><a name="Common_Macros">Common Macros</a>
294<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Common_Macros">edit section</a>]</font></span>
295</h3>
296<ul><li>{<b></b>{BR}} - forced line break
297<li>{<b></b>{TableOfContents}} - insert a table of contents
298<li>{<b></b>{HTML(text)}} - insert raw text unprocessed in HTML output
299<li>{<b></b>{Include(page)}} - include another page in this one
300</ul>
301<p>
302<h3><a name="System_Macros">System Macros</a>
303<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=System_Macros">edit section</a>]</font></span>
304</h3>
305<ul><li>{<b></b>{RecentChanges}} - show the list of recent edits
306<li>{<b></b>{SystemInfo}} - show information about the tbwiki system
307<li>{<b></b>{TitleIndex}} - show the list of pages on this site
308</ul>
309<p>
310<h2><a name="Processors">Processors</a>
311<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Processors">edit section</a>]</font></span>
312</h2>
313Processors can invoke plugins to produce output calculated at runtime (that is, at the time of page access).
314<p>
315<h3><a name="Useful_processors">Useful processors</a>
316<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Useful_processors">edit section</a>]</font></span>
317</h3>
318Some useful processors:
319<ul><li>#!Table - table processor
320<li>#!WebSed - page scraping processor
321<li>#!SlideShow - show a page as a slide show
322<li>#!bc - calculator processor (see 'man bc')
323<li>#!RegEx - do interactive RegEx testing
324<li>#!RunningChart - show running chart from table data
325<li>#!YellowBlock - show text inside a yellow block
326</ul>
327<p>
328<h3><a name="Demonstration_processors">Demonstration processors</a>
329<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Demonstration_processors">edit section</a>]</font></span>
330</h3>
331<ul><li>#!FooReplace - replace 'foo' with 'bar' in content
332<li>#!PigLatin - change text to pig latin
333<li>#!UserChoice - show how to use sub-actions
334</ul>
335<p>
336<h3><a name="In-progress_processors">In-progress processors</a>
337<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=In-progress_processors">edit section</a>]</font></span>
338</h3>
339<ul><li>#!Transcriber - used to transcribe videos
340<li>#!User - used for user account administration
341</ul>
342<p>
343<h3><a name="Testing_processors">Testing processors</a>
344<span align=right class="section_edit_link">[<a href="/tbwiki/DocBasicSyntax?action=edit&section=Testing_processors">edit section</a>]</font></span>
345</h3>
346<ul><li>#!GetBlock - test for internal get_block() routines
347<li>#!RegressionCheck - test for markup-to-html conversion correctness
348</ul>
349<p>
Legends
Colors
 Added 
Changed
Deleted
Links
(f)irst change
(n)ext change
(t)op

Differences for page "DocBasicSyntax"


expected html
generated html
t No Differences Found t No Differences Found 
Legends
Colors
 Added 
Changed
Deleted
Links
(f)irst change
(n)ext change
(t)op

Update saved output

Back to diff page

Return to Regression_Test page
TBWiki engine 1.9.3 by Tim Bird