meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
wiki:syntax [2017/04/24 14:42] – superadminwiki:syntax [2025/10/31 09:00] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
-====== Syntax ======+====== Formatting Syntax ======
  
-[[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.+[[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 "Edit this 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.
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
Line 19: Line 19:
  
 **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. **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.
 +
 +This is some text with some linebreaks\\ Note that the
 +two backslashes are only recognized at the end of a line\\
 +or followed by\\ a whitespace \\this happens without it.
 +
 +  This is some text with some linebreaks\\ Note that the
 +  two backslashes are only recognized at the end of a line\\
 +  or followed by\\ a whitespace \\this happens without it.
  
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
  
 ===== Links ===== ===== Links =====
 +
 +DokuWiki supports multiple ways of creating links.
  
 ==== External ==== ==== External ====
Line 28: Line 38:
 External 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. External 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.
  
-  You can set link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.+  DokuWiki supports multiple ways of creating links. External links are recognized 
 +  automagically: http://www.google.com or simply www.google.com - You can set 
 +  link text as well: [[http://www.google.com|This Link points to google]]. Email 
 +  addresses like this one: <andi@splitbrain.org> are recognized, too.
  
 ==== Internal ==== ==== Internal ====
  
-Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]], [[some:namespaces]] are allowed too.+Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].
  
   Internal links are created by using square brackets. You can either just give   Internal links are created by using square brackets. You can either just give
-  a [[pagename]] or use an additional [[pagename|link text]], [[some:namespaces]] are allowed too..+  a [[pagename]] or use an additional [[pagename|link text]].
  
 [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
  
-Linking to a specific section is possible. Add the section name behind a hash character as known from HTML. This links to [[syntax#internal|this Section]].+You can use [[some:namespaces]] by using a colon in the pagename. 
 + 
 +  You can use [[some:namespaces]] by using a colon in the pagename. 
 + 
 +For details about namespaces see [[doku>namespaces]]. 
 + 
 +Linking 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]].
  
   This links to [[syntax#internal|this Section]].   This links to [[syntax#internal|this Section]].
Line 46: Line 65:
  
   * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.   * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.
 +  * 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.
 +  * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
 +
 +==== Interwiki ====
 +
 +DokuWiki 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]].
 +
 +  DokuWiki 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]].
  
 ==== Windows Shares ==== ==== Windows Shares ====
  
-Windows shares like [[\\server\share|this]] are recognized. Please note that these only make sense in a homogeneous user group like a corporate [[wp>Intranet]].+Windows 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]].
  
   Windows Shares like [[\\server\share|this]] are recognized, too.   Windows Shares like [[\\server\share|this]] are recognized, too.
Line 64: Line 92:
 $lang['js']['nosmblinks'] = ''; $lang['js']['nosmblinks'] = '';
 </code> </code>
 +
 +==== Image Links ====
 +
 +You 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:
 +
 +  [[http://php.net|{{wiki:dokuwiki-128.png}}]]
 +
 +[[http://php.net|{{wiki:dokuwiki-128.png}}]]
 +
 +Please note: The image formatting is the only formatting syntax accepted in link names.
 +
 +The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
  
 ===== Footnotes ===== ===== Footnotes =====
Line 97: Line 137:
 Resize 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}} Resize 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}}
  
-Resized external image:           {{http://php.net/images/php.gif?200x50}}+Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
   Real size:                        {{wiki:dokuwiki-128.png}}   Real size:                        {{wiki:dokuwiki-128.png}}
   Resize to given width:            {{wiki:dokuwiki-128.png?50}}   Resize to given width:            {{wiki:dokuwiki-128.png?50}}
   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
-  Resized external image:           {{http://php.net/images/php.gif?200x50}}+  Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
  
Line 181: Line 221:
  
 Also take a look at the [[doku>faq:lists|FAQ on list items]]. Also take a look at the [[doku>faq:lists|FAQ on list items]].
 +
 +===== Text Conversions =====
 +
 +DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
 +
 +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.
 +
 +==== Text to Image Conversions ====
 +
 +DokuWiki 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:
 +
 +  * 8-) %%  8-)  %%
 +  * 8-O %%  8-O  %%
 +  * :-( %%  :-(  %%
 +  * :-) %%  :-)  %%
 +  * =)  %%  =)   %%
 +  * :-/ %%  :-/  %%
 +  * :-\ %%  :-\  %%
 +  * :-? %%  :-?  %%
 +  * :-D %%  :-D  %%
 +  * :-P %%  :-P  %%
 +  * :-O %%  :-O  %%
 +  * :-X %%  :-X  %%
 +  * :-| %%  :-|  %%
 +  * ;-) %%  ;-)  %%
 +  * ^_^ %%  ^_^  %%
 +  * m(  %%  m(   %%
 +  * :?: %%  :?:  %%
 +  * :!: %%  :!:  %%
 +  * LOL %%  LOL  %%
 +  * FIXME %%  FIXME %%
 +  * DELETEME %% DELETEME %%
  
 ==== Text to HTML Conversions ==== ==== Text to HTML Conversions ====
Line 346: Line 418:
 </code> </code>
  
-The 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//+The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic// 
 + 
 +There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.
  
 ==== Downloadable Code Blocks ==== ==== Downloadable Code Blocks ====
Line 364: Line 438:
 If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
  
 +===== RSS/ATOM Feed Aggregation =====
 +[[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:
  
-===== Embedding HTML and PHP =====+^ Parameter  ^ Description ^ 
 +| any number | will be used as maximum number items to show, defaults to 8 | 
 +| reverse    | display the last items in the feed first | 
 +| author     | show item authors names | 
 +| date       | show item dates | 
 +| description| show the item description. All HTML tags will be stripped | 
 +| nosort     | do not sort the items in the feed | 
 +| //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
  
-You 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.)+The 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.
  
-HTML example:+By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''.
  
-<code> +**Example:**
-<html> +
-This is some <span style="color:red;font-size:150%;">inline HTML</span> +
-</html> +
-<HTML> +
-<p style="border:2px dashed red;">And this is some block HTML</p> +
-</HTML> +
-</code>+
  
-<html> +  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
-This is some <span style="color:red;font-size:150%;">inline HTML</span> +
-</html> +
-<HTML> +
-<p style="border:2px dashed red;">And this is some block HTML</p> +
-</HTML>+
  
-PHP example:+{{rss>http://slashdot.org/index.rss 5 author date 1h }}
  
-<code> 
-<php> 
-echo 'The PHP version: '; 
-echo phpversion(); 
-echo ' (generated inline HTML)'; 
-</php> 
-<PHP> 
-echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 
-echo '<td>'.phpversion().'</td>'; 
-echo '</tr></table>'; 
-</PHP> 
-</code> 
- 
-<php> 
-echo 'The PHP version: '; 
-echo phpversion(); 
-echo ' (inline HTML)'; 
-</php> 
-<PHP> 
-echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 
-echo '<td>'.phpversion().'</td>'; 
-echo '</tr></table>'; 
-</PHP> 
- 
-**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. 
  
 ===== Control Macros ===== ===== Control Macros =====
Line 422: Line 468:
 | %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created | | %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created |
 | %%~~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 | | %%~~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 |
 +
 +===== Syntax Plugins =====
 +
 +DokuWiki'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:
 +
 +~~INFO:syntaxplugins~~
 +