Table of Contents

MSyntax

Example First, then Code

Datatables

<datatables>

Column A Column B Column C
Row A1 Row B1 Row C1
Row A2 Row B2 Row C2
Row A2 Row B2 Row C3

</datatables>

<datatables>
^ Column A ^ Column B ^ Column C ^
| Row A1   | Row B1   | Row C1   |
| Row A2   | Row B2   | Row C2   |
| Row A2   | Row B2   | Row C3   |
</datatables>

https://www.dokuwiki.org/plugin:datatables

Other

Lang Local https://www.dokuwiki.org/devel:localization

PageBreak

<WRAP pagebreak />


Simplebox

1
2

3
4


{{simplebox>lightgreen|size=80|content=1}}
{{simplebox>lightgray|size=80|content=2}}
{{simplebox-linebreak}}
{{simplebox>lightblue|size=80|content=3}}
{{simplebox>#ffabad|size=80|content=4}}


Font Assume - Icons

https://www.dokuwiki.org/plugin:icons
https://www.dokuwiki.org/plugin:fontawesome

{{icon>home?24&circle&padding=10px&background=#DDD&color=#CCC}}
{{fa>home|My Home}}
{{fugue>user?24}}
{{silk>anchor}}
{{flag>en}}
[[:wiki:welcome|{{fa>home?24|Welcome to DokuWiki}}]]
[[https://github.com/LotarProject/dokuwiki-plugin-icons|{{fa>github-square?24|Icons DokuWiki plugin on GitHub}}]]  

home
My Home
user
anchor
en
Welcome to DokuWiki
Icons DokuWiki plugin on GitHub

Bootstrap

<alert type=“success”>…success</alert>
<alert type=“info”>…info</alert>
<alert type=“warning”>…warning</alert>
<alert type=“danger”>…danger</alert>

<alert type="success">...</alert>
<alert type="info">...</alert>
<alert type="warning">...</alert>
<alert type="danger">...</alert>

PDF

{{pdfjs 900px,1145px> :sd:docusign_14477_w_c_st_kerman.pdf |}}
900px Wide X 1145px High


Headlines

One

Two

Three
Four
 
==== One ====
=== Two ===
== Three ==
== Four ==

Internal Comment (Text) Plugin

The text /* between the slash-asterisk and asterisk-slash */ is hidden

The text /* between the slash-asterisk and asterisk-slash */ is hidden


Embed Image from URL
https://www.dokuwiki.org/images#image_links




[[http://www.google.com|{{wiki:dokuwiki-128.png}}]]


LINK FROM HOSTED IMAGE

[[http://www.google.com|{{https://srvr2020.com/img/0812-125236.png}}]]

BlogLinkClipper - Chrome Web Store

Is there a way to bookmark articles on Wikipedia? : wikipedia

Other

Feedback

Typography Plugin

Colors - Type

COLOR HIGHLIGHTS CODE
green
blue txt / light grey bkrd
red text
blue text highlighted with yellow
text rgb
text hs1

<color green>green</color>
<color blue/lightgrey>blue txt / light grey bkrd</color>
<color #FF0000>red text</color>
<color /#FFff00>blue text highlighted with yellow</color>
<color rgb(80%,0%,0%)/rgb(100%,80%,100%)>text rgb</color>
<color hsl(120,100%,30%)/hsl(180,50%,90%)>text hs1</color>

Ref: https://www.dokuwiki.org/plugin:typography

Sizes - Type

Bold serif,
Small-caps

<typo fs:larger; fw:bold; ff:serif>Bold serif</typo>, 
<fs:large; fv:small-caps>Small-caps</fs>

Nested


There is nothing either good or bad,
but thinking makes it so.


– William Shakespeare, “Hamlet”, Act 2 scene 2

<ff:'Georgia', 'MS Serif', serif><fs:36px; lh:1.1>
There is nothing either good or bad, \\ but thinking makes it so.
</fs>\\
<fs:smaller;>//-- William Shakespeare, “Hamlet”, Act 2 scene 2//</fs></ff>



Resize to given width and height:



Resized external image:

Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image: {{https://secure.php.net/images/php.gif?200x50}}

Namespace

<nspages -simpleList -title -exclude>

<nspages -h1 -subns -exclude:start>

<nspages -simpleList -title -exclude>

<nspages -h1 -subns -exclude:start99>


-exclude:subNs:
-exclude

<nspages -h1 -simpleList -exclude:wiki: -exclude:pdi-old-now-pe: -subns -exclude>

Table within a Grid

<grid>
<col sm=“8”>

Agency/Govt c19/RH
Attractive Alternative to Home Isolation Maybe, convention center vs. hotel Always
Continuous Learning No Yes, more sites, more feedback
Staffing - Payroll
Staffing - Training
Staffing - Management

</col>
</grid>

<grid>
<col sm="8">
^                                           ^ Agency/Govt                         ^ c19/RH                          ^
| Attractive Alternative to Home Isolation  | Maybe, convention center vs. hotel  | Always                          |
| Continuous Learning                       | No                                  | Yes, more sites, more feedback  |
| Staffing - Payroll                        |                                     |                                 |
| Staffing - Training                       |                                     |                                 |
| Staffing - Management                     |                                     |                                 |
|                                           |                                     |                                 |
</col>
</grid>
<grid>
<col sm="8">
^                                           ^ Agency/Govt                         ^ c19/RH                          ^
| Attractive Alternative to Home Isolation  | Maybe, convention center vs. hotel  | Always                          |
</col>
</grid>

Typo

Size II Q

Tiny Text
Extra Small
Small
Medium
Large
X-Large
XX-Large
Smaller than default
Larger than default

QQQQ

Large
Very large
Huge

Bold serif,
Small-caps text


There is nothing either good or bad,
but thinking makes it so.


– William Shakespeare, “Hamlet”, Act 2 scene 2

Type / Color

Serif

San Serif

Red

Making the Web Beautiful!
Making the Web Beautiful!

<fs xx-small>Tiny Text</fs>
<fs x-small>Extra Small</fs>
<fs small>Small</fs>
<fs medium>Medium</fs>
<fs large>Large</fs> 
<fs x-large>X-Large</fs>
<fs xx-large>XX-Large</fs>

<fs smaller>Smaller than default</fs>
<fs larger>Larger than default</fs>


<typo font-size:large;>Large</typo> 
<typo fs:x-large>Very large</typo>
<fs:xx-large>Huge</fs>

<typo fs:larger; fw:bold; ff:serif>Bold serif</typo>, 
<fs:large; fv:small-caps>Small-caps</fs> text

<ff:'Georgia', 'MS Serif', serif><fs:36px; lh:1.1>
There is nothing either good or bad, \\ but thinking makes it so.
</fs>\\
<fs:smaller;>//-- William Shakespeare, “Hamlet”, Act 2 scene 2//</fs></ff>


==== Type / Color ====

<ff serif>Serif</ff>

<ff sans-serif>San Serif</ff>

<fc #ff0000>Red</fc>

Namespace

1 Column / Color

<alert type="success">
<nspages -title -simpleList -exclude>
</alert>
<nspages -title -exclude>
<nspages:v0 -title -exclude>

<nspages:v0 -title -exclude>

Task

<do>Task Goes here</do>
<do will_mcknight 2020-03-31>New one here</do>
<do 2020-04-08 will_mcknight>New one by toolbar</do>

{{dolist>NAMESPACE?id=ID&status=(DONE|UNDONE)&limit=COUNT&md5=MD5&user=ASSIGNEE&creator=CREATOR}}

<grid>
<col sm="8">
{{dolist>&status=(DONE|UNDONE)}}
</col>
</grid>

Footnotes

Here goes the reference[(This is a note.)].

Here goes the reference[(This is a note.)].

Q&A

??? How do I terminate a QnA block?
What if I want to put some text after the block and that text doesn't
belong to the answer?

!!! Put triple question mark at the start of a line.
???

This text is not part of the answer.

??? How do I format a question?
!!! Put triple question mark at the start of a line followed by the question title.

??? How do I terminate a QnA block?
What if I want to put some text after the block and that text doesn't
belong to the answer?

!!! Put triple question mark at the start of a line.
???

This text is not part of the answer.


??? How do I format a question?
!!! Put triple question mark at the start of a line followed by the question title.

=?

Level 1 headline

=?

Level 2 headline

=?

Level 3 headline

=?= Level 4 headline ===

~~QNA faq:installation faq:sequrity faq:usage~~

Bootstrap

https://www.dokuwiki.org/plugin:bootswrapper
http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper

Alert (x-pfd)

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/alert

<alert type=“success”>…</alert>
<alert type=“info”>…</alert>
<alert type=“warning”>…</alert>
<alert type=“danger”>…</alert>

<alert type="success">...</alert>
<alert type="info">...</alert>
<alert type="warning">...</alert>
<alert type="danger">...</alert>

Buttons

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/button

<btn type=“default”>Default</btn>
<btn type=“primary”>Primary</btn>
<btn type=“success”>Success</btn>
<btn type=“info”>Info</btn>
<btn type=“warning”>Warning</btn>
<btn type=“danger”>Danger</btn>
<btn type=“link”>Link</btn>

<btn type="default">Default</btn>
<btn type="primary">Primary</btn>
<btn type="success">Success</btn>
<btn type="info">Info</btn>
<btn type="warning">Warning</btn>
<btn type="danger">Danger</btn>
<btn type="link">Link</btn>

Callouts

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/callout

<callout type=“primary” icon=“true”> […] </callout>
<callout type=“success” icon=“true”> […] </callout>
<callout type=“info” icon=“true”> […] </callout>
<callout type=“warning” icon=“true”> […] </callout>
<callout type=“danger” icon=“true”> […] </callout>

<callout type="primary" icon="true"> 428bca [...] </callout>
<callout type="success" icon="true"> 5cb85c[...] </callout>
<callout type="info" icon="true"> [...] </callout>
<callout type="warning" icon="true"> [...] </callout>
<callout type="danger" icon="true"> d9534f [...] </callout>

<callout type=“primary”> […] </callout>
<callout type=“success”> […] </callout>
<callout type=“info”> […] </callout>
<callout type=“warning”> […] </callout>
<callout type=“danger”> […] </callout>

<callout type="primary"> [...] </callout>
<callout type="success"> [...] </callout>
<callout type="info"> [...] </callout>
<callout type="warning"> [...] </callout>
<callout type="danger"> [...] </callout>

Labels

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/label

<label type=“default”>default</label>
<label type=“primary”>primary</label>
<label type=“success”>success</label>
<label type=“info”>info</label>
<label type=“warning”>warning</label>
<label type=“danger”>danger</label>

<label type="default">default</label>
<label type="primary">primary</label>
<label type="success">success</label>
<label type="info">info</label>
<label type="warning">warning</label>
<label type="danger">danger</label>

Lead

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/lead

<lead>Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.</lead>

<lead>Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.</lead>

List Group

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/list-group

<list-group>

</list-group>

<list-group>
  * Cras justo odio
  * Dapibus ac facilisis in
  * Morbi leo risus
  * Porta ac consectetur ac
  * Vestibulum at eros
</list-group>

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/nav

<nav type=“pills”>

</nav>

<nav type="pills">
  * [[:start]]
  * [[:wiki:plugin:bootswrapper:nav|Nav Plugin]]
  * [[playground:playground]]
  * DokuWiki
    * [[:wiki:welcome]]
    * [[:wiki:syntax]]
</nav>

Panels

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/panel

<panel type=“primary” title=“Panel title”>Panel content</panel>
<panel type=“success” title=“Panel title”>Panel content</panel>
<panel type=“info” title=“Panel title”>Panel content</panel>
<panel type=“warning” title=“Panel title”>Panel content</panel>
<panel type=“danger” title=“Panel title”>Panel content</panel>

<panel type="primary" title="Panel title">Panel content</panel>
<panel type="success" title="Panel title">Panel content</panel>
<panel type="info" title="Panel title">Panel content</panel>
<panel type="warning" title="Panel title">Panel content</panel>
<panel type="danger" title="Panel title">Panel content</panel>

Progress Bars

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/progress-bar

<progress>
<bar value=“40” type=“success”></bar>
</progress>

<progress>
<bar value=“20” type=“info”></bar>
</progress>

<progress>
<bar value=“60” type=“warning”></bar>
</progress>

<progress>
<bar value=“80” type=“danger”></bar>
</progress>

<progress>
<bar value="40" type="success"></bar>
</progress>
 
<progress>
<bar value="20" type="info"></bar>
</progress>
 
<progress>
<bar value="60" type="warning"></bar>
</progress>
 
<progress>
<bar value="80" type="danger"></bar>
</progress>

Wells

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/well

<well>Look, I'm in a well!</well>
<well size=“sm”>Look, I'm in a small well!</well>
<well size=“lg”>Look, I'm in a large well!</well>

<well>Look, I'm in a well!</well>
<well size="sm">Look, I'm in a small well!</well>
<well size="lg">Look, I'm in a large well!</well>

Text

http://www.lotar.altervista.org/wiki/wiki/plugin/bootswrapper/text

Jumbotron

<jumbotron>

Hello, world!

This is a simple hero unit, a simple jumbotron-style
component for calling extra attention to featured
content or information.
</jumbotron>

<jumbotron>
===== Hello, world! =====

This is a simple hero unit, a simple jumbotron-style 
component for calling extra attention to featured
content or information.
</jumbotron>

Panel

<panel type=“default” title=“Title of Panel” subtitle=“Subtitle” icon=“fa fa-home”>
Panel content
</panel>

<panel type="default" title="Title of Panel" subtitle="Subtitle" icon="fa fa-home">
Panel content
</panel>

Alert xPDF

<alert type=“success” icon=“glyphicon glyphicon-user” dismiss=“true”>
Well done! You successfully read this important alert message.
</alert>

<alert type="success" icon="glyphicon glyphicon-user" dismiss="true">
**Well done!** You successfully read this important alert message.
</alert>

Text

Text
  * <text type="muted">muted</text>
  * <text type="primary">primary</text>
  * <text type="success">success</text>
  * <text type="info">info</text>
  * <text type="warning">warning</text>
  * <text type="danger">danger</text>

Tooltip

<tooltip title=“Sample Text” placement=“bottom”>Lorem ipsum</tooltip> dolor sit amet…

<tooltip title="Sample Text" placement="bottom">Lorem ipsum</tooltip> dolor sit amet...

Grids

<grid>
<col sm=“6”>.col-sm-6</col>
<col sm=“6”>.col-sm-6</col>
</grid>

<grid>
<col xs=“12” sm=“6” lg=“8”>.col-xs-12 .col-sm-6 .col-lg-8</col>
<col xs=“6” lg=“4”>.col-xs-6 .col-lg-4</col>
</grid>

<grid>
<col lg=“10”>

Covid19 Recovery Hotels
Others
+ Work Comp SuperFund = Back to Work
Isolate Safely for Free Like Work Comp but covers 24×7 (Federal Backing) > Confidence
Positive Expereince (Food+Stay) Wages Paid / Job Secure < Unemployment Numbers / Costs
Recovery Hotel Paid
Contact Tracing

</col>
</grid>

<grid>
<col sm="6">.col-sm-6</col>
<col sm="6">.col-sm-6</col>
</grid>

<grid>
<col xs="12" sm="6" lg="8">.col-xs-12 .col-sm-6 .col-lg-8</col>
<col xs="6" lg="4">.col-xs-6 .col-lg-4</col>
</grid>


<grid>
<col lg="10">

^ <fs large>Covid19 Recovery Hotels </fs>  \\  {{https://go.c19rh.org/assets/tLrYTFoZoi.png?80}} {{https://go.c19rh.org/assets/tIcKc13eJS.png?90}} Others    ^ <fs large><fc #ff0000>+</fc></fs>  ^ <fs large>Work Comp SuperFund</fs>  ^<fs large><fc #ff0000>=</fc></fs>    ^<fs large>Back to Work</fs>  ^
| Isolate Safely for Free         |    | Like Work Comp but covers 24x7 (Federal Backing)    |    |> Confidence    |
| Positive Expereince (Food+Stay) |    | Wages Paid / Job Secure          |    | < Unemployment Numbers / Costs               |
|                                 |    | Recovery Hotel Paid  |    |                                 |  
|                                 |    | Contact Tracing      |    |                                 |  
|                                 |    |                      |    |                                 |  


</col>
</grid>

Thumbnail

<grid>

<col xs=“6” md=“3”>
<thumbnail>

</thumbnail>
</col>

</grid>
<grid>

<col xs=“6” md=“3”>
<thumbnail>

<caption>

DokuWiki

DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.
</caption>
</thumbnail>

</col>
</grid>

Well

<well>Look, I'm in a well!</well>

Button

<button type=“success” size=“lg” icon=“glyphicon glyphicon-edit”>welcome</button>

<nav>

</nav>

Accordion

<accordion>
<panel title=“First panel”>
First panel content
</panel>
<panel title=“Second panel”>
Second panel content
</panel>
</accordion>

<accordion>
<panel title="First panel">
First panel content
</panel>
<panel title="Second panel">
Second panel content
</panel>
</accordion>

Tag

https://www.dokuwiki.org/plugin:tag

tag1 tag2 tag3
with namespaces: ns1:tag1 ns1:tag2 ns2:subns1:tag3
multiple word tags: tag1_with_multiple_words tag2 tag3_part

tag1 -tag2 – Lists all pages tagged with tag1 but not with tag2.
tag1 +tag2 – Lists all pages tagged with tag1 and tag2.
tag1 tag2 – Lists all pages tagged with either tag1 or tag2 or both.
ns1 – List all pages inside namespace ns1 tagged with either tag1 or tag2
. – List all pages inside the current namespace tagged with either tag1 or tag2
tag1 tag2 tag3&nodate&desc&sort (Adding pagelist options to change the design)

{{tag>tag1 tag2 tag3}}
with namespaces: {{tag>ns1:tag1 ns1:tag2 ns2:subns1:tag3}}
multiple word tags: {{tag>tag1_with_multiple_words tag2 tag3_part}}

{{topic>tag1 -tag2}} – Lists all pages tagged with tag1 but not with tag2.
{{topic>tag1 +tag2}} – Lists all pages tagged with tag1 and tag2.
{{topic>tag1 tag2}} – Lists all pages tagged with either tag1 or tag2 or both.
{{topic>ns1?tag1 tag2}} – List all pages inside namespace ns1 tagged with either tag1 or tag2
{{topic>.?tag1 tag2}} – List all pages inside the current namespace tagged with either tag1 or tag2
{{topic>tag1 tag2 tag3&nodate&desc&sort}} (Adding pagelist options to change the design)

Color

text
text
text
text
text
text

<color green>text</color>
<color blue/lightgrey>text</color>
<color #FF0000>text</color>
<color /#FFff00>text</color>
<color rgb(80%,0%,0%)/rgb(100%,80%,100%)>text</color>
<color hsl(120,100%,30%)/hsl(180,50%,90%)>text</color>

Namespace Listing

<nspages -simpleList -title -exclude>

<nspages -simpleList -title -exclude>

Image Links

[[:pending|{{:wiki:pending.png}}]]

Embed Image from URL

{{http://img.mch-usa.com/XlHWnvNW7f.png?600|tool-tip}}

iFrame

{{url>https://xmind.app/m/LxQ9yS/embed/EVJwXm 800px,400px noscroll noborder}}

https://xmind.app/m/LxQ9yS/embed/EVJwXm 800px,400px noscroll noborder

{{url>http://www.website.com 400px,200px noscroll noborder left|This is my iframe to w3schools}}

Highlight

<hi cyan>named cyan highlight</hi>

<hi>default highlight with some bold text</hi>

<hi #e0e>3-hex magenta highlight</hi> <hi #f30>or red</hi>

<hi cyan>named cyan highlight</hi>

<hi>default highlight with **some bold** text</hi>

<hi #e0e>3-hex magenta highlight</hi> <hi #f30>or red</hi>

Outline

–> Section 1 without preview#

Some other syntax.

–> Nested section opened^

Nested content

<–

Main content continue

<–

--> Section 1 without preview#

  * List item one

Some other syntax.

--> Nested section opened^

Nested content

<--

Main content continue

<--

Box

<box> the box contents </box> <box 80% round orange|a title> the box contents</box> <box 50% left blue>the box contents</box|a caption> <box 60% round #f99 #fc9 #fcc #f60|title>the box contents</box|caption>

<box> the box contents </box>
<box 80% round orange|a title> the box contents</box>
<box 50% left blue>the box contents</box|a caption>
<box 60% round #f99 #fc9 #fcc #f60|title>the box contents</box|caption>

<box width classes colours | title text> contents text </box>

width — any legal CSS width value
round — box will have rounded corners
blue — blue colour scheme
red — red colour scheme
green — green colour scheme
orange — orange colour scheme
left — float the box left within the wiki page
right — float the box right within the wiki page

Formatting Syntax

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 page. The simpler markup is easily accessible via quickbuttons, too.

Basic Text Formatting

DokuWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use subscript and superscript , too.

You can use <sub>subscript</sub>  and <sup>superscript</sup> , too.

You can mark something as deleted as well.

You can mark something as <del>deleted</del>  as well.

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.

DokuWiki supports multiple ways of creating links.

External

External links are recognized automagically: http://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: 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 links are created by using square brackets. You can either just give a pagename or use an additional link text.

Internal links are created by using square brackets. You can either just give
a [[pagename|]] or use an additional [[pagename|link text]].

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use 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 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 this Section.

This links to [[syntax#internal|this Section]].

Notes:

Interwiki

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: 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 like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

conf/lang/en/lang.php

<?php
/**
 * Customization of the english language file
 * Copy only the strings that needs to be modified
 */
$lang['js']['nosmblinks'] = '';

Image Links

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes 1) by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

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


Media Files

You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height2) :

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{http://php.net/images/php.gif?200x50}}

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

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

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

This is the caption

{{ wiki:dokuwiki-128.png |This is the caption}}

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

Supported Media Formats

DokuWiki can embed the following media formats directly.

Imagegif, jpg, png
Videowebm, ogv, mp4
Audioogg, mp3, wav
Flashswf

If you specify a filename that is not a supported media format, then it will be displayed as a link instead.

By adding ?linkonly you provide a link to the media without displaying it inline

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png This is just a link to the image.

Fallback Formats

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.

For example consider this embedded mp4 video:

{{video.mp4|A funny video}}

When you upload a video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.

Additionally DokuWiki supports a “poster” 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 video.jpg file would work.

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.

  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That's it
      * 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 emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:

Text to HTML Conversions

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

→ ← <→ ⇒ ⇐ <⇒» «– — 640×480 © ™ ® “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 (640×480), '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 verticallyRow 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
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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

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;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for <nowiki>//__this__ text// with a smiley;-)</nowiki>.

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

''. ''

''<code> This is text is indented by two spaces. ''

<code>
This is preformatted code all spaces are preserved: like              <-this

</code>

<file>
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. <code java> or <file java>.

/**
 * 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 rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql 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 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:<code> ''

''<file php myexample.php> <?php echo __GESHI_QUOT__hello world!__GESHI_QUOT__; ?> ''

''



<file php myexample.php>
<?php echo “hello world!”; ?>


</file>

If you don't want any highlighting but want a downloadable file, specify a dash (
-) as the language code: <code - myfile.foo>.

===== Embedding HTML and PHP =====

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

HTML example:<code>

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

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

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

</code>

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