1====== Formatting Syntax ====== 2 3[[doku>DokuWiki]] 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 the //Edit this page// button at the top or bottom of the page. If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too. 4 5===== Basic Text Formatting ===== 6 7DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. 8 9 DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. 10 Of course you can **__//''combine''//__** all these. 11 12You can use <sub>subscript</sub> and <sup>superscript</sup>, too. 13 14 You can use <sub>subscript</sub> and <sup>superscript</sup>, too. 15 16You can mark something as <del>deleted</del> as well. 17 18 You can mark something as <del>deleted</del> as well. 19 20**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. 21 22This is some text with some linebreaks\\ Note that the 23two backslashes are only recognized at the end of a line\\ 24or followed by\\ a whitespace \\this happens without it. 25 26 This is some text with some linebreaks\\ Note that the 27 two backslashes are only recognized at the end of a line\\ 28 or followed by\\ a whitespace \\this happens without it. 29 30You should use forced newlines only if really needed. 31 32===== Links ===== 33 34DokuWiki supports multiple ways of creating links. 35 36==== External ==== 37 38External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too. 39 40 DokuWiki supports multiple ways of creating links. External links are recognized 41 automagically: http://www.google.com or simply www.google.com - You can set 42 link text as well: [[http://www.google.com|This Link points to google]]. Email 43 addresses like this one: <andi@splitbrain.org> are recognized, too. 44 45==== Internal ==== 46 47Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. 48 49 Internal links are created by using square brackets. You can either just give 50 a [[pagename]] or use an additional [[pagename|link text]]. 51 52[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. 53 54You can use [[some:namespaces]] by using a colon in the pagename. 55 56 You can use [[some:namespaces]] by using a colon in the pagename. 57 58For details about namespaces see [[doku>namespaces]]. 59 60Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#internal|this Section]]. 61 62 This links to [[syntax#internal|this Section]]. 63 64Notes: 65 66 * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. 67 * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled. 68 * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. 69 70==== Interwiki ==== 71 72DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. 73 74 DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. 75 For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. 76 77==== Windows Shares ==== 78 79Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>Intranet]]. 80 81 Windows Shares like [[\\server\share|this]] are recognized, too. 82 83Notes: 84 85 * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). 86 * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|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 ''conf/local.protected.php'': 87 88 $lang['js']['nosmblinks'] = ''; 89 90==== Image Links ==== 91 92You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this: 93 94 [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] 95 96[[http://www.php.net|{{wiki:dokuwiki-128.png}}]] 97 98Please note: The image formatting is the only formatting syntax accepted in link names. 99 100The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links). 101 102===== Footnotes ===== 103 104You can add footnotes ((This is a footnote)) by using double parentheses. 105 106 You can add footnotes ((This is a footnote)) by using double parentheses. 107 108===== Sectioning ===== 109 110You 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 ''<nowiki>~~NOTOC~~</nowiki>'' in the document. 111 112==== Headline Level 3 ==== 113=== Headline Level 4 === 114== Headline Level 5 == 115 116 ==== Headline Level 3 ==== 117 === Headline Level 4 === 118 == Headline Level 5 == 119 120By using four or more dashes, you can make a horizontal line: 121 122---- 123 124===== Images and Other Files ===== 125 126You can include external and internal [[doku>images]] with curly brackets. Optionally you can specify the size of them. 127 128Real size: {{wiki:dokuwiki-128.png}} 129 130Resize to given width: {{wiki:dokuwiki-128.png?50}} 131 132Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:dokuwiki-128.png?200x50}} 133 134Resized external image: {{http://de3.php.net/images/php.gif?200x50}} 135 136 Real size: {{wiki:dokuwiki-128.png}} 137 Resize to given width: {{wiki:dokuwiki-128.png?50}} 138 Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} 139 Resized external image: {{http://de3.php.net/images/php.gif?200x50}} 140 141 142By using left or right whitespaces you can choose the alignment. 143 144{{ wiki:dokuwiki-128.png}} 145 146{{wiki:dokuwiki-128.png }} 147 148{{ wiki:dokuwiki-128.png }} 149 150 {{ wiki:dokuwiki-128.png}} 151 {{wiki:dokuwiki-128.png }} 152 {{ wiki:dokuwiki-128.png }} 153 154Of course, you can add a title (displayed as a tooltip by most browsers), too. 155 156{{ wiki:dokuwiki-128.png |This is the caption}} 157 158 {{ wiki:dokuwiki-128.png |This is the caption}} 159 160If you specify a filename (external or internal) that is not an image (''gif, jpeg, png''), then it will be displayed as a link instead. 161 162For linking an image to another page see [[#Image Links]] above. 163 164===== Lists ===== 165 166Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''*'' for unordered lists or a ''-'' for ordered ones. 167 168 * This is a list 169 * The second item 170 * You may have different levels 171 * Another item 172 173 - The same list but ordered 174 - Another item 175 - Just use indention for deeper levels 176 - That's it 177 178<code> 179 * This is a list 180 * The second item 181 * You may have different levels 182 * Another item 183 184 - The same list but ordered 185 - Another item 186 - Just use indention for deeper levels 187 - That's it 188</code> 189 190Also take a look at the [[doku>faq:lists|FAQ on list items]]. 191 192===== Text Conversions ===== 193 194DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. 195 196The 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. 197 198==== Text to Image Conversions ==== 199 200DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki: 201 202 * 8-) %% 8-) %% 203 * 8-O %% 8-O %% 204 * :-( %% :-( %% 205 * :-) %% :-) %% 206 * =) %% =) %% 207 * :-/ %% :-/ %% 208 * :-\ %% :-\ %% 209 * :-? %% :-? %% 210 * :-D %% :-D %% 211 * :-P %% :-P %% 212 * :-O %% :-O %% 213 * :-X %% :-X %% 214 * :-| %% :-| %% 215 * ;-) %% ;-) %% 216 * ^_^ %% ^_^ %% 217 * :?: %% :?: %% 218 * :!: %% :!: %% 219 * LOL %% LOL %% 220 * FIXME %% FIXME %% 221 * DELETEME %% DELETEME %% 222 223==== Text to HTML Conversions ==== 224 225Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. 226 227-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) 228"He thought 'It's a man's world'..." 229 230<code> 231-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) 232"He thought 'It's a man's world'..." 233</code> 234 235The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. 236 237There are three exceptions which do not come from that pattern file: multiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]]. 238 239===== Quoting ===== 240 241Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: 242 243 I think we should do it 244 245 > No we shouldn't 246 247 >> Well, I say we should 248 249 > Really? 250 251 >> Yes! 252 253 >>> Then lets do it! 254 255I think we should do it 256 257> No we shouldn't 258 259>> Well, I say we should 260 261> Really? 262 263>> Yes! 264 265>>> Then lets do it! 266 267===== Tables ===== 268 269DokuWiki supports a simple syntax to create tables. 270 271^ Heading 1 ^ Heading 2 ^ Heading 3 ^ 272| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | 273| Row 2 Col 1 | some colspan (note the double pipe) || 274| Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | 275 276Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. 277 278 ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ 279 | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | 280 | Row 2 Col 1 | some colspan (note the double pipe) || 281 | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | 282 283To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! 284 285Vertical tableheaders are possible, too. 286 287| ^ Heading 1 ^ Heading 2 ^ 288^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | 289^ Heading 4 | no colspan this time | | 290^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | 291 292As you can see, it's the cell separator before a cell which decides about the formatting: 293 294 | ^ Heading 1 ^ Heading 2 ^ 295 ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | 296 ^ Heading 4 | no colspan this time | | 297 ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | 298 299You can have rowspans (vertically connected cells) by adding '':::'' into the cells below the one to which they should connect. 300 301^ Heading 1 ^ Heading 2 ^ Heading 3 ^ 302| Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | 303| Row 2 Col 1 | ::: | Row 2 Col 3 | 304| Row 3 Col 1 | ::: | Row 2 Col 3 | 305 306Apart from the rowspan syntax those cells should not contain anything else. 307 308 ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ 309 | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | 310 | Row 2 Col 1 | ::: | Row 2 Col 3 | 311 | Row 3 Col 1 | ::: | Row 2 Col 3 | 312 313You 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. 314 315^ Table with alignment ^^^ 316| right| center |left | 317|left | right| center | 318| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 319 320This is how it looks in the source: 321 322 ^ Table with alignment ^^^ 323 | right| center |left | 324 |left | right| center | 325 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 326 327Note: Vertical alignment is not supported. 328 329===== No Formatting ===== 330 331If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''. 332 333<nowiki> 334This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 335</nowiki> 336The same is true for %%//__this__ text// with a smiley ;-)%%. 337 338 <nowiki> 339 This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 340 </nowiki> 341 The same is true for %%//__this__ text// with a smiley ;-)%%. 342 343===== Code Blocks ===== 344 345You 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>%%'' or ''%%<file>%%''. 346 347 This is text is indented by two spaces. 348 349<code> 350This is preformatted code all spaces are preserved: like <-this 351</code> 352 353<file> 354This is pretty much the same, but you could use it to show that you quoted a file. 355</file> 356 357Those blocks were created by this source: 358 359 This is text is indented by two spaces. 360 361 <code> 362 This is preformatted code all spaces are preserved: like <-this 363 </code> 364 365 <file> 366 This is pretty much the same, but you could use it to show that you quoted a file. 367 </file> 368 369==== Syntax Highlighting ==== 370 371[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|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. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''. 372 373<code java> 374/** 375 * The HelloWorldApp class implements an application that 376 * simply displays "Hello World!" to the standard output. 377 */ 378class HelloWorldApp { 379 public static void main(String[] args) { 380 System.out.println("Hello World!"); //Display the string. 381 } 382} 383</code> 384 385The following language strings are currently recognized: //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// 386 387==== Downloadable Code Blocks ==== 388 389When you use the ''%%<code>%%'' or ''%%<file>%%'' 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: 390 391<code> 392<file php myexample.php> 393<?php echo "hello world!"; ?> 394</file> 395</code> 396 397<file php myexample.php> 398<?php echo "hello world!"; ?> 399</file> 400 401If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. 402 403 404===== Embedding HTML and PHP ===== 405 406You can embed raw HTML or PHP code into your documents by using the ''%%<html>%%'' or ''%%<php>%%'' tags. (Use uppercase tags if you need to enclose block level elements.) 407 408HTML example: 409 410<code> 411<html> 412This is some <span style="color:red;font-size:150%;">inline HTML</span> 413</html> 414<HTML> 415<p style="border:2px dashed red;">And this is some block HTML</p> 416</HTML> 417</code> 418 419<html> 420This is some <span style="color:red;font-size:150%;">inline HTML</span> 421</html> 422<HTML> 423<p style="border:2px dashed red;">And this is some block HTML</p> 424</HTML> 425 426PHP example: 427 428<code> 429<php> 430echo 'A logo generated by PHP:'; 431echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; 432echo '(generated inline HTML)'; 433</php> 434<PHP> 435echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 436echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>'; 437echo '</tr></table>'; 438</PHP> 439</code> 440 441<php> 442echo 'A logo generated by PHP:'; 443echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; 444echo '(inline HTML)'; 445</php> 446<PHP> 447echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 448echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>'; 449echo '</tr></table>'; 450</PHP> 451 452**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. 453 454===== RSS/ATOM Feed Aggregation ===== 455[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|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: 456 457^ Parameter ^ Description ^ 458| any number | will be used as maximum number items to show, defaults to 8 | 459| reverse | display the last items in the feed first | 460| author | show item authors names | 461| date | show item dates | 462| description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped | 463| //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | 464 465The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] 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 [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. 466 467**Example:** 468 469 {{rss>http://slashdot.org/index.rss 5 author date 1h }} 470 471{{rss>http://slashdot.org/index.rss 5 author date 1h }} 472 473 474===== Control Macros ===== 475 476Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: 477 478^ Macro ^ Description | 479| %%~~NOTOC~~%% | If this macro is found on the page, no table of contents will be created | 480| %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | 481 482===== Syntax Plugins ===== 483 484DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: 485 486~~INFO:syntaxplugins~~ 487