这是本文档旧的修订版!
本页面受到保护,如需编辑请联系秋冥。
格式语法
DokuWiki 支持一些简单的标记语言,这使得数据文件尽可能具有可读性。本页面包含了您在编辑页面时可能使用的所有语法。只需按下“编辑本页”按钮查看本页的源代码即可。如果您想尝试一些操作,可以使用 游乐场 页面。更简单的标记也可以通过 快捷按钮 轻松使用。
基本文本格式
DokuWiki 支持 粗体、//斜体//、下划线 和 ''等宽体'' 文本。当然,您也可以 //''组合''// 所有这些格式。
DokuWiki 支持 粗体、斜体、下划线 和 等宽体 文本。
当然,您也可以 组合 所有这些格式。
您也可以使用 <sub>下标</sub> 和 <sup>上标</sup>。
您也可以使用 下标 和 上标。
您同样可以将某些内容标记为 <del>删除的</del>。
您同样可以将某些内容标记为 删除的。
段落 是由空行创建的。如果您想 强制换行 而不开始新段落,可以使用两个反斜杠后跟一个空格或行尾。
这是一些带有换行的文本\\ 请注意, 两个反斜杠仅在行尾被识别\\ 或者后跟\\ 一个空格 \这样操作不会产生换行。
这是一些带有换行的文本
请注意,
两个反斜杠仅在行尾被识别
或者后跟
一个空格 \这样操作不会产生换行。
您只应在真正需要时使用强制换行。
链接
DokuWiki 支持多种创建链接的方式。
外部链接
外部链接会被自动识别: http://www.google.com 或者直接写 www.google.com - 您也可以设置链接文本:[[http://www.google.com |这个链接指向谷歌]]。 像这样 <andi@splitbrain.org> 的电子邮件地址也会被识别。
DokuWiki 支持多种创建链接的方式。
外部链接会被自动识别:
或者直接写 www.google.com
- 您也可以设置 链接文本:这个链接指向谷歌。
像这样 andi@splitbrain.org 的电子邮件地址也会被识别。
内部链接
内部链接通过使用方括号创建。您可以直接给出一个 [[页面名]],或者使用带额外 [[页面名|链接文本]] 的格式。
内部链接通过使用方括号创建。您可以直接给出 一个 页面名,或者使用带额外 链接文本 的格式。
[[doku>页面名|Wiki页面名]] 会自动转换为小写,不允许使用特殊字符。
Wiki页面名 会自动转换为小写,不允许使用特殊字符。
您可以通过在页面名中使用冒号来指向 [[某个:命名空间]] 的页面。
您可以通过在页面名中使用冒号来指向 命名空间 的页面。
关于命名空间的详细信息,请参阅 namespaces。
也可以链接到特定的章节。只需在页面名后添加井号和章节名,就像 HTML 中那样。
这个链接指向 [[syntax#内部链接|本小节]]。
这个链接指向 本小节。
注意:
· 指向已有页面的链接和指向不存在页面的链接显示样式不同。 · 默认情况下,DokuWiki 不使用 CamelCase 自动创建链接,但可以在 配置文件 中启用此行为。提示:如果 DokuWiki 本身是一个链接,则表示已启用。 · 当章节标题更改时,其书签也会更改。因此,请不要过分依赖章节链接。
跨Wiki链接
DokuWiki 支持 跨Wiki 链接。这些是链接到其他 Wiki 的快捷方式。例如,这是指向维基百科上关于 Wiki 页面的链接:Wiki。
DokuWiki 支持 跨Wiki 链接。这些是链接到其他 Wiki 的快捷方式。 例如,这是指向维基百科上关于 Wiki 页面的链接:Wiki。
Windows 共享
像 这样 的 Windows 共享也会被识别。请注意,这仅在同质用户群体(如企业 内部网)中才有意义。
Windows 共享像 这样 也会被识别。
注意:
· 出于安全原因,默认情况下,只有 Microsoft Internet Explorer 能直接浏览 Windows 共享(且仅在“本地 Intranet”区域)。
· 对于 Mozilla 和 Firefox,可以通过 Mozilla 知识库 中提到的不同解决方法启用。但是,仍然会有一个关于尝试打开 Windows 共享的 JavaScript 警告。要移除这个警告(对所有用户),请在 conf/lang/en/lang.php 中加入以下代码行(更多细节请参考 本地化):
- conf/lang/en/lang.php
<?php /** * 英文语言文件的自定义 * 只复制需要修改的字符串 */ $lang['js']['nosmblinks'] = '';
图片链接
您也可以通过组合链接和 图片(见下文)的语法,使用图片链接到另一个内部或外部页面,如下所示:
[[http://php.net |{{wiki:dokuwiki-128.png}}]]
请注意:图片格式是链接名称中唯一被接受的格式语法。
脚注
您可以使用双括号添加脚注 1)。
您可以使用双括号添加脚注 ((这是一个脚注))。
章节划分
您最多可以使用五个级别的标题来组织内容。如果您有三个以上的标题,系统会自动生成一个目录——可以通过在文档中包含字符串 ~~NOTOC~~ 来禁用此功能。
三级标题
四级标题
五级标题
==== 三级标题 ==== === 四级标题 === == 五级标题 ==
使用四个或更多破折号,您可以创建一条水平线:
媒体文件
您可以使用花括号包含外部和内部的 图片、视频和音频文件。您也可以指定它们的大小。
缩放到指定宽度和高度2):
原始尺寸: {{wiki:dokuwiki-128.png}}
缩放到指定宽度: {{wiki:dokuwiki-128.png?50}}
缩放到指定宽度和高度: {{wiki:dokuwiki-128.png?200x50}}
调整大小的外部图片: {{https://www.php.net/images/php.gif?200x50 }}
通过在花括号内添加左侧或右侧的空格,您可以选择对齐方式。
{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}
当然,您也可以添加标题(大多数浏览器会将其显示为工具提示)。
{{ wiki:dokuwiki-128.png |这是说明文字}}
关于将图片链接到其他页面,请参阅上面的 图片链接。
支持的媒体格式
DokuWiki 可以直接嵌入以下媒体格式。
| 图片 | gif, jpg, png |
| 视频 | webm, ogv, mp4 |
| 音频 | ogg, mp3, wav |
| Flash | swf |
如果您指定的文件名不是受支持的媒体格式,它将被显示为一个链接。
通过添加 ?linkonly,您可以提供一个指向该媒体的链接,而不在页面中内嵌显示。
{{wiki:dokuwiki-128.png?linkonly}}
dokuwiki-128.png 这只是一个指向图片的链接。
后备格式
不幸的是,并非所有浏览器都支持所有的视频和音频格式。为解决此问题,您可以上传不同格式的文件以达到最大的浏览器兼容性。
例如,考虑这个嵌入的 mp4 视频:
{{video.mp4|一个有趣的视频}}
当您在引用的 video.mp4 旁边上传了 video.webm 和 video.ogv 文件时,DokuWiki 会自动将它们添加为备选格式,以便您的浏览器至少能理解其中一种文件格式。
此外,DokuWiki 还支持在视频开始播放前显示的“海报”图片。该图片需要与视频文件同名,并且是 jpg 或 png 格式。在上述示例中,video.jpg 文件就可以作为海报图片。
列表
DokuWiki 支持有序列表和无序列表。要创建列表项,请将您的文本缩进两个空格,并使用 * 表示无序列表,或使用 - 表示有序列表。
- 这是一个列表项
- 第二个项目
- 您可以使用不同层级
- 另一个项目
- 同样的列表但是有序的
- 另一个项目
- 使用缩进来创建更深层级
- 就这些
* 这是一个列表项
* 第二个项目
* 您可以使用不同层级
* 另一个项目
- 同样的列表但是有序的
- 另一个项目
- 使用缩进来创建更深层级
- 就这些
也可以看看 关于列表项的常见问题解答。
文本转换
DokuWiki 可以将某些预定义的字符或字符串转换为图片或其他文本或 HTML。
文本到图片的转换主要用于表情符号。而文本到 HTML 的转换用于排版替换,但也可以配置为使用其他 HTML。
文本到图片转换
DokuWiki 将常用的 表情符号 转换为其对应的图形。这些 笑脸 和其他图片可以配置和扩展。以下是 DokuWiki 中包含的笑脸概览:
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
m(
:?:
:!:
LOL
FIXME
DELETEME
文本到 HTML 转换
排版替换:DokuWiki 可以将简单的文本字符转换为其排版上正确的实体。以下是一些可识别字符的示例。
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “他认为‘这是一个男人的世界’……”
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) “他认为‘这是一个男人的世界’……”
同样的方法也可以用来生成任何类型的 HTML,只需将其添加到 模式文件 即可。
有三个例外并非来自该模式文件:乘号实体 (640×480)、'单引号' 和 “双引号”。它们可以通过 配置选项 关闭。(如有需要请联系秋冥)
引用
有时您想标记一些文本以表明它是回复或评论。您可以使用以下语法:
我认为我们应该这样做 > 不,我们不应该 >> 嗯,我说我们应该 > 真的吗? >> 是的! >>> 那我们就做吧!
我认为我们应该这样做
不,我们不应该
嗯,我说我们应该
真的吗?
是的!
那我们就做吧!
表格
DokuWiki 支持一种简单的创建表格的语法。
| 标题 1 | 标题 2 | 标题 3 |
|---|---|---|
| 行 1 列 1 | 行 1 列 2 | 行 1 列 3 |
| 行 2 列 1 | 跨列合并(注意双竖线) | |
| 行 3 列 1 | 行 3 列 2 | 行 3 列 3 |
表格行必须以 |(普通行)或 ^(表头行)开头和结尾。
^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | 行 1 列 1 | 行 1 列 2 | 行 1 列 3 | | 行 2 列 1 | 跨列合并(注意双竖线) || | 行 3 列 1 | 行 3 列 2 | 行 3 列 3 |
要水平合并单元格,只需让下一个单元格完全为空,如上所示。请确保始终拥有相同数量的单元格分隔符!
也可以使用垂直表头。
| 标题 1 | 标题 2 | |
|---|---|---|
| 标题 3 | 行 1 列 2 | 行 1 列 3 |
| 标题 4 | 这次没有跨列 | |
| 标题 5 | 行 2 列 2 | 行 2 列 3 |
如您所见,决定格式的是单元格前面的分隔符:
| ^ 标题 1 ^ 标题 2 ^ ^ 标题 3 | 行 1 列 2 | 行 1 列 3 | ^ 标题 4 | 这次没有跨列 | | ^ 标题 5 | 行 2 列 2 | 行 2 列 3 |
您可以通过在需要垂直连接的下方单元格中添加 ::: 来实现垂直合并单元格(跨行)。
| 标题 1 | 标题 2 | 标题 3 |
|---|---|---|
| 行 1 列 1 | 这个单元格垂直跨行 | 行 1 列 3 |
| 行 2 列 1 | 行 2 列 3 | |
| 行 3 列 1 | 行 2 列 3 |
除了跨行语法外,这些单元格不应包含其他任何内容。
^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | 行 1 列 1 | 这个单元格垂直跨行 | 行 1 列 3 | | 行 2 列 1 | ::: | 行 2 列 3 | | 行 3 列 1 | ::: | 行 2 列 3 |
您也可以对齐表格内容。只需在文本的相反一端添加至少两个空格:在左侧添加两个空格实现右对齐,在右侧添加两个空格实现左对齐,在两端至少各添加两个空格实现居中对齐。
| 带对齐的表格 | ||
|---|---|---|
| 右对齐 | 居中对齐 | 左对齐 |
| 左对齐 | 右对齐 | 居中对齐 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
在源代码中是这样的:
^ 带对齐的表格 ^^^ | 右对齐| 居中对齐 |左对齐 | |左对齐 | 右对齐| 居中对齐 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
注意:不支持垂直对齐。
无格式设置
如果您需要完全按照输入的方式显示文本(没有任何格式),可以用 <nowiki> 标签括起该区域,或者更简单地,使用双百分号 %%。
这是一些包含地址(如:http://www.splitbrain.org)和 **格式** 的文本,但不会对其进行任何处理。 对于 //__这段__文本// 和一个笑脸 ;-) 也是如此。
<nowiki> 这是一些包含地址(如:http://www.splitbrain.org)和 **格式** 的文本,但不会对其进行任何处理。 </nowiki> 对于 %%//__这段__文本// 和一个笑脸 ;-)%% 也是如此。
代码块
您可以通过将代码缩进至少两个空格(如之前的示例所示),或者使用 <code> 或 <file> 标签,将代码块包含到文档中。
这段文本缩进了两个空格。
这是预格式化的代码,所有空格都被保留:比如 <-这里
这与上面基本相同,但您可以用它来表明您引用了文件。
这些块是通过以下源代码创建的:
这段文本缩进了两个空格。
<code> 这是预格式化的代码,所有空格都被保留:比如 <-这里 </code>
<file> 这与上面基本相同,但您可以用它来表明您引用了文件。 </file>
语法高亮
DokuWiki 可以对源代码进行高亮显示,使其更易于阅读。它使用 GeSHi 通用语法高亮器——因此 GeSHi 支持的任何语言都受支持。语法使用前一节中描述的相同的 code 和 file 块,但这次需要在标签内包含要高亮的语言名称,例如 <code java> 或 <file java>。
/** * HelloWorldApp 类实现了一个应用程序, * 简单地在标准输出中显示“Hello World!”。 */ class HelloWorldApp { public static void main(String[] args) { System.out.println("Hello World!"); // 显示字符串。 } }
当前可识别的语言字符串有: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
关于语法高亮,还有更多 高级选项 可用,例如高亮特定行或添加行号。
可下载代码块
当您像上面那样使用 <code> 或 <file> 语法时,您可能希望让显示的代码也可以下载。您可以通过在语言代码后指定文件名来实现,如下所示:
<file php myexample.php> <?php echo "hello world!"; ?> </file>
- myexample.php
<?php echo "hello world!"; ?>
如果您不希望任何高亮显示,但需要一个可下载的文件,请在语言代码处指定一个短横线 (-):<code - myfile.foo>。
RSS/ATOM 源聚合
DokuWiki 可以集成来自外部 XML 源的数据。解析 XML 源使用的是 SimplePie。SimplePie 能理解的所有格式都可以在 DokuWiki 中使用。您可以通过多个额外的空格分隔参数来影响渲染效果:
| 参数 | 描述 |
|---|---|
| 任意数字 | 用作显示的最大条目数,默认为 8 |
| reverse | 先显示源中最旧的条目 |
| author | 显示条目作者姓名 |
| date | 显示条目日期 |
| description | 显示条目描述。所有 HTML 标签将被剥离 |
| nosort | 不对源中的条目进行排序 |
| n[dhm] | 刷新周期,d=天,h=小时,m=分钟。(例如 12h = 12 小时)。 |
刷新周期默认为 4 小时。任何低于 10 分钟的值都将被视为 10 分钟。DokuWiki 通常会尝试提供页面的缓存版本,显然当页面包含动态外部内容时这不合适。该参数告诉 DokuWiki,如果页面自上次渲染以来超过了 刷新周期,则重新渲染页面。
默认情况下,源将按日期排序,最新的在前。您可以使用 reverse 参数按最旧的在前排序,或者使用 nosort 按原样显示源。
示例:
- Artemis II Astronauts Pass 100,000 Miles From Earth On Voyage To the Moon 由 BeauHD (2026/04/04 14:00)
- 'AI' Is Coming For Your Online Gaming Servers Next 由 BeauHD (2026/04/04 10:30)
- Iran Strikes Leave Amazon Availability Zones 'Hard Down' In Bahrain and Dubai 由 BeauHD (2026/04/04 06:00)
- Microsoft To Invest $10 Billion In Japan For AI, Cyber Defense Expansion 由 BeauHD (2026/04/04 05:00)
- Netflix Must Refund Customers For Years of Price Hikes, Italian Court Rules 由 BeauHD (2026/04/04 04:00)
- Artemis II Astronauts Pass 100,000 Miles From Earth On Voyage To the Moon 由 BeauHD (2026/04/04 14:00)
- 'AI' Is Coming For Your Online Gaming Servers Next 由 BeauHD (2026/04/04 10:30)
- Iran Strikes Leave Amazon Availability Zones 'Hard Down' In Bahrain and Dubai 由 BeauHD (2026/04/04 06:00)
- Microsoft To Invest $10 Billion In Japan For AI, Cyber Defense Expansion 由 BeauHD (2026/04/04 05:00)
- Netflix Must Refund Customers For Years of Price Hikes, Italian Court Rules 由 BeauHD (2026/04/04 04:00)
控制宏
某些语法影响 DokuWiki 渲染页面的方式,但本身不产生任何输出。以下控制宏可用:
| 宏 | 描述 |
|---|---|
| ~~NOTOC~~ | 如果在页面上找到此宏,则不会创建目录 |
| ~~NOCACHE~~ | 默认情况下,DokuWiki 会缓存所有输出。有时这可能是不希望的(例如,当使用了上面的 <php> 语法时),添加此宏将强制 DokuWiki 在每次调用时重新渲染页面 |
语法插件
DokuWiki 的语法可以通过 插件 进行扩展(如有需要请联系秋冥增加插件)。已安装插件的使用方法在其相应的描述页面上有说明。
本服务器中可用的语法插件如下:
- Add New Page plugin 2025-09-21 由 Damien Regad, Benjamin Santalucia, Sam Wilson and other contributors
Adds a "new page form" to any wiki page. - Box Plugin 2022-08-16 由 Christopher Smith
Boxes with titles, colour and rounded corners. Syntax: <box width class colours|title> ... </box|caption> width, class, colours title & caption are optional. The title can include some wiki markup, the box contents can include almost any wiki markup. - Cloud Plugin 2023-02-11 由 Michael Hamann, Michael Klier, Gina Haeussge
Displays the most used words in a word cloud. - Condition plugin 2026-01-21 由 Etienne Meleard, Gerry Weißbach / i-net software
render a block if a condition if fullfilled, user custom tests can be easily added - discussion plugin 2025-07-04 由 Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages - folded plugin 2023-07-22 由 Michael Hamann, Fabian van-de-l_Isle, Christopher Smith, Esther Brunner
Foldable page sections - Gallery Plugin 2024-04-30 由 Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed - Group Manager Syntax plugin 2013-05-26 由 Harald Ronge
Embeddable group manager, based on groupmgr from Alex Forencich and usermanager from Christopher Smith - include plugin 2025-07-22 由 Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page - Indexmenu Plugin 2024-01-05 由 Samuele Tognini, Gerrit Uitslag
Show a customizable and sortable index for a namespace - nspages plugin 2024-11-22 由 Guillaume Turri
Presents a toc of the selected namespace using <nspages> - Pagelist Plugin 2023-08-27 由 Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way - PageQuery Plugin 2025-03-04 由 Mark C. Prins, previously Symon Bent
Search for (fulltext) and list wiki pages, sorted and optionally grouped by name, date, creator, abc, etc. in columns. Insert the pagequery markup wherever you want your list to appear. E.g.{{pagequery>[query;fulltext;sort=key:direction,key2:direction;group;limit=??;cols=?;inwords;proper]}} [..] = optional - Tag Plugin 2023-10-17 由 Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - Wrap Plugin 2023-08-13 由 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.


