Formatting Syntax

this can be disabled by including the string ''~~NOTOC~~'' in the document.

Headline Level 3

Headline Level 4

Headline Level 5

Headline Level 3

Headline Level 4

Headline Level 5

By using four or more dashes, you can make a horizontal line:

Images and Other Files

You can include external and internal doku>images with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

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)):

Resized external image:

Real size:

Resize to given width:

Resize to given width and height:

Resized external image:

By using left or right whitespaces you can choose the alignment.

Of course, you can add a title (displayed as a tooltip by most browsers), too.

If you specify a filename (external or internal) that is not an image (''gif, jpeg, png''), then it will be displayed as a link instead.

For linking an image to another page see #Image Links above.

Indentation

Indenting lines may be accomplished by using Lists or Code Blocks (see below), or by forcing extra spaces to appear to the left of the text (as seen on our Index page).

Unlike most other text editors, you cannot simply press the Tab or Spacebar to indent text at the left margin. Pressing the Tab key has no effect, pressing the Spacebar once has no effect, while pressing it twice turns any following text into a Code Block. The only way of inserting one or more extra spaces is to force them to appear by inserting Non-Breaking SPaces (abbreviated to NBSP) when you really need them. To do this, press Alt+255 as follows. Holding down the Alt key, press 2,5,5 on the Numerical Keypad (number pad), usually located to the right of your main keyboard, then release the Alt key. On releasing the Alt key a NBSP will appear. E.g., typing

Line 1

[Alt+255][Alt+255]Line 2

displays as

Line 1

  Line 2

Unfortunately NBSPs cannot be copied & pasted from one part of a Wiki to another. They must be added individually each time. Thus, if you notice that your previously two-space indented line now appears as a Code Block, you should delete the spaces to the left of the text and reinsert two NBSP as described above. Any improvement to this rather primitive feature would be welcome.

Lists

Dokuwiki 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.

• This is a list
• The second item
• You may have different levels
• Another item

- The same list but ordered

- Another item

- Just use indention for deeper levels

- That's it

Also take a look at the 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 %%
• :-
  ;-) %% ;-) %%
  :?: %% :?: %%
  :!: %% :!: %%
  LOL %% LOL %%
  FIXME %% FIXME %%
  DELETEME %% DELETEME %%

  %% :-	%%
  _	%%	_	%%

  Text to HTML Conversions

  Typography: DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

  -> <- <-> => <= <=> >> <<

• 640x480 (c) (tm) (r)

  "He thought 'It's a man's world'..."

  -> <- <-> => <= <=> >> <<

• 640x480 (c) (tm) (r)

  "He thought 'It's a man's world'..."

  The same can be done to produce any kind of HTML, it just needs to be added to the pattern file .

  There 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 config option .

  Quoting

  Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

  I think we should do it

  > No we shouldn't

  >> Well, I say we should

  > Really?

  >> Yes!

  >>> Then lets do it!

  I think we should do it

  > No we shouldn't

  >> Well, I say we should

  > Really?

  >> Yes!

  >>> Then lets do it!

  Tables

  DokuWiki supports a simple syntax to create tables.

  Heading 1	Heading 2	Heading 3
  Row 1 Col 1	Row 1 Col 2	Row 1 Col 3
  Row 2 Col 1	some colspan (note the double pipe)
  Row 3 Col 1	Row 3 Col 2	Row 3 Col 3

  Table rows have to start and end with a ''

  '' for normal rows or a ''	'' for headers.

  Heading 1	Heading 2	Heading 3
  Row 1 Col 1	Row 1 Col 2	Row 1 Col 3
  Row 2 Col 1	some colspan (note the double pipe)
  Row 3 Col 1	Row 3 Col 2	Row 3 Col 3

  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!

  Vertical tableheaders are possible, too.

  	Heading 1	Heading 2
  Heading 3	Row 1 Col 2	Row 1 Col 3
  Heading 4	no colspan this time
  Heading 5	Row 2 Col 2	Row 2 Col 3

  As you can see, it's the cell separator before a cell which decides about the formatting:

  	Heading 1	Heading 2
  Heading 3	Row 1 Col 2	Row 1 Col 3
  Heading 4	no colspan this time
  Heading 5	Row 2 Col 2	Row 2 Col 3

  You can have rowspans (vertically connected cells) by adding '':::'' into the cells below the one to which they should connect.

  Heading 1	Heading 2	Heading 3
  Row 1 Col 1	this cell spans vertically	Row 1 Col 3
  Row 2 Col 1	:::	Row 2 Col 3
  Row 3 Col 1	:::	Row 2 Col 3

  Apart from the rowspan syntax those cells should not contain anything else.

  Heading 1	Heading 2	Heading 3
  Row 1 Col 1	this cell spans vertically	Row 1 Col 3
  Row 2 Col 1	:::	Row 2 Col 3
  Row 3 Col 1	:::	Row 2 Col 3

  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.

  Table with alignment
  right	center	left
  left	right	center
  xxxxxxxxxxxx	xxxxxxxxxxxx	xxxxxxxxxxxx

  This is how it looks in the source:

  Table with alignment
  right	center	left
  left	right	center
  xxxxxxxxxxxx	xxxxxxxxxxxx	xxxxxxxxxxxx

  Note: Vertical alignment is not supported.

  No Formatting

  If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%%%'' tags or even simpler, with double percent signs ''%%''.

  This is some text which contains addresses like this: http:www.splitbrain.org and formatting, but nothing is done with it.

  The same is true for %%this text with a smiley ;-)%%.

  This is some text which contains addresses like this: http:www.splitbrain.org and formatting, but nothing is done with it.

  The same is true for %%this text with a smiley ;-)%%.

  Code Blocks

  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 ''%%%%'' 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

  wiki: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, 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

  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 or PHP code into your documents by using the ''%%%%'' or ''%%%%'' tags. (Use uppercase tags if you need to enclose block level elements.)

  HTML 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 'A logo generated by PHP:';

  echo '';

  echo '(generated inline HTML)';

  echo '

  ';

  echo '

  ';

  echo '

  The same, but inside a block level element:

  ';

  echo 'A logo generated by PHP:';

  echo '';

  echo '(inline HTML)';

  echo '

  ';

  echo '

  ';

  echo '

  The same, but inside a block level element:

  ';

  Please Note: HTML 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
  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. 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.

  Example:

  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:

  ~~INFO:syntaxplugins~~

  ---

  Last edited by GeoffM on 15/09/2016 at 03:01