DokuWiki 支持一些简单的标记语言，以尽可能使文档的可读性更高。 本页包含了您在编辑页面时可能用到所有语法的说明。如果需要查看本页源码，只需要点击页面顶部或者底部的 Edit this page按钮。 如果您想试验点什么，到 playground 尽情耍吧。您也可以通过快捷按钮更方便地使用这些标记。

DokuWiki支持粗体，斜体，下划线以及等宽体等格式。当然，您可以组合使用这些格式。

DokuWiki支持**粗体**，//斜体//，__下划线__以及''等宽体''等格式。当然，您可以**__//''组合使用''//__**这些格式。

您也可以使用_下标和^上标。

您也可以使用<sub>下标</sub>和<sup>上标</sup>。

同时也可以使用删除线标记某些信息。

同时也可以使用<del>删除线</del>标记某些信息。

段落是由空行所建立的。如果您想强制换行而不建立段落，您可以使用两个连续的反斜杠接空格或换行符作为标记。请看样例：

这是一些有着换行标记的文字。
请注意 双反斜杠只在回车符之前
或者接在
一个空格之前的时候才有效。\\而这样就并不起作用。

这是一些有着换行标记的文字。\\ 请注意
双反斜杠只在回车符之前\\
或者接在\\ 一个空格之前的时候才有效。\\而这样就并不起作用。

请仅在必须的时候使用强制换行标记。

DokuWiki 支持以多种创建链接方法。

外部链接会被自动地识别： http://www.google.com 或者简单地写作 www.google.com - 您也可以设置链接文本：此链接指向google。类似这样的电子邮件地址：andi@splitbrain.org也可以被识别。

DokuWiki 支持以多种创建链接方法。外部链接会被自动地识别： http://www.google.com 或者简单地写作 www.google.com - 您也可以设置链接文本：[[http://www.google.com|此链接指向google]]。类似这样的电子邮件地址：<andi@splitbrain.org>也可以被识别。

内部链接可以用方括号创建。您可以只给出页面名，或附加链接文本。

内部链接可以用方括号创建。您可以只给出
[[页面名]]，或附加[[页面名|链接文本]]。

Wiki的页面名会被自动地转换为小写字母，并且不允许使用特殊字符。

您可以通过在页面名中添加冒号的方式来使用命名空间。

您可以通过在页面名中添加冒号的方式来使用[[某目录:命名空间]]。

如果您需要更多有关“命名空间（namespaces）”的详细信息，请参见namespaces。

链接到一个特定章节也是可能的。只需要在#号后面加上章节的名称。这是一个指向本节的链接。

这是一个指向[[syntax#内部链接|本节]]的链接。

注意：

• 指向已存在页面的和不存在页面的链接，其外观是不同的。
• 默认情况下，DokuWiki不使用CamelCase来自动建立链接。但这可以在配置文件中启用。提示：如果DokuWiki显示为链接，则说明已激活。
• 当一节的标题改变时，它的书签也会改变。因此，请不要过于依赖章节链接。

DokuWiki支持Interwiki（Wiki间链接）。他们是到其他Wiki的快速链接。例如，这是一个指向Wikipedia上Wiki条目的链接：Wiki。

DokuWiki支持[[doku>Interwiki]]（Wiki间链接）。他们是到其他Wiki的快速链接。
例如，这是一个指向Wikipedia上Wiki条目的链接：[[wp>Wiki]]。

Windows 共享文件夹，例如这个也可以被识别。请注意，这只在企业内部网等局域网环境中才有意义。

Windows共享文件夹，例如[[\\server\share|这个]]也可以被识别。

注意：

• 出于安全原因，只有在微软IE浏览器上才能够直接访问Windows共享文件夹（并且仅在“本地区域”）。
• 对于Mozilla和Firefox可以通过Mozilla知识库中提到的不同解决方法启用。但是，打开 Windows 共享文件夹时仍然会有一个JavaScript告警。要去除这个警告（为所有用户），把下面一行放入 conf/local.protected.php:

$lang['js']['nosmblinks'] = '';

您也可以通过结合链接和图像（见下文）的语法，用图像来链接到一个内部或者外部的页面。如下所示：

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

请注意：图像的格式化语法是链接文本唯一接受的格式化语法。

所有的图像 图像 和 链接 语法都是支持的 （包括图像大小调整、内部和外部的图像与链接以及wiki内链接）。

您可以使用两个连续小括号（英文）来添加脚注¹⁾。

您可以使用两个连续小括号（英文）来添加脚注((这是一个脚注))。

您可以使用多达5层的标题来组织您的内容。如果您使用了三个以上的标题，将自动生成目录 – 这可以通过在页面加入 ~~NOTOC~~ 字样来禁用。

==== 3级标题 ====
=== 4级标题 ===
== 5级标题 ==

您可以通过4个以上连续的“-”号来创建一条水平分割线：

您可以用两个大括号在页面中加入外部或内部的 图像. 您还可以指定它们的大小。

实际大小：

调整为指定宽度：

调整为指定宽度和高度²⁾：

调整外部图像大小：

实际大小：             {{wiki:dokuwiki-128.png}}
调整为指定宽度：        {{wiki:dokuwiki-128.png?50}}
调整为指定宽度和高度：   {{wiki:dokuwiki-128.png?200x50}}
调整外部图像大小：      {{http://de3.php.net/images/php.gif?200x50}}

通过使用左空格或右空格，您可以选择对齐方式。

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

当然，您也可以指定一个标题（多数浏览器显示为提示文本）。

{{ wiki:dokuwiki-128.png |这是标题}}

如果您指定的文件名（无论是外部的还是内部的）不是一个图像（gif,jpeg,png），那么它将被显示为一个链接。

对于将图像链接到其他页面，参见上面的 图像链接。

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

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.

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.

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:

• 8-)
• 8-O
• :-(
• :-)
• =)
• :-/
• :-\
• :-?
• :-D
• :-P
• :-O
• :-X
• :-|
• ;-)
• ^_^
• :?:
• :!:
• LOL
• FIXME
• DELETEME

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.

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!

DokuWiki supports a simple syntax to create tables.

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.

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.

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.

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.

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

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 %%//__this__ text// with a smiley ;-)%%.

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

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.

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

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 is the same like in the code and file blocks in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <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, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, ecmascript, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, 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, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, z80

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can to this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>

myexample.php

<?php echo "hello world!"; ?>

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

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:

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

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<p style="border:2px dashed red;">And this is some block HTML</p>

PHP example:

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>

echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(inline HTML)';

echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

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:

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.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

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:

• Cells background color plugin 2013-10-09 by dr4Ke
  Sets background of a cell with a specific color
• Definition List plugin 2017-08-17 by Chris Smith, LarsDW223
  Add syntax for definition lists.
• Definition List Plugin by Marc Wäckerlin
  HTML Definition List
• Info Plugin 2020-06-04 by Andreas Gohr
  Displays information about various DokuWiki internals
• Note Plugin 2020-06-28 by Olivier Cortès, Eric Hameleers, Christopher Smith, Aurélien Bompard, LarsDW223
  Add Note/Important/Tip/Warning Capability (DIV+CSS box)
• nspages plugin 2023-05-29 by Guillaume Turri
  Presents a toc of the selected namespace using <nspages>
• orphanswanted plugin 2023-05-30 by Doug Edmunds, Cyrille37, Federico Ariel Castagnini, Andy Webber, Matthias Schulte, Christian Paul, alexdraconian
  Display Orphans, Wanteds and Valid link tables
• Xfce Syntax Plugin 2011-12-31 by Nick Schermer
  Syntax helpers for the Xfce wikis
• Xfce Substitutions 2008-10-06 by Brian Tarricone
  Linkifies Xfce bug and SVN revision numbers