这是本文档旧的修订版!
Formatting Syntax
DokuWiki 支持一种简洁的标记语言,目标是让数据文件尽可能易读。本页面包含你在编辑页面时可以使用的全部语法。 你可以点击“Edit this page”查看本页的源代码。如果想实际尝试语法效果,可以使用 playground 页面。 一些最常用的标记也可以通过 quickbuttons 快速插入。
Basic Text Formatting
DokuWiki 支持 粗体、斜体、下划线 以及 ‘‘等宽字体’’。当然,你也可以 ’‘组合’’ 使用这些格式。
(以下为示例,保持不变)
你还可以使用 下标 和 上标。
你也可以将内容标记为 删除 状态。
段落(Paragraph) 由空行创建。如果你想在不新建段落的情况下 强制换行,可以使用两个反斜杠,并在其后加一个空格或直接位于行尾。
请仅在确有需要时使用强制换行。
Links
DokuWiki 支持多种创建链接的方式。
External
外部链接会被自动识别,例如:http://www.google.com 或 www.google.com 你也可以为链接指定显示文本,例如:This Link points to google。 类似 [email protected] 这样的电子邮箱地址也会被自动识别。
Internal
内部链接通过方括号创建。 你可以只提供页面名 pagename,也可以使用 link text 指定显示文本。
Wiki 页面名 会被自动转换为小写,且不允许使用特殊字符。
你可以通过在页面名中使用冒号来引用 namespaces(命名空间)。
关于命名空间的详细信息,请参见 namespaces。
你也可以链接到页面中的某个具体章节,只需像 HTML 一样在后面加上 #章节名。 例如:this Section。
注意事项:
• 指向 [[syntax|已存在页面]] 的链接与指向 [[nonexisting]] 的链接显示样式不同 • DokuWiki 默认不使用 [[wp>CamelCase]] 自动创建链接(可在 [[doku>config]] 中启用) • 当章节标题被修改时,其书签也会发生变化,因此不应过度依赖章节链接
Interwiki
Windows Shares
DokuWiki 也可以识别 Windows 共享路径,例如 this。 请注意,这通常只适用于公司 Intranet 等同构用户环境。
注意事项:
• 出于安全原因,默认情况下只有 Microsoft Internet Explorer(本地区域)支持直接浏览 • Mozilla / Firefox 可通过知识库中提到的变通方式启用,但仍会出现 JavaScript 警告 • 若要移除该警告,可在指定语言文件中加入示例所示配置
(代码示例保持不变)
Image Links
你可以将图片作为链接,方法是将链接语法与 图片语法 结合使用。
请注意:图片格式是链接文本中唯一允许的格式化语法。
Footnotes
你可以使用双圆括号来添加脚注,例如 1)。
Sectioning
你最多可以使用 五级标题 来组织内容。 当页面中标题超过三级时,会自动生成目录(TOC)。 如需禁用目录,可在页面中加入字符串 ~~NOTOC~~。
使用四个或以上的短横线可以生成一条水平分隔线。
⸻
Media Files
你可以使用花括号插入内部或外部的 图片、视频和音频文件,并可选择性地指定尺寸。
通过在图片语法左右加入空格,可以控制对齐方式。
你也可以为媒体添加标题(通常作为浏览器提示显示)。
支持将图片链接到其他页面(参见上方 Image Links)。
Supported Media Formats
DokuWiki 可直接嵌入以下媒体格式:
(表格内容保持不变)
如果文件不是受支持的媒体格式,将以普通链接方式显示。
使用 ?linkonly 参数可以只显示链接而不嵌入媒体。
Fallback Formats
由于并非所有浏览器都支持全部音视频格式, 你可以上传同名但不同格式的文件,DokuWiki 会自动提供备选方案。
此外,还支持为视频指定 “poster” 预览图(jpg 或 png,文件名需相同)。
Lists
DokuWiki 支持有序与无序列表。 创建列表项时,需缩进两个空格,并使用:
• * 表示无序列表 • - 表示有序列表
多级列表通过进一步缩进实现。
Text Conversions
DokuWiki 可以将某些预定义的字符或字符串自动转换为图片、文本或 HTML。
主要用途包括:
• 表情符号 → 图片 • 排版字符 → 符合排版规范的 HTML 实体
Text to Image Conversions
Text to HTML Conversions
排版功能可将普通字符替换为排版更规范的形式,例如箭头、引号、版权符号等。
除乘号(640×480)、单引号、双引号外,其余规则来自 pattern file,并可通过 配置项 控制。
Quoting
当你需要标记引用、回复或评论内容时,可以使用 > 语法进行嵌套引用。
Tables
DokuWiki 提供了简单直观的表格语法。
• 普通行以 | 开始和结束 • 表头以 ^ 开始和结束
通过留空单元格可以实现横向合并; 通过 ::: 可以实现纵向合并。
你还可以通过在单元格内容左右添加空格来控制对齐方式。
注意:不支持垂直方向的内容对齐。
No Formatting
如果你需要原样显示文本(不进行任何格式解析), 可以使用:
• <nowiki>...</nowiki> • 或双百分号 %%...%%
Code Blocks
你可以通过以下方式插入代码块:
• 缩进至少两个空格 • 使用 <code> 或 <file> 标签
这些方式会保留所有空格和格式。
Syntax Highlighting
Downloadable Code Blocks
你可以在 <code> 或 <file> 中指定文件名,使代码可被下载。
若不需要高亮,仅需下载文件,可使用 - 作为语言标识。
RSS/ATOM Feed Aggregation
DokuWiki 可以整合外部 XML Feed, 解析由 SimplePie 完成。
可通过附加参数控制显示数量、顺序、作者、日期、刷新周期等。
刷新周期默认 4 小时,低于 10 分钟将被视为 10 分钟。
Control Macros
某些语法不会产生可见输出,而是影响页面渲染行为。
常用控制宏包括:
| Macro渲染 | 介绍 |
|---|---|
| ~~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 的语法可以通过 插件 扩展。 已安装插件所提供的语法会在其各自的说明页面中介绍。
- Blog 2023-10-24 由 Michael Hamann, Michael Klier, Gina Haeussge
Use DokuWiki as blogging tool. (previous authors: Esther Brunner) - 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 - 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 - Pagelist Plugin 2023-08-27 由 Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way - 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.
评论