Table of Contents
====== 格式化语法
数据文件支持一些简单的标记语言,以尽可能提高数据文件的可读性。本页包含编辑页面时可能用到的所有语法。只需点击 “编辑本页”,即可查看本页的源代码。如果您想尝试一下,只需使用======DokuWiki playground 页面。通过 quickbuttons 也可以轻松访问更简单的标记。
基本文本格式
DokuWiki 支持 粗体, 斜体, 下划线和 单倍行距文本。当然,您可以 组合所有这些。
DokuWiki 支持 **粗体**, //斜体//, __下划线__和 ''单倍行距''文本。 当然,您可以 **__//''组合''//__**所有这些。
您可以使用 下标和 上标。
您可以使用 <sub>下标</sub>和 <sup>上标</sup>。
您可以将某些内容标记为 删除也可以。
您可以将某些内容标记为 <del>已删除</del>也可以。
段落由空行创建。如果要 强制换行可以使用两个反斜线,然后是空格或行尾。
这是一些带有换行符的文本\\注意
两个反斜线只在行尾被识别
或后面的\\空格 \\如果没有空格,就会出现这种情况。
下面是一些带有分隔符的文本\\请注意 两个反斜线只在行尾被识别\\ 或后面的\\空格 \\如果没有空格,就会出现这种情况。
只有在确实需要的情况下,才能使用强制换行符。
链接
DokuWiki 支持多种创建链接的方法。
外部链接
外部链接会自动识别: http://www.google.com或直接 www.google.com - 您还可以设置链接文本: This链接指向 google 。像这样的电子邮件地址 andi@splitbrain.org也能识别。
DokuWiki 支持多种创建链接的方式。外部链接 自动识别: http://www.google.com或直接 www.google.com - 您还可以设置 链接文本: [[http://www.google.com|This</ignore>链接指向谷歌<ignore>]] 。电子邮件 像这样的地址: <[email protected]>也能被识别。
内部
使用方括号可创建内部链接。您可以直接给出<ignore>pagename</ignore> ,也可以使用额外的 链接文本 。
使用方括号创建内部链接。您可以只给出 [[wiki:pagename ]] 或使用额外的 [[wiki:pagename|链接文本]] 。
维基页面名 会自动转换为小写,不允许使用特殊字符。
您可以在页根名中使用冒号来使用namespaces 。
通过在页根名中使用冒号,可以使用[[some:namespaces]] 。
有关命名空间的详细信息,请参阅namespaces 。
也可以链接到特定部分。只需在 HTML 所用的哈希字符后面添加章节名称即可。链接到 本节 。
此链接至 [[zh:wiki:syntax#internal|本节]] 。
注释:
- 链接到 基本文本格式 的链接与nonexisting 的链接风格不同。
- 当章节标题发生变化时,其书签也会随之变化。因此不要过于依赖章节链接。
跨维基
DokuWiki 支持Interwiki 链接。这些是指向其他维基的快速链接。例如,这是指向维基百科有关维基页面的链接:Wiki 。
DokuWiki 支持[[doku>Interwiki]] 链接。这些是指向其他维基的快速链接。 例如,这是维基百科关于维基的页面链接:[[wp>Wiki]] 。
Windows 共享
Windows 共享 这样的 也能被识别。请注意,只有在同质用户组(如企业Intranet )中,这些共享才有意义。
这样的 Windows 共享 [[\\server\share|这样的 Windows 共享]] 也能被识别。
备注:
- 出于安全考虑,直接浏览 Windows 共享默认情况下仅适用于 Microsoft Internet Explorer(且仅适用于 “本地区域”)。
- 对于 Mozilla 和 Firefox,可通过知识库 中提到的不同解决方法启用。 Mozilla</ignore>知识库<ignore> 。不过,在尝试打开 Windows 共享时仍会出现 JavaScript 警告。要删除此警告(适用于所有用户),请在
conf/lang/en/lang.php 中加入以下一行(更多详情请访问 <ignore></ignore>本地化 ):- conf/lang/en/lang.php
<?php /** * Customization of the english language file * Copy only the strings that needs to be modified */ $lang['js']['nosmblinks'] = '';
图片链接
您也可以使用图像链接到另一个内部或外部页面,方法是将链接和 图像 (见下文):
[[http://php.net|{{wiki:dokuwiki-128.png}}]]
请注意:图片格式是链接名称中唯一可接受的格式语法。
脚注
您可以使用双括号添加脚注((这是一个脚注))。
您可以使用双圆括号添加脚注((这是一个脚注))。
分节
您最多可以使用五个不同级别的标题来组织内容。如果有三个以上的标题,就会自动生成目录–可以通过包含字符串 ~~NOTOC~~字符串来禁用。
三级标题
标题级别 4
第 5 级标题
==== 标题第 3 级==== === 第 4 级标题=== == 第 5 级标题==
通过使用四个或更多破折号,您可以画出一条水平线:
媒体文件
您可以将外部和内部 图片、视频和音频文件 。您还可以指定这些文件的大小。
按给定的宽度和高度调整大小((当给定的宽度和高度的宽高比与图像的宽高比不一致时,将在调整大小前将图像裁剪为新的比例)):
真实尺寸: {{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 |这是标题}}
关于将图片链接到其他页面,请参阅Image Links 。
支持的媒体格式
DokuWiki 可以直接嵌入以下媒体格式。
| 图片 | gif, jpg, png |
| 视频 | webm, ogv, mp4 |
| 音频 | ogg, mp3, wav |
| Flash | swf |
如果指定的文件名不属于支持的媒体格式,则会以链接形式显示。
通过添加 链接就可以提供媒体链接,而不显示在行内
dokuwiki-128.png 这只是指向图片的链接。
后备格式
遗憾的是,并非所有浏览器都能理解所有视频和音频格式。为了缓解这一问题,您可以上传不同格式的文件,以获得最大的浏览器兼容性。
例如,请看这段嵌入式 mp4 视频:
{{wiki:video.mp4|有趣的视频}}
当您上传 视频和 视频.ogv和 视频.mp4,DokuWiki 就会自动将它们添加为替代文件,这样您的浏览器就能理解这三个文件中的一个。
此外,DokuWiki 还支持在视频开始前显示 “海报 “图片。该图片需要与视频的文件名相同,并且是 jpg 或 png 文件。在上面的示例中 video.jpg文件即可。
列表
Dokuwiki 支持有序和无序列表。要创建列表项,请将文本缩进两个空格,并使用 *或 -表示有序列表。
- 这是一个列表
- 第二个项目
- 你可以有不同的层次
- 另一项
- 同一列表,但已排序
- 另一个项目
- 使用缩进表示更深的层次
- 就是这样
* 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
还可以查看 关于清单项目的常见问题 。
文本转换
DokuWiki 可以将某些预定义的字符或字符串转换为图像或其他文本或 HTML。
文本到图片的转换主要用于表情符号。文本到 HTML 的转换用于排版替换,但也可配置为使用其他 HTML。
文本到图片的转换
DokuWiki 可将常用的emoticon s 转换为相应的图形。这些Smileys 和其他图片可以进行配置和扩展。以下是 DokuWiki 中包含的微笑图的概述:
8-)
8-O
:-(
:-) * ) *=)
* * *
:-/ * *
:-\ * * *:-?
*
:-D * *:-P
*
:-O * *:-X
* :- * :-|
*;-)
* _ *^_^
*m(
*:?:
*:!:
*
LOL
FIXME * *DELETEME
==== 文本到 HTML 的转换==== 排版:[[zh:wiki:dokuwiki]] 可以将简单的文本字符转换为排版正确的实体。下面是一个识别字符的示例。 -> <- <->=> <= <=>>> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..." <code> -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..." </code> 同样的方法可以生成任何类型的 HTML,只需将其添加到 [[doku>entities|模式文件]] 。 有三种例外情况并非来自模式文件:乘法实体(640x480)、"单引号 "和 "双引号"。可以通过 [[doku>config:typography|配置选项关闭它们]] 。 ===== 引用===== 有时,您想标记一些文本以显示它是回复或评论。您可以使用以下语法: <code> I think we should do it > No we shouldn't >> Well, I say we should > Really? >> Yes! >>> Then lets do it! </code> 我认为我们应该这样做 > 不应该 >> 好吧,我说我们应该 > 真的吗? >> 是的! >> 那我们就开始吧! ===== 桌子===== DokuWiki 支持创建表格的简单语法。 ^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | 第 1 行 Col 1 | 第 1 行第 2 列 | 第 1 行 Col 3 | | 第 2 行 Col 1 | 一些 colspan(注意双管)|| | 第 3 行 Col 1 | 第 3 行 Col 2 | 第 3 行 Col 3 | 表格行必须以 ''|''开始和结束,普通行以 ''^''作为标题。 ^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | 第 1 行 Col 1 | 第 1 行第 2 列 | 第 1 行第 3 栏 | | 第 2 行 Col 1 | 一些 colspan(注意双管)|| | 第 3 行 Col 1 | 第 3 行 Col 2 | 第 3 行 Col 3 | 如上图所示,要横向连接单元格,只需让下一个单元格完全为空即可。请确保单元格分隔符的数量始终相同! 也可以使用垂直表头。 | ^ 标题 1 ^ 标题 2 ^ ^ 标题 3 | 第 1 行 Col 2 | 第 1 行 Col 3 | ^ 标题 4 | 此次无 colspan | | ^ 标题 5 | 第 2 行 Col 2 | 第 2 行 Col 3 | 如你所见,决定格式的是单元格前的单元格分隔符: | ^ 标题 1 ^ 标题 2 ^ ^ 标题 3 | 第 1 行 Col 2 | 第 1 行 Col 3 | ^ 标题 4 | 此次无 colspan | | ^ 标题 5 | 第 2 行 Col 2 | 第 2 行第 3 栏 | 通过添加 '':::''的单元格。 ^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | 第 1 行第 1 列 | 该单元格垂直横跨| 第 1 行 Col 3 | | 第 2 行 Col 1 | ::: | 第 2 行 第 3 列 | | 第 3 行 Col 1 | ::: | 第 2 行 第 3 栏 | 除了 rowspan 语法外,这些单元格不应包含任何其他内容。 ^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | 第 1 行第 1 列 | 此单元格垂直横跨| 第 1 行 Col 3 | | 第 2 行 第 1 列 | ::: | 第 2 行第 3 栏 | | 第 3 行 Col 1 | ::: | 第 2 行 第 3 栏 | 您也可以对齐表格内容。只需在文本的另一端添加至少两个空格即可:如果要右对齐,请在左侧添加两个空格;如果要左对齐,请在右侧添加两个空格;如果要居中文本,请在两端至少添加两个空格。 ^ 带对齐方式的表格 ^^^ | 右| 居中 |左 | |左 | 右| 中间 | | xxxxxxxxxx| xxxxxxxxxx| xxxxxxxxxx| 这就是源文件中的样子: ^ 带对齐方式的表格 ^^^ | 右| 居中 |左 | |左 | 右| 中间 | | xxxxxxxxxx| xxxxxxxxxx| xxxxxxxxxx| 注:不支持垂直对齐。 ===== 无格式===== 如果需要显示与输入文本完全一致的文本(不带任何格式),请用 ''%%''标记,或者更简单,用双百分号 ''<nowiki>%%
. 这是一些包含如下地址的文本: http://www.splitbrain.org和 **格式化**,但没有做任何处理。 //__文本__文本//带有笑脸;-)。 这是一些包含如下地址的文本: http://www.splitbrain.org和 **格式化**,但没有做任何处理。 //__文本__文本//带有笑脸;-)。 ===== 代码块===== 您可以在文档中加入代码块,方法是将代码块缩进至少两个空格(如前面的示例)或使用标记<code>or<file>. 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> 这些代码块由该源代码创建: 这段文字缩进了两个空格。 <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> ==== 语法高亮==== 下载 可以高亮显示源代码,使其更易于阅读。它使用 GeSHi通用语法高亮器,因此 GeSHi 支持的任何语言都能使用。语法高亮使用与上一节所述相同的代码和文件块,但这次要高亮的语言语法名称包含在标签内,例如<code java>or<file java>. <code 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. } } </code> 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<code>or<file>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 “hello world!”; ?> </file> </code> <file php myexample.php> <?php echo “hello world!”; ?> </file> 如果您不想要任何高亮显示,但想要下载文件,请指定破折号 (-) 作为语言代码:<code - myfile.foo>. ===== RSS/ATOM 订阅聚合===== 下载 可以整合来自外部 XML 源的数据。解析 XML 源时 SimplePie用于解析 XML feed。所有能被 SimplePie 理解的格式都能在 DokuWiki 中使用。您可以通过多个额外的空格分隔参数来影响渲染效果: ^ 参数 ^ 说明^ | 任何数字| 将用作显示的最大条目数,默认为 8| | 反向 | 首先显示源中的最后一个项目| | 作者 | 显示项目作者姓名| | 日期 | 显示项目日期| | description| 显示项目描述。将删除所有 HTML 标记| | 不排序 | 不对信息源中的项目进行排序| | n[dhm]| 刷新周期,其中 d=天,h=小时,m=分钟。(例如 12h= 12 小时)。| 刷新周期默认为 4 小时。任何低于 10 分钟的值都将被视为 10 分钟。下载 通常会尝试提供页面的缓存版本,但当页面包含动态外部内容时,这显然是不合适的。该参数告诉下载 ,如果超过了 刷新周期重新渲染页面。 默认情况下,Feed 将按日期排序,最新条目优先。您可以使用反向参数进行排序,或使用nosort. 例如- Shuttered Startups Are Selling Old Slack Chats, Emails To AI Companies by BeauHD (2026/04/18 11:00)
- NASA Restarts Work To Support Europe's Uncrewed Trip To Mars After Years of Setbacks by BeauHD (2026/04/18 07:00)
- Critical Atlantic Current Significantly More Likely To Collapse Than Thought by BeauHD (2026/04/18 03:30)
- Online Personalities and Comedians Overtake TV and Newspapers as Primary News Sources by BeauHD (2026/04/17 23:00)
- NIST Limits CVE Enrichment After 263% Surge In Vulnerability Submissions by BeauHD (2026/04/17 22:00)
- Shuttered Startups Are Selling Old Slack Chats, Emails To AI Companies by BeauHD (2026/04/18 11:00)
- NASA Restarts Work To Support Europe's Uncrewed Trip To Mars After Years of Setbacks by BeauHD (2026/04/18 07:00)
- Critical Atlantic Current Significantly More Likely To Collapse Than Thought by BeauHD (2026/04/18 03:30)
- Online Personalities and Comedians Overtake TV and Newspapers as Primary News Sources by BeauHD (2026/04/17 23:00)
- NIST Limits CVE Enrichment After 263% Surge In Vulnerability Submissions by BeauHD (2026/04/17 22:00)
===== 控制宏===== 一些语法会影响 DokuWiki 如何渲染页面,而不会自行创建任何输出。以下是可用的控制宏: ^ 宏 ^ 说明| | ~~NOTOC~~ | 如果在页面上找到此宏,则不会创建目录| | ~~NOCACHE~~| DokuWiki 默认会缓存所有输出。有时可能不希望这样做(例如,当使用上述 <php>使用上述 语法时),添加此宏将强制 DokuWiki 在每次调用时重新渲染页面| ===== 语法插件===== DokuWiki 的语法可以通过以下插件进行扩展 插件 。已安装的插件的使用方法将在相应的描述页面中进行说明。以下语法插件在此特定的 DokuWiki 安装中可用:
- Gallery Plugin 2024-04-30 by Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed - PageTitle plugin 2023-08-30 by Satoshi Sahara
Define a title of the wiki page by <title> tag. This plugin allows to write decorative title on the page with setting plain title text in metadata storage. - Video Sharing Site Plugin 2025-02-21 by Andreas Gohr
Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}} - Wrap Plugin 2023-08-13 by 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.



