libgeda: Don't double free path argument
[geda-gaf.git] / docs / wiki / wiki-syntax.html
blobb1415c18105edc6d9071fb31025fe323e7010f0d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html>
4 <head>
5 <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
6 <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
7 <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10 </head>
11 <body>
13 <h1 id="formattingsyntax">Formatting Syntax</h1>
14 <div class="level1">
16 <p>
17 <a href="https://www.google.com/search?q=DokuWiki&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=DokuWiki&amp;btnI=lucky">DokuWiki</a> supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing &quot;Edit this page&quot;. If you want to try something, just use the <a href="playground-playground.html" class="wikilink1" title="playground-playground.html">playground</a> page. The simpler markup is easily accessible via <a href="https://www.google.com/search?q=toolbar&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=toolbar&amp;btnI=lucky">quickbuttons</a>, too.
18 </p>
20 </div>
22 <h2 id="basictextformatting">Basic Text Formatting</h2>
23 <div class="level2">
25 <p>
26 DokuWiki supports <strong>bold</strong>, <em>italic</em>, <em class="u">underlined</em> and <code>monospaced</code> texts. Of course you can <strong><em class="u"><em><code>combine</code></em></em></strong> all these.
27 </p>
28 <pre class="code">DokuWiki supports **bold**, //italic//, __underlined__ and &#039;&#039;monospaced&#039;&#039; texts.
29 Of course you can **__//&#039;&#039;combine&#039;&#039;//__** all these.</pre>
31 <p>
32 You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
33 </p>
34 <pre class="code">You can use &lt;sub&gt;subscript&lt;/sub&gt; and &lt;sup&gt;superscript&lt;/sup&gt;, too.</pre>
36 <p>
37 You can mark something as <del>deleted</del> as well.
38 </p>
39 <pre class="code">You can mark something as &lt;del&gt;deleted&lt;/del&gt; as well.</pre>
41 <p>
42 <strong>Paragraphs</strong> are created from blank lines. If you want to <strong>force a newline</strong> without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
43 </p>
45 <p>
46 This is some text with some linebreaks<br/>
47 Note that the
48 two backslashes are only recognized at the end of a line<br/>
50 or followed by<br/>
51 a whitespace \\this happens without it.
52 </p>
53 <pre class="code">This is some text with some linebreaks\\ Note that the
54 two backslashes are only recognized at the end of a line\\
55 or followed by\\ a whitespace \\this happens without it.</pre>
57 <p>
58 You should use forced newlines only if really needed.
59 </p>
61 </div>
63 <h2 id="links">Links</h2>
64 <div class="level2">
66 <p>
67 DokuWiki supports multiple ways of creating links.
68 </p>
70 </div>
72 <h3 id="external">External</h3>
73 <div class="level3">
75 <p>
76 External links are recognized automagically: http:<em>www.google.com or simply www.google.com - You can set the link text as well: This Link points to google. Email addresses like this one: <a href="mailto:andi@splitbrain.org" class="mail" title="andi@splitbrain.org">andi@splitbrain.org</a> are recognized, too.
78 DokuWiki supports multiple ways of creating links. External links are recognized
79 automagically: http:</em>www.google.com or simply www.google.com - You can set
80 </p>
81 <pre class="code">link text as well: [[http://www.google.com|This Link points to google]]. Email
82 addresses like this one: &lt;andi@splitbrain.org&gt; are recognized, too.</pre>
84 </div>
86 <h3 id="internal">Internal</h3>
87 <div class="level3">
89 <p>
90 Internal links are created by using square brackets. You can either just give a <a href="wiki-pagename.html" class="wikilink2" title="wiki-pagename.html">pagename</a> or use an additional <a href="wiki-pagename.html" class="wikilink2" title="wiki-pagename.html">link text</a>.
91 </p>
92 <pre class="code">Internal links are created by using square brackets. You can either just give
93 a [[pagename]] or use an additional [[pagename|link text]].</pre>
95 <p>
96 <a href="https://www.google.com/search?q=pagename&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=pagename&amp;btnI=lucky">Wiki pagenames</a> are converted to lowercase automatically, special characters are not allowed.
97 </p>
99 <p>
100 You can use <a href="some-namespaces.html" class="wikilink2" title="some-namespaces.html">namespaces</a> by using a colon in the pagename.
101 </p>
102 <pre class="code">You can use [[some:namespaces]] by using a colon in the pagename.</pre>
105 For details about namespaces see <a href="https://www.google.com/search?q=namespaces&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=namespaces&amp;btnI=lucky">namespaces</a>.
106 </p>
109 Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to <a href="wiki-syntax.html#internal" class="wikilink1" title="wiki-syntax.html">this Section</a>.
110 </p>
111 <pre class="code">This links to [[syntax#internal|this Section]].</pre>
114 Notes:
115 </p>
116 <ul>
117 <li class="level1"><div class="li"> Links to <a href="wiki-syntax.html" class="wikilink1" title="wiki-syntax.html">existing pages</a> are shown in a different style from <a href="wiki-nonexisting.html" class="wikilink2" title="wiki-nonexisting.html">nonexisting</a> ones.</div>
118 </li>
119 <li class="level1"><div class="li"> DokuWiki does not use <a href="https://www.google.com/search?q=CamelCase&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=CamelCase&amp;btnI=lucky">CamelCase</a> to automatically create links by default, but this behavior can be enabled in the <a href="https://www.google.com/search?q=config&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=config&amp;btnI=lucky">config</a> file. Hint: If DokuWiki is a link, then it&#039;s enabled.</div>
120 </li>
121 <li class="level1"><div class="li"> When a section&#039;s heading is changed, its bookmark changes, too. So don&#039;t rely on section linking too much.</div>
122 </li>
123 </ul>
125 </div>
127 <h3 id="interwiki">Interwiki</h3>
128 <div class="level3">
131 DokuWiki supports <a href="https://www.google.com/search?q=Interwiki&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=Interwiki&amp;btnI=lucky">Interwiki</a> links. These are quick links to other Wikis. For example this is a link to Wikipedia&#039;s page about Wikis: <a href="https://www.google.com/search?q=Wiki&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=Wiki&amp;btnI=lucky">Wiki</a>.
132 </p>
133 <pre class="code">DokuWiki supports [[doku&gt;Interwiki]] links. These are quick links to other Wikis.
134 For example this is a link to Wikipedia&#039;s page about Wikis: [[wp&gt;Wiki]].</pre>
136 </div>
138 <h3 id="windowsshares">Windows Shares</h3>
139 <div class="level3">
142 Windows shares like <a href="file://///server/share" class="windows" title="\\server\share">this</a> are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate <a href="https://www.google.com/search?q=Intranet&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=Intranet&amp;btnI=lucky">Intranet</a>.
143 </p>
144 <pre class="code">Windows Shares like [[\\server\share|this]] are recognized, too.</pre>
147 Notes:
148 </p>
149 <ul>
150 <li class="level1"><div class="li"> For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the &quot;local zone&quot;).</div>
151 </li>
152 <li class="level1"><div class="li"> For Mozilla and Firefox it can be enabled through different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in <code>conf/lang/en/lang.php</code> (more details at <a href="https://www.google.com/search?q=localization&amp;btnI=lucky#changing_some_localized_texts_and_strings_in_your_installation" class="interwiki iw_go" title="https://www.google.com/search?q=localization&amp;btnI=lucky#changing_some_localized_texts_and_strings_in_your_installation">localization</a>): <dl class="code">
153 <dt><a href="/./doku.php?do=export_code&amp;id=:wiki:syntax.txt&amp;codeblock=0" title="Download Snippet" class="mediafile mf_php">conf/lang/en/lang.php</a></dt>
154 <dd><pre class="code">&lt;?php
156 * Customization of the english language file
157 * Copy only the strings that needs to be modified
159 $lang[&#039;js&#039;][&#039;nosmblinks&#039;] = &#039;&#039;;</pre>
160 </dd></dl>
161 </div>
162 </li>
163 </ul>
165 </div>
167 <h3 id="imagelinks">Image Links</h3>
168 <div class="level3">
171 You can also use an image to link to another internal or external page by combining the syntax for links and <a href="#images_and_other_files" title=":wiki:syntax.txt ↵" class="wikilink1">images</a> (see below) like this:
172 </p>
173 <pre class="code">[[http://php.net|{{wiki:dokuwiki-128.png}}]]</pre>
176 wiki:dokuwiki-128.png
177 </p>
180 Please note: The image formatting is the only formatting syntax accepted in link names.
181 </p>
184 The whole <a href="#images_and_other_files" title=":wiki:syntax.txt ↵" class="wikilink1">image</a> and <a href="#links" title=":wiki:syntax.txt ↵" class="wikilink1">link</a> syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
185 </p>
187 </div>
189 <h2 id="footnotes">Footnotes</h2>
190 <div class="level2">
193 You can add footnotes <sup><a href="#fn__1" id="fnt__1" class="fn_top">1)</a></sup> by using double parentheses.
194 </p>
195 <pre class="code">You can add footnotes ((This is a footnote)) by using double parentheses.</pre>
197 </div>
199 <h2 id="sectioning">Sectioning</h2>
200 <div class="level2">
203 You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string <code>~~NOTOC~~</code> in the document.
204 </p>
206 </div>
208 <h3 id="headlinelevel3">Headline Level 3</h3>
209 <div class="level3">
211 </div>
213 <h4 id="headlinelevel4">Headline Level 4</h4>
214 <div class="level4">
216 </div>
218 <h5 id="headlinelevel5">Headline Level 5</h5>
219 <div class="level5">
220 <pre class="code">==== Headline Level 3 ====
221 === Headline Level 4 ===
222 == Headline Level 5 ==</pre>
225 By using four or more dashes, you can make a horizontal line:
226 </p>
227 <hr />
229 </div>
231 <h2 id="mediafiles">Media Files</h2>
232 <div class="level2">
235 You can include external and internal <a href="https://www.google.com/search?q=images&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=images&amp;btnI=lucky">images, videos and audio files</a> with curly brackets. Optionally you can specify the size of them.
236 </p>
239 Real size: <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a>
240 </p>
243 Resize to given width: <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a>
244 </p>
247 Resize to given width and height<sup><a href="#fn__2" id="fnt__2" class="fn_top">2)</a></sup>: <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a>
248 </p>
251 Resized external image: <a href="/./lib/exe/fetch.php?tok=a343f7&amp;media=http%3A%2F%2Fphp.net%2Fimages%2Fphp.gif" class="media mediafile mf_gif" title="http://php.net/images/php.gif">http://php.net/images/php.gif</a>
252 </p>
253 <pre class="code">Real size: {{wiki:dokuwiki-128.png}}
254 Resize to given width: {{wiki:dokuwiki-128.png?50}}
255 Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
256 Resized external image: {{http://php.net/images/php.gif?200x50}}</pre>
259 By using left or right whitespaces you can choose the alignment.
260 </p>
263 <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a>
264 </p>
267 <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a>
268 </p>
271 <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a>
272 </p>
273 <pre class="code">{{ wiki:dokuwiki-128.png}}
274 {{wiki:dokuwiki-128.png }}
275 {{ wiki:dokuwiki-128.png }}</pre>
278 Of course, you can add a title (displayed as a tooltip by most browsers), too.
279 </p>
282 <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">This is the caption</a>
283 </p>
284 <pre class="code">{{ wiki:dokuwiki-128.png |This is the caption}}</pre>
287 For linking an image to another page see <a href="#imagelinks" title=":wiki:syntax.txt ↵" class="wikilink1">Image Links</a> above.
288 </p>
290 </div>
292 <h3 id="supportedmediaformats">Supported Media Formats</h3>
293 <div class="level3">
296 DokuWiki can embed the following media formats directly.
297 </p>
298 <div class="table sectionedit1"><table class="inline">
299 <tr class="row0">
300 <td class="col0"> Image </td><td class="col1 leftalign"> <code>gif</code>, <code>jpg</code>, <code>png</code> </td>
301 </tr>
302 <tr class="row1">
303 <td class="col0"> Video </td><td class="col1"> <code>webm</code>, <code>ogv</code>, <code>mp4</code> </td>
304 </tr>
305 <tr class="row2">
306 <td class="col0"> Audio </td><td class="col1 leftalign"> <code>ogg</code>, <code>mp3</code>, <code>wav</code> </td>
307 </tr>
308 <tr class="row3">
309 <td class="col0"> Flash </td><td class="col1 leftalign"> <code>swf</code> </td>
310 </tr>
311 </table></div>
312 <!-- EDIT1 TABLE [7592-7747] -->
314 If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
315 </p>
318 By adding <code>?linkonly</code> you provide a link to the media without displaying it inline
319 </p>
320 <pre class="code">{{wiki:dokuwiki-128.png?linkonly}}</pre>
323 <a href="media/wiki/dokuwiki-128.png" class="media" target="_blank" title="wiki:dokuwiki-128.png">wiki:dokuwiki-128.png</a> This is just a link to the image.
324 </p>
326 </div>
328 <h3 id="fallbackformats">Fallback Formats</h3>
329 <div class="level3">
332 Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.
333 </p>
336 For example consider this embedded mp4 video:
337 </p>
338 <pre class="code">{{video.mp4|A funny video}}</pre>
341 When you upload a <code>video.webm</code> and <code>video.ogv</code> next to the referenced <code>video.mp4</code>, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
342 </p>
345 Additionally DokuWiki supports a &quot;poster&quot; image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a <code>video.jpg</code> file would work.
346 </p>
348 </div>
350 <h2 id="lists">Lists</h2>
351 <div class="level2">
354 Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a <code>*</code> for unordered lists or a <code>-</code> for ordered ones.
355 </p>
356 <ul>
357 <li class="level1"><div class="li"> This is a list</div>
358 </li>
359 <li class="level1 node"><div class="li"> The second item</div>
360 <ul>
361 <li class="level2"><div class="li"> You may have different levels</div>
362 </li>
363 </ul>
364 </li>
365 <li class="level1"><div class="li"> Another item</div>
366 </li>
367 </ul>
368 <ol>
369 <li class="level1"><div class="li"> The same list but ordered</div>
370 </li>
371 <li class="level1 node"><div class="li"> Another item</div>
372 <ol>
373 <li class="level2"><div class="li"> Just use indention for deeper levels</div>
374 </li>
375 </ol>
376 </li>
377 <li class="level1"><div class="li"> That&#039;s it</div>
378 </li>
379 </ol>
380 <pre class="code"> * This is a list
381 * The second item
382 * You may have different levels
383 * Another item
385 - The same list but ordered
386 - Another item
387 - Just use indention for deeper levels
388 - That&#039;s it</pre>
391 Also take a look at the <a href="https://www.google.com/search?q=faq%3Alists&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=faq%3Alists&amp;btnI=lucky">FAQ on list items</a>.
392 </p>
394 </div>
396 <h2 id="textconversions">Text Conversions</h2>
397 <div class="level2">
400 DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
401 </p>
404 The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.
405 </p>
407 </div>
409 <h3 id="texttoimageconversions">Text to Image Conversions</h3>
410 <div class="level3">
413 DokuWiki converts commonly used <a href="https://www.google.com/search?q=emoticon&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=emoticon&amp;btnI=lucky">emoticon</a>s to their graphical equivalents. Those <a href="https://www.google.com/search?q=Smileys&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=Smileys&amp;btnI=lucky">Smileys</a> and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
414 </p>
415 <ul>
416 <li class="level1"><div class="li"> 8-) 8-) </div>
417 </li>
418 <li class="level1"><div class="li"> 8-O 8-O </div>
419 </li>
420 <li class="level1"><div class="li"> :-( :-( </div>
421 </li>
422 <li class="level1"><div class="li"> :-) :-) </div>
423 </li>
424 <li class="level1"><div class="li"> =) =) </div>
425 </li>
426 <li class="level1"><div class="li"> :-/ :-/ </div>
427 </li>
428 <li class="level1"><div class="li"> :-\ :-\ </div>
429 </li>
430 <li class="level1"><div class="li"> :-? :-? </div>
431 </li>
432 <li class="level1"><div class="li"> :-D :-D </div>
433 </li>
434 <li class="level1"><div class="li"> :-P :-P </div>
435 </li>
436 <li class="level1"><div class="li"> :-O :-O </div>
437 </li>
438 <li class="level1"><div class="li"> :-X :-X </div>
439 </li>
440 <li class="level1"><div class="li"> :-| :-| </div>
441 </li>
442 <li class="level1"><div class="li"> ;-) ;-) </div>
443 </li>
444 <li class="level1"><div class="li"> ^_^ ^_^ </div>
445 </li>
446 <li class="level1"><div class="li"> :?: :?: </div>
447 </li>
448 <li class="level1"><div class="li"> :!: :!: </div>
449 </li>
450 <li class="level1"><div class="li"> LOL LOL </div>
451 </li>
452 <li class="level1"><div class="li"> FIXME FIXME </div>
453 </li>
454 <li class="level1"><div class="li"> DELETEME DELETEME </div>
455 </li>
456 </ul>
458 </div>
460 <h3 id="texttohtmlconversions">Text to HTML Conversions</h3>
461 <div class="level3">
464 Typography: <a href="wiki-dokuwiki.html" class="wikilink1" title="wiki-dokuwiki.html">DokuWiki</a> can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
465 </p>
468 -&gt; &lt;- &lt;-&gt; =&gt; &lt;= &lt;=&gt; &gt;&gt; &lt;&lt; -- --- 640x480 (c) (tm) (r)
469 &quot;He thought &#039;It&#039;s a man&#039;s world&#039;...&quot;
470 </p>
471 <pre class="code">-&gt; &lt;- &lt;-&gt; =&gt; &lt;= &lt;=&gt; &gt;&gt; &lt;&lt; -- --- 640x480 (c) (tm) (r)
472 &quot;He thought &#039;It&#039;s a man&#039;s world&#039;...&quot;</pre>
475 The same can be done to produce any kind of HTML, it just needs to be added to the <a href="https://www.google.com/search?q=entities&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=entities&amp;btnI=lucky">pattern file</a>.
476 </p>
479 There are three exceptions which do not come from that pattern file: multiplication entity (640x480), &#039;single&#039; and &quot;double quotes&quot;. They can be turned off through a <a href="https://www.google.com/search?q=config%3Atypography&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=config%3Atypography&amp;btnI=lucky">config option</a>.
480 </p>
482 </div>
484 <h2 id="quoting">Quoting</h2>
485 <div class="level2">
488 Some times you want to mark some text to show it&#039;s a reply or comment. You can use the following syntax:
489 </p>
490 <pre class="code">I think we should do it
492 &gt; No we shouldn&#039;t
494 &gt;&gt; Well, I say we should
496 &gt; Really?
498 &gt;&gt; Yes!
500 &gt;&gt;&gt; Then lets do it!</pre>
503 I think we should do it
504 </p>
505 <blockquote><div class="no">
506 No we shouldn&#039;t</div></blockquote>
507 <blockquote><div class="no">
508 <blockquote><div class="no">
509 Well, I say we should</div></blockquote>
510 </div></blockquote>
511 <blockquote><div class="no">
512 Really?</div></blockquote>
513 <blockquote><div class="no">
514 <blockquote><div class="no">
515 Yes!</div></blockquote>
516 </div></blockquote>
517 <blockquote><div class="no">
518 <blockquote><div class="no">
519 <blockquote><div class="no">
520 Then lets do it!</div></blockquote>
521 </div></blockquote>
522 </div></blockquote>
524 </div>
526 <h2 id="tables">Tables</h2>
527 <div class="level2">
530 DokuWiki supports a simple syntax to create tables.
531 </p>
532 <div class="table sectionedit2"><table class="inline">
533 <thead>
534 <tr class="row0">
535 <th class="col0 leftalign"> Heading 1 </th><th class="col1 leftalign"> Heading 2 </th><th class="col2 leftalign"> Heading 3 </th>
536 </tr>
537 </thead>
538 <tr class="row1">
539 <td class="col0 leftalign"> Row 1 Col 1 </td><td class="col1 leftalign"> Row 1 Col 2 </td><td class="col2 leftalign"> Row 1 Col 3 </td>
540 </tr>
541 <tr class="row2">
542 <td class="col0 leftalign"> Row 2 Col 1 </td><td class="col1" colspan="2"> some colspan (note the double pipe) </td>
543 </tr>
544 <tr class="row3">
545 <td class="col0 leftalign"> Row 3 Col 1 </td><td class="col1 leftalign"> Row 3 Col 2 </td><td class="col2 leftalign"> Row 3 Col 3 </td>
546 </tr>
547 </table></div>
548 <!-- EDIT2 TABLE [11552-11783] -->
550 Table rows have to start and end with a <code>|</code> for normal rows or a <code>^</code> for headers.
551 </p>
552 <pre class="code">^ Heading 1 ^ Heading 2 ^ Heading 3 ^
553 | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
554 | Row 2 Col 1 | some colspan (note the double pipe) ||
555 | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 |</pre>
558 To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
559 </p>
562 Vertical tableheaders are possible, too.
563 </p>
564 <div class="table sectionedit3"><table class="inline">
565 <thead>
566 <tr class="row0">
567 <td class="col0 leftalign"> </td><th class="col1 leftalign"> Heading 1 </th><th class="col2 leftalign"> Heading 2 </th>
568 </tr>
569 </thead>
570 <tr class="row1">
571 <th class="col0 leftalign"> Heading 3 </th><td class="col1 leftalign"> Row 1 Col 2 </td><td class="col2 leftalign"> Row 1 Col 3 </td>
572 </tr>
573 <tr class="row2">
574 <th class="col0 leftalign"> Heading 4 </th><td class="col1"> no colspan this time </td><td class="col2 leftalign"> </td>
575 </tr>
576 <tr class="row3">
577 <th class="col0 leftalign"> Heading 5 </th><td class="col1 leftalign"> Row 2 Col 2 </td><td class="col2 leftalign"> Row 2 Col 3 </td>
578 </tr>
579 </table></div>
580 <!-- EDIT3 TABLE [12303-12546] -->
582 As you can see, it&#039;s the cell separator before a cell which decides about the formatting:
583 </p>
584 <pre class="code">| ^ Heading 1 ^ Heading 2 ^
585 ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 |
586 ^ Heading 4 | no colspan this time | |
587 ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 |</pre>
590 You can have rowspans (vertically connected cells) by adding <code>:::</code> into the cells below the one to which they should connect.
591 </p>
592 <div class="table sectionedit4"><table class="inline">
593 <thead>
594 <tr class="row0">
595 <th class="col0 leftalign"> Heading 1 </th><th class="col1 leftalign"> Heading 2 </th><th class="col2 leftalign"> Heading 3 </th>
596 </tr>
597 </thead>
598 <tr class="row1">
599 <td class="col0 leftalign"> Row 1 Col 1 </td><td class="col1" rowspan="3"> this cell spans vertically </td><td class="col2 leftalign"> Row 1 Col 3 </td>
600 </tr>
601 <tr class="row2">
602 <td class="col0 leftalign"> Row 2 Col 1 </td><td class="col1 leftalign"> Row 2 Col 3 </td>
603 </tr>
604 <tr class="row3">
605 <td class="col0 leftalign"> Row 3 Col 1 </td><td class="col1 leftalign"> Row 2 Col 3 </td>
606 </tr>
607 </table></div>
608 <!-- EDIT4 TABLE [13025-13300] -->
610 Apart from the rowspan syntax those cells should not contain anything else.
611 </p>
612 <pre class="code">^ Heading 1 ^ Heading 2 ^ Heading 3 ^
613 | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 |
614 | Row 2 Col 1 | ::: | Row 2 Col 3 |
615 | Row 3 Col 1 | ::: | Row 2 Col 3 |</pre>
618 You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
619 </p>
620 <div class="table sectionedit5"><table class="inline">
621 <thead>
622 <tr class="row0">
623 <th class="col0 centeralign" colspan="3"> Table with alignment </th>
624 </tr>
625 </thead>
626 <tr class="row1">
627 <td class="col0 rightalign"> right</td><td class="col1 centeralign"> center </td><td class="col2 leftalign">left </td>
628 </tr>
629 <tr class="row2">
630 <td class="col0 leftalign">left </td><td class="col1 rightalign"> right</td><td class="col2 centeralign"> center </td>
631 </tr>
632 <tr class="row3">
633 <td class="col0"> xxxxxxxxxxxx </td><td class="col1"> xxxxxxxxxxxx </td><td class="col2"> xxxxxxxxxxxx </td>
634 </tr>
635 </table></div>
636 <!-- EDIT5 TABLE [13909-14096] -->
638 This is how it looks in the source:
639 </p>
640 <pre class="code">^ Table with alignment ^^^
641 | right| center |left |
642 |left | right| center |
643 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |</pre>
646 Note: Vertical alignment is not supported.
647 </p>
649 </div>
651 <h2 id="noformatting">No Formatting</h2>
652 <div class="level2">
655 If you need to display text exactly like it is typed (without any formatting), enclose the area either with <code>&lt;nowiki&gt;</code> tags or even simpler, with double percent signs <code>%%</code>.
656 </p>
660 This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
662 The same is true for //__this__ text// with a smiley ;-).
663 </p>
664 <pre class="code">&lt;nowiki&gt;
665 This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
666 &lt;/nowiki&gt;
667 The same is true for %%//__this__ text// with a smiley ;-)%%.</pre>
669 </div>
671 <h2 id="codeblocks">Code Blocks</h2>
672 <div class="level2">
675 You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code>&lt;code&gt;</code> or <code>&lt;file&gt;</code>.
676 </p>
677 <pre class="code">This is text is indented by two spaces.</pre>
678 <pre class="code">This is preformatted code all spaces are preserved: like &lt;-this</pre>
679 <pre class="file">This is pretty much the same, but you could use it to show that you quoted a file.</pre>
682 Those blocks were created by this source:
683 </p>
684 <pre class="code"> This is text is indented by two spaces.</pre>
685 <pre class="code">&lt;code&gt;
686 This is preformatted code all spaces are preserved: like &lt;-this
687 &lt;/code&gt;</pre>
688 <pre class="code">&lt;file&gt;
689 This is pretty much the same, but you could use it to show that you quoted a file.
690 &lt;/file&gt;</pre>
692 </div>
694 <h3 id="syntaxhighlighting">Syntax Highlighting</h3>
695 <div class="level3">
698 <a href="wiki-dokuwiki.html" class="wikilink1" title="wiki-dokuwiki.html">DokuWiki</a> can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. <code>&lt;code java&gt;</code> or <code>&lt;file java&gt;</code>.
699 </p>
700 <pre class="code java"><span class="co3">/**
701 * The HelloWorldApp class implements an application that
702 * simply displays &quot;Hello World!&quot; to the standard output.
703 */</span>
704 <span class="kw1">class</span> HelloWorldApp <span class="br0">&#123;</span>
705 <span class="kw1">public</span> <span class="kw1">static</span> <span class="kw4">void</span> main<span class="br0">&#40;</span><a href="http://www.google.com/search?hl=en&amp;q=allinurl%3Adocs.oracle.com+javase+docs+api+string"><span class="kw3">String</span></a><span class="br0">&#91;</span><span class="br0">&#93;</span> args<span class="br0">&#41;</span> <span class="br0">&#123;</span>
706 <a href="http://www.google.com/search?hl=en&amp;q=allinurl%3Adocs.oracle.com+javase+docs+api+system"><span class="kw3">System</span></a>.<span class="me1">out</span>.<span class="me1">println</span><span class="br0">&#40;</span><span class="st0">&quot;Hello World!&quot;</span><span class="br0">&#41;</span><span class="sy0">;</span> <span class="co1">//Display the string.</span>
707 <span class="br0">&#125;</span>
708 <span class="br0">&#125;</span></pre>
711 The following language strings are currently recognized: <em>4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic</em>
712 </p>
714 </div>
716 <h3 id="downloadablecodeblocks">Downloadable Code Blocks</h3>
717 <div class="level3">
720 When you use the <code>&lt;code&gt;</code> or <code>&lt;file&gt;</code> syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
721 </p>
722 <pre class="code">&lt;file php myexample.php&gt;
723 &lt;?php echo &quot;hello world!&quot;; ?&gt;
724 &lt;/file&gt;</pre>
725 <dl class="file">
726 <dt><a href="/./doku.php?do=export_code&amp;id=:wiki:syntax.txt&amp;codeblock=8" title="Download Snippet" class="mediafile mf_php">myexample.php</a></dt>
727 <dd><pre class="code file php"><span class="kw2">&lt;?php</span> <span class="kw1">echo</span> <span class="st0">&quot;hello world!&quot;</span><span class="sy0">;</span> <span class="sy1">?&gt;</span></pre>
728 </dd></dl>
731 If you don&#039;t want any highlighting but want a downloadable file, specify a dash (<code>-</code>) as the language code: <code>&lt;code - myfile.foo&gt;</code>.
732 </p>
734 </div>
736 <h2 id="embeddinghtmlandphp">Embedding HTML and PHP</h2>
737 <div class="level2">
740 You can embed raw HTML or PHP code into your documents by using the <code>&lt;html&gt;</code> or <code>&lt;php&gt;</code> tags. (Use uppercase tags if you need to enclose block level elements.)
741 </p>
744 HTML example:
745 </p>
746 <pre class="code">&lt;html&gt;
747 This is some &lt;span style=&quot;color:red;font-size:150%;&quot;&gt;inline HTML&lt;/span&gt;
748 &lt;/html&gt;
749 &lt;HTML&gt;
750 &lt;p style=&quot;border:2px dashed red;&quot;&gt;And this is some block HTML&lt;/p&gt;
751 &lt;/HTML&gt;</pre>
754 <code class="code html4strict">This is some <span class="sc2">&lt;<a href="http://december.com/html/4/element/span.html"><span class="kw2">span</span></a> <span class="kw3">style</span><span class="sy0">=</span><span class="st0">&quot;color:red;font-size:150%;&quot;</span>&gt;</span>inline HTML<span class="sc2">&lt;<span class="sy0">/</span><a href="http://december.com/html/4/element/span.html"><span class="kw2">span</span></a>&gt;</span></code>
755 </p>
756 <pre class="code html4strict"><span class="sc2">&lt;<a href="http://december.com/html/4/element/p.html"><span class="kw2">p</span></a> <span class="kw3">style</span><span class="sy0">=</span><span class="st0">&quot;border:2px dashed red;&quot;</span>&gt;</span>And this is some block HTML<span class="sc2">&lt;<span class="sy0">/</span><a href="http://december.com/html/4/element/p.html"><span class="kw2">p</span></a>&gt;</span></pre>
758 PHP example:
759 </p>
760 <pre class="code">&lt;php&gt;
761 echo &#039;The PHP version: &#039;;
762 echo phpversion();
763 echo &#039; (generated inline HTML)&#039;;
764 &lt;/php&gt;
765 &lt;PHP&gt;
766 echo &#039;&lt;table class=&quot;inline&quot;&gt;&lt;tr&gt;&lt;td&gt;The same, but inside a block level element:&lt;/td&gt;&#039;;
767 echo &#039;&lt;td&gt;&#039;.phpversion().&#039;&lt;/td&gt;&#039;;
768 echo &#039;&lt;/tr&gt;&lt;/table&gt;&#039;;
769 &lt;/PHP&gt;</pre>
772 <code class="code php"><span class="kw1">echo</span> <span class="st_h">'The PHP version: '</span><span class="sy0">;</span>
773 <span class="kw1">echo</span> <a href="http://www.php.net/phpversion"><span class="kw3">phpversion</span></a><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="sy0">;</span>
774 <span class="kw1">echo</span> <span class="st_h">' (inline HTML)'</span><span class="sy0">;</span></code>
775 </p>
776 <pre class="code php"><span class="kw1">echo</span> <span class="st_h">'&lt;table class=&quot;inline&quot;&gt;&lt;tr&gt;&lt;td&gt;The same, but inside a block level element:&lt;/td&gt;'</span><span class="sy0">;</span>
777 <span class="kw1">echo</span> <span class="st_h">'&lt;td&gt;'</span><span class="sy0">.</span><a href="http://www.php.net/phpversion"><span class="kw3">phpversion</span></a><span class="br0">&#40;</span><span class="br0">&#41;</span><span class="sy0">.</span><span class="st_h">'&lt;/td&gt;'</span><span class="sy0">;</span>
778 <span class="kw1">echo</span> <span class="st_h">'&lt;/tr&gt;&lt;/table&gt;'</span><span class="sy0">;</span></pre>
780 <strong>Please Note</strong>: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
781 </p>
783 </div>
785 <h2 id="rssatomfeedaggregation">RSS/ATOM Feed Aggregation</h2>
786 <div class="level2">
789 <a href="wiki-dokuwiki.html" class="wikilink1" title="wiki-dokuwiki.html">DokuWiki</a> can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
790 </p>
791 <div class="table sectionedit6"><table class="inline">
792 <thead>
793 <tr class="row0">
794 <th class="col0 leftalign"> Parameter </th><th class="col1"> Description </th>
795 </tr>
796 </thead>
797 <tr class="row1">
798 <td class="col0"> any number </td><td class="col1"> will be used as maximum number items to show, defaults to 8 </td>
799 </tr>
800 <tr class="row2">
801 <td class="col0 leftalign"> reverse </td><td class="col1"> display the last items in the feed first </td>
802 </tr>
803 <tr class="row3">
804 <td class="col0 leftalign"> author </td><td class="col1"> show item authors names </td>
805 </tr>
806 <tr class="row4">
807 <td class="col0 leftalign"> date </td><td class="col1"> show item dates </td>
808 </tr>
809 <tr class="row5">
810 <td class="col0"> description</td><td class="col1"> show the item description. If <a href="https://www.google.com/search?q=config%3Ahtmlok&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=config%3Ahtmlok&amp;btnI=lucky">HTML</a> is disabled all tags will be stripped </td>
811 </tr>
812 <tr class="row6">
813 <td class="col0 leftalign"> nosort </td><td class="col1"> do not sort the items in the feed </td>
814 </tr>
815 <tr class="row7">
816 <td class="col0"> <em>n</em>[dhm] </td><td class="col1"> refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). </td>
817 </tr>
818 </table></div>
819 <!-- EDIT6 TABLE [20286-20777] -->
821 The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. <a href="wiki-dokuwiki.html" class="wikilink1" title="wiki-dokuwiki.html">DokuWiki</a> will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells <a href="wiki-dokuwiki.html" class="wikilink1" title="wiki-dokuwiki.html">DokuWiki</a> to re-render the page if it is more than <em>refresh period</em> since the page was last rendered.
822 </p>
825 By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the <code>reverse</code> parameter, or display the feed as is with <code>nosort</code>.
826 </p>
829 <strong>Example:</strong>
830 </p>
831 <pre class="code">{{rss&gt;http://slashdot.org/index.rss 5 author date 1h }}</pre>
832 <ul class="rss"><li><div class="li">Activision Blizzard Suspends &#039;Hearthstone&#039; Pro Player for Supporting Hong Kong Protests by msmash (2019-10-08T16:50:00+00:00)</div></li><li><div class="li">Apple&#039;s Merged iPad, Mac Apps Leave Developers Uneasy, Users Paying Twice by msmash (2019-10-08T16:10:00+00:00)</div></li><li><div class="li">Sony Confirms PlayStation 5 Name, Holiday 2020 Release Date by msmash (2019-10-08T15:30:00+00:00)</div></li><li><div class="li">US Using Trade Deals To Shield Tech Giants From Foreign Regulators by msmash (2019-10-08T14:44:00+00:00)</div></li><li><div class="li">Chinese Firms Tencent, Vivo, and CCTV Suspend Ties With the NBA Over Hong Kong Tweet by msmash (2019-10-08T14:05:00+00:00)</div></li></ul>
833 </div>
835 <h2 id="controlmacros">Control Macros</h2>
836 <div class="level2">
839 Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
840 </p>
841 <div class="table sectionedit7"><table class="inline">
842 <thead>
843 <tr class="row0">
844 <th class="col0 leftalign"> Macro </th><th class="col1"> Description </th>
845 </tr>
846 </thead>
847 <tr class="row1">
848 <td class="col0 leftalign"> ~~NOTOC~~ </td><td class="col1"> If this macro is found on the page, no table of contents will be created </td>
849 </tr>
850 <tr class="row2">
851 <td class="col0"> ~~NOCACHE~~ </td><td class="col1"> DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the &lt;php&gt; syntax above is used), adding this macro will force DokuWiki to rerender a page on every call </td>
852 </tr>
853 </table></div>
854 <!-- EDIT7 TABLE [21630-21972] -->
855 </div>
857 <h2 id="syntaxplugins">Syntax Plugins</h2>
858 <div class="level2">
861 DokuWiki&#039;s syntax can be extended by <a href="https://www.google.com/search?q=plugins&amp;btnI=lucky" class="interwiki iw_go" title="https://www.google.com/search?q=plugins&amp;btnI=lucky">Plugins</a>. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:
862 </p>
863 <ul><li><div class="li">keyboard <em>2016-09-10</em> by <a href="mailto:osd@foosel.net" class="mail" title="osd@foosel.net">Gina Häußge</a><br />The keyboard plugin provides a combined syntax and action plugin in order to markup text as keyboard keys, similar to (and making use of) the existing (X)HTML tag &lt;kbd&gt;&lt;/kbd&gt;. A quick button for the markup is automatically inserted into the toolbar of the edit form.</div></li><li><div class="li">Note Plugin <em>2016-09-14</em> by <a href="mailto:olive@deep-ocean.net" class="mail" title="olive@deep-ocean.net">Olivier Cortès, Eric Hameleers, Christopher Smith, Aurélien Bompard, LarsDW223</a><br />Add Note/Important/Tip/Warning Capability (DIV+CSS box)</div></li><li><div class="li">Indexmenu Plugin <em>2015-08-26</em> by <a href="mailto:samuele@samuele.netsons.org" class="mail" title="samuele@samuele.netsons.org">Samuele Tognini</a><br />Show a customizable and sortable index for a namespace</div></li><li><div class="li">Info Plugin <em>2014-10-01</em> by <a href="mailto:andi@splitbrain.org" class="mail" title="andi@splitbrain.org">Andreas Gohr</a><br />Displays information about various DokuWiki internals</div></li></ul>
864 </div>
865 <div class="footnotes">
866 <div class="fn"><sup><a href="#fnt__1" id="fn__1" class="fn_bot">1)</a></sup>
867 <div class="content">This is a footnote</div></div>
868 <div class="fn"><sup><a href="#fnt__2" id="fn__2" class="fn_bot">2)</a></sup>
869 <div class="content">when the aspect ratio of the given width and height doesn&#039;t match that of the image, it will be cropped to the new ratio before resizing</div></div>
870 </div>
871 </body>
872 </html>