or .
This is text is indented by two spaces.
This is preformatted code all spaces are preserved: like <-this
This is pretty much the same, but you could use it to show that you quoted a file.
Those blocks were created by this source:
This is text is indented by two spaces.
This is preformatted code all spaces are preserved: like <-this
This is pretty much the same, but you could use it to show that you quoted a file.
Syntax Highlighting
DokuWiki 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. or .
/**
* The HelloWorldApp class implements an application that
* simply displays "Hello World!" to the standard output.
*/
class HelloWorldApp {
public static void main(String[] args) {
System.out.println("Hello World!"); //Display the string.
}
}
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 advanced options available for syntax highlighting, such as highlighting lines or adding line numbers.
Downloadable Code Blocks
When you use the or 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:
If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: .
Embedding HTML and PHP
You can embed raw HTML (HyperText Markup Language) or PHP code into your documents by using the or tags. (Use uppercase tags if you need to enclose block level elements.)
HTML (HyperText Markup Language) example:
This is some inline HTML
And this is some block HTML
This is some inline HTML
And this is some block HTML
PHP example:
echo 'The PHP version: ';
echo phpversion();
echo ' (generated inline HTML)';
echo 'The same, but inside a block level element: ';
echo ''.phpversion().' ';
echo '
';
The PHP version: 7.4.33 (inline HTML)
echo 'The same, but inside a block level element: ';
echo ''.phpversion().' ';
echo '
';
Please Note: HTML (HyperText Markup Language) and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
RSS/ATOM Feed Aggregation
DokuWiki 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:
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. If HTML is disabled all 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).
The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. 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 DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.
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.
Example:
{{rss>http://slashdot.org/index.rss 5 author date 1h }}
Control Macros
Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
Macro , Description
~~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 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 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:
Cloud Plugin 2022-09-28 — Michael Hamann, Michael Klier, Gina Haeussge Displays the most used words in a word cloud. discussion plugin 2021-12-31 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte Provides discussion funtionality for wiki pages Dw2Pdf plugin 2022-10-08 — Andreas Gohr and Luigi Micco DokuWiki to PDF converter epub 2011-07-1 — Myron Turner ebook creator Gallery Plugin 2021-09-11 — Andreas Gohr Creates a gallery of images from a namespace or RSS/ATOM feed Info Plugin 2020-06-04 — Andreas Gohr Displays information about various DokuWiki internals MathJax plugin 2021-11-20 — Mark Liffiton Enables MathJax (https://www.mathjax.org/) parsing of TeX math expressions in wiki pages Note Plugin 2020-06-28 — Olivier Cortès, Eric Hameleers, Christopher Smith, Aurélien Bompard, LarsDW223 Add Note/Important/Tip/Warning Capability (DIV+CSS box) Pagelist Plugin 2022-09-28 — Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge Lists pages in a nice formatted way Tag Plugin 2022-10-02 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner tag wiki pages Video Sharing Site Plugin 2022-02-03 — Andreas Gohr Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}} Wrap Plugin 2022-08-10 — Anika Henke Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
1) This is a footnote
2) 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