目录
Blog Plugin
—- plugin —-
description: Use DokuWiki as blogging tool
author : Dokufreaks (previous author: Michael Hamann, Gina Häußge, Michael Klier, Esther Brunner)
email : freaks@dokuwiki.org
type : syntax, action, helper
lastupdate : 2023-10-24
compatible : Librarian, Kaos, Lemming, Anteater, Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum
depends : include, pagelist
conflicts :
similar : blogtng, miniblog
tags : blog, news
downloadurl: https://github.com/dokufreaks/plugin-blog/archive/master.zip
bugtracker : https://github.com/dokufreaks/plugin-blog/issues
sourcerepo : https://github.com/dokufreaks/plugin-blog
Description
The Blog Plugin makes blogs in your wiki easily possible. The blog component shows the latest entries (pages) from a namespace in reverse chronological order. In this new version, the creation date is the sort key – no longer the date of the last non-minor modification as in previous versions. The archive component lists all entries that were written (created) in the given month.
Installation
| Download | plugin-blog.tgz |
|---|---|
| BundleHub | Configure your own DokuWiki blogsuite install package, consisting of all mandatory plugins plus any optional features you want to include: BlogSuite BundleHub Site seems to be down for sime time, here is the archived version if you want to see possible optional plugins & features. |
| Tips | If you intend to use this plugin be sure to take a look at the blogging tips page |
Syntax
Blog
| [namespace] | namespace for the blog; subspaces will be searched as well; * is the whole wiki, . is the same namespace as the page lies in | optional; default is the blog namespace set in the configuration |
|---|---|---|
| [number] | number of entries to show per page | optional; default is 5 |
| [flags] | flags are delimited by & | |
| all Include plugin flags are supported | optional | |
Form placement: topform/bottomform/noform | optional, default is topform |
|
Custom new-entry form title: newentrytitle=Custom title | optional, can also be set as a configuration option | |
Hide paging controls: nopagingcontrols | optional |
This includes a specified number of most recent blog entries from the given namespace into the current page. Below the entries a link to the page (permalink), the author, the creation date and the number of comments are shown. Link, author, date and comments info can be hidden. At the end of the blog a link to older entries lets you navigate in the history of the blog. At the very end, if you have enough rights to create new pages, a form for new blog entries is displayed.
Note that when the page with the blog syntax is in the specified namespace, content my be shown twice. At some point, the loop will be detected and stopped. You should therefore make sure that either the page with the listing is in a different namespace or use the excluded_pages-option to explicitly exclude the blog page from the blog listing.
Archive
| [namespace] | the namespace for which you want an archive list; * is the whole wiki, . is the same namespace as the page lies in | optional; default is the namespace specified in the configuration |
|---|---|---|
| [month] | the month for the archive list in YYYY-MM format; * for all pages | required |
| [flags] | pagelist flags delimited by &, see flags | optional |
| [username] | username of an author | optional |
Shows a table with all pages of the given namespace that were created in the specified month.
Creates an automatic archive.
Configuration and Settings
The blog plugin can be configured using the DokuWiki configuration manager available in the admin menu.
namespace | The default namespace which is used if no namespace was given in the syntax |
|---|---|
formposition | You can choose to display the new entry form either above or below the blog entries |
newentrytitle | Set a custom title for all new entry forms. This can also be set on individual blog forms. |
dateprefix | A date prefix that automatically gets added to pages created with the new entry form. You can use the options from the strftime PHP function; namespace separators work as well, e.g. %Y:%m%d |
sortkey | Defines how the blog entries are sorted. Available options are creation date, modification date, page name, page ID and page title (first headline) |
sortorder | Sort the blog entries ascending/descending |
excluded_pages | Exclude certain pages from the blog listing. Requires a regular expression. Use for example !(^|:)start$! in order to exclude start pages from all blog listings. To exclude both start and rightsidebar directly below :blog use !(^|:)blog:(start|rightsidebar)$! |
showhistogram | Display a histogram in normal archive mode (not for autoarchive) |
max_months | Maximum number of months to show in the histogram |
histogram_height | Height of the histogram (in pixels) |
Changes
* 2013-10-20: Translation updates, fix cache handling for empty blog listings
* 2013-03-27: Better cache handling for the archive syntax
- the syntax that lists everything till now correctly updates the cache now whenever a page is changed or a comment or linkback is added.
- the cache is not used anymore when it contains an archive listing with a page that the current user can't access. The excluded pages won't be included again automatically unless the cache expires for other reasons, the
~~NOCACHE~~macro can be used if this is needed.
Development
Change Log
- Merge pull request #126 from dokuwiki-translate/lang_update_848_17143… (2024/05/01 23:45)
- translation update (2024/04/29 14:20)
- Version upped (2023/10/25 05:50)
- Merge pull request #121 from fiwswe/fix_issue_120 (2023/10/25 01:51)
- Rename constructor (2023/10/24 18:10)
- Merge pull request #118 from dokuwiki-translate/lang_update_564_16764… (2023/02/17 03:25)
- translation update (2023/02/15 08:35)
- Merge pull request #117 from dokuwiki-translate/lang_update_551_16745… (2023/01/25 04:45)
Bugs / Feature Requests
Please report bugs or feature requests at the Bug tracker.
FAQ
Please also have a look at the blogging tips page!
My dates are shown wrong. What can I do?
Make sure you run the latest version of all required plugins and DokuWiki.
Is it possible to change the way the date is displayed?
Yes, the plugin uses the dformat option to format the date.
How can I alter the date of a blog post?
You can use the meta plugin to manually set the creation date (and modification date) in the page source, then select the modification date in the blog plugins order setting. An alternative solution would be to alter the timestamps of the created files.
Is it possible to show table of contents?
The table of contents is shown automatically (depending on the settings in DokuWiki itself) from version 2013-02-07 on.
The header is always a link to the page even though it's disabled in the include plugin settings
The blog plugin assumes that in the context of a blog the header should be a link. However from version 2013-02-26 on it is possible to disable this behavior by using the nolink-flag, the blog plugin now only sets a default without overriding the nolink flag.
Is it possible to show just the first lines of each post with a 'Read more' link to view the full post?
I think I solved myself.
In the blog mark, use the following flags
This will work if you add an H2 header (in the full post) where you want to make appear the 'Read more' link.
If you don't need or want an H2 header in your post, you can add a empty H2 header, just as a delimiter for the text you want to show in the Blog's headlines
the excluded_pages does not work
In the blog mark ,use the following flags
促进全民阅读 推进书香社会建设
全民阅读促进条例 https://www.gov.cn/gongbao/2026/issue_12486/202601/content_7054235.html
这是临汾人阅读的所在。感谢您的访问!
2026年2月2日重新起航。
- DokuWiki 格式语法
- Tips and Tricks for DokuWiki
DokuWiki 格式语法
DokuWiki 支持一些简单的标记语言, 以尽可能使源文件也具有可读性。本页面包含了所有您在编辑页面时可能用到的语法的说明。如果需要查看本页源码,只需要点击页面顶部或者底部的 编辑本页 按钮即可。 如果您是初尝维基,那么可以使用维基涂鸦板来尽情挥洒。通过工具条快捷按钮,您可以方便地使用这些标记。
基本文本格式
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> 也可以被识别。
内部链接
内部链接可以用方括号创建。您可以只给出链接的地址:pagename,也可以附加上链接的名字:我的链接。
内部链接可以用方括号创建。您可以只给出链接的地址:[[pagename]], 也可以附加上链接的名字:[[pagename|我的链接]]。
维基页面名 将会被自动地识别为小写字母,并且不允许使用特殊字符。
您可以通过在页面名中使用冒号的方式来使用 命名空间。
您可以通过在页面名中使用冒号的方式来使用 [[wiki:namespaces|命名空间]]。
如果您需要关于命名空间(namespaces)的更详细的信息,请参见 命名空间。
您也可以链接到一个网页内部的某一节,只需要将该节书签的名称以一个#号分隔加在网页的地址后面即可。这是一个连向 本节 的链接。
这是一个指向 [[syntax#内部链接|本节]] 的链接。
注:
- 当一节的标题改变时,该节的书签也会改变,因此,请不要太依赖页面内的链接。
维基间链接
DokuWiki 支持维基间链接,即到其他维基的链接。例如,这是一个到维基百科上关于“维基”的一个页面链接: Wiki 。
DokuWiki 支持[[interwiki|维基间链接]],即到其他维基的链接。 例如,这是一个到维基百科上关于“维基”的一个页面链接: [[wp>Wiki]] 。
Windows 文件夹共享
Windows 文件夹共享,例如 this 也可以被识别。请注意,这只在内部 局域网 等环境中才可能被成功访问。
Windows共享文件夹,例如 [[\\server\share|this]] 也可以被识别。
注:
- 出于安全原因,只有在微软IE浏览器上才能够直接访问 Windows 文件夹共享。 (且只适用于局域网内部环境).
- Mozilla 和 Firefox 可采用 Mozilla 知识库 中提到的方法实现此功能. 但是,在打开 Windows 共享时仍然弹出 JavaScript 警告。如需为所有用户删除这个警告, 请将本行代码加入
conf/lang/en/lang.php中 (详情见 localization):- 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://www.php.net|{{wiki:dokuwiki-128.png}}]]
请注意:在链接名中使用语法,只有显示图像的语法会被识别,请不要使用其它语法。
DokuWiki 支持完整的图像及[#links|链接]]预发,包括调整图像大小、内部和外部的图像链接,以及wiki内链接。
脚注
您可以使用两个连续小括号来添加脚注1)。
您可以使用两个连续小括号来添加脚注((看这里,这是一个脚注))。
标题段落
您可以使用最多达5层的标题来使您的页面更富结构性。如果您使用了三个以上的标题,那么 DokuWiki 会自动在页面上生成一个名为“本页目录”的标题列表。当然,您也可以关闭这项特性,只需在编辑时在页面里加入 ~~NOTOC~~ 字样即可。
H3标题
H4标题
H5标题
==== H3标题 ==== === H4标题 === == H5标题 ==
您可以通过连续的4个以上“-”号来创建一条水平分割线:
图像和其它文件
您可以使用双大括号来在页面中加入 图像,视频及声音文件 。您还可以选择是否指定图像的显示大小。
指定宽度和高度(200×50)2):
原始大小: {{wiki:dokuwiki-128.png}}
指定宽度(50 pixel): {{wiki:dokuwiki-128.png?50}}
指定宽度和高度(200×50): {{wiki:dokuwiki-128.png?200*50}}
重新指定宽度和高度的外部图像(100x100): {{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 可以直接在页面中嵌入以下格式.
| 图像 | gif, jpg, png |
| 视频 | webm, ogv, mp4 |
| 音频 | ogg, mp3, wav |
| Flash | swf |
如果指定不支持的媒体格式的文件名,则它将作为链接显示。
加上 ?linkonly 就会在网页中只显示链接,不显示内容。
{{wiki:dokuwiki-128.png?linkonly}}
dokuwiki-128.png 这是一个图片的链接。
备用的文件格式
并非所有浏览器都支持所有的视频和音频格式,要解决这个问题,你可以上传不同的文件格式,以获得最大的浏览器兼容性。
例如有一个 mp4 的视频文件:
{{video.mp4|一个很有意思的视频}}
如果同时上传了 video.webm 和 video.ogv 到与 video.mp4 相同的命名空间的话, DokuWiki 会自动识别为备用的文件格式,并选择一个最适合当前浏览器的文件格式。
此外,DokuWiki 也支持“视频海报”,可以在视频播放前显示制定的图片。该图片必须与视频文件名相同,并且为 jpg 和 png格式。
列表
Dokuwiki 支持带编号或不带编号的列表。要使用列表,在文字前加入两个空格,然后使用*标志不带编号的列表,用-标志带编号的列表。
- 列表
- 第二项
- 下一层
- 第三项
- 带编号的列表
- 第二项
- 用缩进表示更深的层
- 完了
* 列表
* 第二项
* 下一层
* 第三项
- 带编号的列表
- 第二项
- 用缩进表示更深的层
- 完了
同时可以关注 列表项目常见问题解答.
文本转换
DokuWiki 可以将预定义的字符或者字符串转换成图片、其他文本或 HTML。
文本到图片的转换,主要用作表情符号。文本到 HTML 的转换,多用於显示符号替换,但也可以配置为使用其他 HTML。
表情符号
DokuWiki 会将一些常用的 表情符号 转换为图像。除了默认的表情符号以外,您也可以在 Smileys 文件夹中放入更多的表情图,然后在 conf/smileys.conf 中设置它们即可。下面是 Dokuwiki 包含了的表情图像:
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME
印刷样式
DokuWiki 可以将特定字符转换为印刷时所用的样式。下面是可以识别的这类字符的列表:
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
请注意:在配置文件中可以禁用这类自动转换。
层次显示
有时候(特别是讨论时)您想把某些文字(尤为各次的回复)标示作不同的层次,您可以使用下列的语法:
我认为我们应该一起行动 > 不行,不能一起行动 >> 嗯……,我感觉能行 > 真的吗? >> 是! >>> 那么,一起行动吧!
我认为我们应该一起行动
不行,不能一起行动
嗯……,我感觉能行
真的吗?
是!
那么,一起行动吧!
表格
DokuWiki 可以用简单的语法创建表格。
| 标题 1 | 标题 2 | 标题 3 |
|---|---|---|
| (WOK) | (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,0) | 这次示范垂直合并 | (1,3) |
| (2,1) | (2,3) | |
| (3,1) | (3,3) |
除跨行合并语法:::外,单元格中不能包含其他内容。
^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | (1,1) | 这次示范垂直合并 | (1,3) | | (2,1) | ::: | (2,3) | | (3,1) | ::: | (3,3) |
您可以对齐表格的文字。只需要添加多余两个的空格在您需要对齐的方向的反向即可:如果需要右对齐,在左边添加两个空格;反之,则在右边添加。在两边均添加空格可以实现中间对齐。
| 有对齐的表格 | ||
|---|---|---|
| 右对齐 | 居中 | 左对齐 |
| 左对齐 | 右对齐 | 居中 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
下面是源文件中的格式:
^ 有对齐的表格 ^^^ | 右对齐| 居中 |左对齐 | |左对齐 | 右对齐| 居中 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
注意:不支持垂直对齐
无格式区块
若要略过某段内含维基语法,不对该段文字作任何处理, 可以使用 <nowiki> 标签或更简单一点用 2 个 %% 放在该段文字的前后,请参考下面例子:
正如本段示范里,本来包含了网址:http://www.splitbrain.org,以及**加上格式的文字**,但它没有给格式化。连表情符号;-)的转换,也与//__加上格式的文字__//一样,全都失效了。
使用百分号对 //__这段__ 文字// 可以达到同样的效果 ;-).
<nowiki>正如本段示范里,本来包含了网址:http://www.splitbrain.org,以及**加上格式的文字**,但它没有给格式化。连表情符号;-)的转换,也与//__加上格式的文字__//一样,全都失效了。</nowiki> 使用百分号对 %%//__这段__ 文字// 可以达到同样的效果 ;-)%%。
代码区块
在一段文字的最前面加上 2 个空白,来直接作为「文本框」不对它做加工处理(就像前面那些说明一样)。或者也可以用 <code> 或 <file> 这两个标签(tag)都可以达到类似效果。
这段是用 <code> 产生的,所有空格及所有原始格式都会照样显示,还其本色。
就像 <-这个
这段跟上段很像,但是改用 <file> ,可以把它用在「引述名言(Quote)」效果上。
remember, information is not knowledge,
knowledge is not wisdom
wisdom is not truth
truth is not beauty
beauty is not love
love is not music
music is the best
-- frank zappa
这些区域的源码如下:
这段是用 <code> 产生的,所有空格及所有原始格式都会照样显示,还其本色。
<code> 就像 <-这个 </code>
<file>
这段跟上段很像,但是改用 <file> ,可以把它用在「引述名言(Quote)」效果上。
remember, information is not knowledge,
knowledge is not wisdom
wisdom is not truth
truth is not beauty
beauty is not love
love is not music
music is the best
-- frank zappa
</file>
语法的高亮度显示
DokuWiki 可把原始码语法来做高亮度显示(Syntax Highlighting),来更加具可读性。 它采用的是 GeSHi Generic Syntax Highlighter —— 所以只要 GeSHi 有支持的,DokuWiki 亦可。
用法就类似前例的 <code> ,但要在标签(tag)内指定该原始码所使用的语言。比如 <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. } }
目前支持的语言有: actionscript, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, html4strict, java, javascript, lisp, lua, mpasm, nsis, objc, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, visualfoxpro, xml
可下载的代码块
若您使用上述的 <code> 或 <file> 语法,您或許希望让浏览者直接下载该段代码。您可以在语言代码后方指定一個文件名,方便浏览者下载:
<file php myexample.php> <?php echo "hello world!"; ?> </file>
- myexample.php
<?php echo "hello world!"; ?>
若您不想把语法高亮显示出,但想方便浏览者下载,您可以用链接号 - 作语言代码。例如:<code – myfile.foo>。
在内容中嵌入HTML或PHP语法
可以在文件里透过加入 <html> or <php> 标签来使用HTML或PHP,比如:
这是一段用 <font color="red" size="+1">HTML 写的红色字(size=+1)</font>
<html> 这是一段用 <font color="red" size="+1">HTML 写的红色字(size=+1)</font> </html>
22
echo '由 PHP 所产生 Logo:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=
' . php_logo_guid() . '"
alt="PHP Logo !" />';
<php>
echo '由 PHP 所产生 Logo:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=
' . php_logo_guid() . '"
alt="PHP Logo !" />';
</php>
请特别注意:HTML 及 PHP 语法可以在设定选项中决定支持与否。若您的 DokuWiki 设定不打开这两项功能(可单独打开两者之一功能)那么上面的例子就不会被执行,而是直接显示出来原始写法。
RSS/ATOM Feed 聚合
DokuWiki 能從外部 XML feed 中聚合數據。為分析這些 XML feed,DokuWiki 使用了SimplePie。凡是 SimplePie 能理解的格式,都可用於 DokuWiki 中。您可以更改不同的參數,以改變其渲染。參數之間請用空格隔開:
| 參數 | 描述 |
|---|---|
| any number | 最多顯示多少項內容;預設值是8。 |
| reverse | 將最新條目顯示在前面。 |
| author | 顯示條目的作者名字。 |
| date | 顯示條目數據。 |
| description | 顯示條目的描述;如果 HTML 被禁用,所有標籤將被過濾掉 |
| n[dhm] | 刷新周期,其中,d=日數,h=小時數,m=分。例如,12h=12小時。 |
預設的刷新周期是 4 小時。小於 10 分鐘者亦視為 10 分鐘。DokuWiki 通常會提供頁面的暫存版,但這做法不適用於包含動態外部內容的頁面。上面的參數則告訴 DokuWiki:若對上一次渲染時間已經過了刷新周期,就要重新渲染頁面。
範例:
{{rss>http://slashdot.org/index.rss 5 author date 1h }}
- Harvard Votes On Limiting 'A' Grades 由 BeauHD (2026/05/14 00:00)
- Meta Employees Launch Protest Against Mouse-Tracking Tech At US Offices 由 BeauHD (2026/05/13 23:00)
- CERN Open Sources Its KiCad Component Libraries 由 BeauHD (2026/05/13 19:00)
- Why Are Some People Mosquito Magnets? 由 BeauHD (2026/05/13 15:00)
- Sam Altman Testifies That Elon Musk Wanted Control of OpenAI 由 BeauHD (2026/05/13 11:30)
控制宏
控制宏会影响 DokuWiki 对页面的渲染,而自身不输出任何內容。可用的控制宏如下:
| 宏 | 描述 |
|---|---|
| ~~NOTOC~~ | 如果页面中出现该控制宏,将不会为该页创建目录。 |
| ~~NOCACHE~~ | DokuWiki 默认会缓存所有的输出。有时您并不希望内容被缓存(例如您使用了上述的<php>语法,页面会动态生成),便可使用这个控制宏,强制 DokuWiki 在每次访问时都重新生成页面。 |
扩展插件
使用插件,可以扩充 DokuWiki 的语法。插件的的安装方法,请参见其他相应页面中的说明。
2026-2-5 06:43:58
Welcome to your new DokuWiki
Congratulations, your wiki is now up and running. Here are a few more tips to get you started.
Enjoy your work with DokuWiki,
– the developers
Create your first pages
Your wiki needs to have a start page. As long as it doesn't exist, this link will be red: start.
Go on, follow that link and create the page. If you need help with using the syntax you can always refer to the syntax page.
You might also want to use a sidebar. To create it, just edit the sidebar page. Everything in that page will be shown in a margin column on the side. Read our FAQ on sidebars to learn more.
Please be aware that not all templates support sidebars.
Customize your Wiki
Once you're comfortable with creating and editing pages you might want to have a look at the configuration settings (be sure to login as superuser first).
You may also want to see what plugins and templates are available at DokuWiki.org to extend the functionality and looks of your DokuWiki installation.
Join the Community
DokuWiki is an Open Source project that thrives through user contributions. A good way to stay informed on what's going on and to get useful tips in using DokuWiki is subscribing to the newsletter.
The DokuWiki User Forum is an excellent way to get in contact with other DokuWiki users and is just one of the many ways to get support.
Of course we'd be more than happy to have you getting involved with DokuWiki.
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.
Links
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:
- Links to existing pages are shown in a different style from nonexisting ones.
- When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
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:
- For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
- For Mozilla and Firefox it can be enabled through different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in
conf/lang/en/lang.php(more details at localization):- 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.
Resize to given width and height2):
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.
{{ 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.
| Image | gif, jpg, png |
| Video | webm, ogv, mp4 |
| Audio | ogg, mp3, wav |
| Flash | swf |
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.
- 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
* 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:
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME
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 vertically | Row 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 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
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 <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 ;-)%%.
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 <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>
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
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:
<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>.
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:
<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 '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>
echo 'The PHP version: ';
echo phpversion();
echo ' (inline HTML)';
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<td>'.phpversion().'</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.
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 }}
- KDE Receives $1.4 Million Investment From Sovereign Tech Fund 由 BeauHD (2026/05/14 01:00)
- Harvard Votes On Limiting 'A' Grades 由 BeauHD (2026/05/14 00:00)
- Meta Employees Launch Protest Against Mouse-Tracking Tech At US Offices 由 BeauHD (2026/05/13 23:00)
- CERN Open Sources Its KiCad Component Libraries 由 BeauHD (2026/05/13 19:00)
- Why Are Some People Mosquito Magnets? 由 BeauHD (2026/05/13 15:00)
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:
- Add New Page 2016-12-23 由 Benjamin Santalucia, Sam Wilson, Michael Braun, Gerrit Uitslag, Albert Chern
Adds a "new page form" to any wiki page. - Tag Plugin 2017-08-24 由 Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - Blog 2023-10-24 由 Michael Hamann, Michael Klier, Gina Haeussge
Use DokuWiki as blogging tool. (previous authors: Esther Brunner) - include plugin 2018-11-29 由 Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page - Footer plugin 2020-12-17 由 Juergen aus Zuendorf
Add footer text in every page in a namespace without the need to edit pages - Pagelist Plugin 2017-08-24 由 Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way
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 Formatting 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.
Read the DokuWiki Manual to unleash the full power of DokuWiki.
Download
DokuWiki is available at http://download.dokuwiki.org/
Read More
All documentation and additional information besides the syntax description is maintained in the DokuWiki at www.dokuwiki.org.
About DokuWiki
Installing DokuWiki
Using DokuWiki
Customizing DokuWiki
DokuWiki Feedback and Community
Copyright
2004-2015 © Andreas Gohr andi@splitbrain.org3) and the DokuWiki Community
The DokuWiki engine is licensed under GNU General Public License Version 2. If you use DokuWiki in your company, consider donating a few bucks
.
Not sure what this means? See the FAQ on the Licenses.
or
促进全民阅读 推进书香社会建设
全民阅读促进条例 https://www.gov.cn/gongbao/2026/issue_12486/202601/content_7054235.html
这是临汾人阅读的所在。感谢您的访问!
2026年2月2日重新起航。
- DokuWiki 格式语法
- Tips and Tricks for DokuWiki
DokuWiki 格式语法
DokuWiki 支持一些简单的标记语言, 以尽可能使源文件也具有可读性。本页面包含了所有您在编辑页面时可能用到的语法的说明。如果需要查看本页源码,只需要点击页面顶部或者底部的 编辑本页 按钮即可。 如果您是初尝维基,那么可以使用维基涂鸦板来尽情挥洒。通过工具条快捷按钮,您可以方便地使用这些标记。
基本文本格式
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> 也可以被识别。
内部链接
内部链接可以用方括号创建。您可以只给出链接的地址:pagename,也可以附加上链接的名字:我的链接。
内部链接可以用方括号创建。您可以只给出链接的地址:[[pagename]], 也可以附加上链接的名字:[[pagename|我的链接]]。
维基页面名 将会被自动地识别为小写字母,并且不允许使用特殊字符。
您可以通过在页面名中使用冒号的方式来使用 命名空间。
您可以通过在页面名中使用冒号的方式来使用 [[wiki:namespaces|命名空间]]。
如果您需要关于命名空间(namespaces)的更详细的信息,请参见 命名空间。
您也可以链接到一个网页内部的某一节,只需要将该节书签的名称以一个#号分隔加在网页的地址后面即可。这是一个连向 本节 的链接。
这是一个指向 [[syntax#内部链接|本节]] 的链接。
注:
- 当一节的标题改变时,该节的书签也会改变,因此,请不要太依赖页面内的链接。
维基间链接
DokuWiki 支持维基间链接,即到其他维基的链接。例如,这是一个到维基百科上关于“维基”的一个页面链接: Wiki 。
DokuWiki 支持[[interwiki|维基间链接]],即到其他维基的链接。 例如,这是一个到维基百科上关于“维基”的一个页面链接: [[wp>Wiki]] 。
Windows 文件夹共享
Windows 文件夹共享,例如 this 也可以被识别。请注意,这只在内部 局域网 等环境中才可能被成功访问。
Windows共享文件夹,例如 [[\\server\share|this]] 也可以被识别。
注:
- 出于安全原因,只有在微软IE浏览器上才能够直接访问 Windows 文件夹共享。 (且只适用于局域网内部环境).
- Mozilla 和 Firefox 可采用 Mozilla 知识库 中提到的方法实现此功能. 但是,在打开 Windows 共享时仍然弹出 JavaScript 警告。如需为所有用户删除这个警告, 请将本行代码加入
conf/lang/en/lang.php中 (详情见 localization):- 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://www.php.net|{{wiki:dokuwiki-128.png}}]]
请注意:在链接名中使用语法,只有显示图像的语法会被识别,请不要使用其它语法。
DokuWiki 支持完整的图像及[#links|链接]]预发,包括调整图像大小、内部和外部的图像链接,以及wiki内链接。
脚注
您可以使用两个连续小括号来添加脚注1)。
您可以使用两个连续小括号来添加脚注((看这里,这是一个脚注))。
标题段落
您可以使用最多达5层的标题来使您的页面更富结构性。如果您使用了三个以上的标题,那么 DokuWiki 会自动在页面上生成一个名为“本页目录”的标题列表。当然,您也可以关闭这项特性,只需在编辑时在页面里加入 ~~NOTOC~~ 字样即可。
H3标题
H4标题
H5标题
==== H3标题 ==== === H4标题 === == H5标题 ==
您可以通过连续的4个以上“-”号来创建一条水平分割线:
图像和其它文件
您可以使用双大括号来在页面中加入 图像,视频及声音文件 。您还可以选择是否指定图像的显示大小。
指定宽度和高度(200×50)2):
原始大小: {{wiki:dokuwiki-128.png}}
指定宽度(50 pixel): {{wiki:dokuwiki-128.png?50}}
指定宽度和高度(200×50): {{wiki:dokuwiki-128.png?200*50}}
重新指定宽度和高度的外部图像(100x100): {{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 可以直接在页面中嵌入以下格式.
| 图像 | gif, jpg, png |
| 视频 | webm, ogv, mp4 |
| 音频 | ogg, mp3, wav |
| Flash | swf |
如果指定不支持的媒体格式的文件名,则它将作为链接显示。
加上 ?linkonly 就会在网页中只显示链接,不显示内容。
{{wiki:dokuwiki-128.png?linkonly}}
dokuwiki-128.png 这是一个图片的链接。
备用的文件格式
并非所有浏览器都支持所有的视频和音频格式,要解决这个问题,你可以上传不同的文件格式,以获得最大的浏览器兼容性。
例如有一个 mp4 的视频文件:
{{video.mp4|一个很有意思的视频}}
如果同时上传了 video.webm 和 video.ogv 到与 video.mp4 相同的命名空间的话, DokuWiki 会自动识别为备用的文件格式,并选择一个最适合当前浏览器的文件格式。
此外,DokuWiki 也支持“视频海报”,可以在视频播放前显示制定的图片。该图片必须与视频文件名相同,并且为 jpg 和 png格式。
列表
Dokuwiki 支持带编号或不带编号的列表。要使用列表,在文字前加入两个空格,然后使用*标志不带编号的列表,用-标志带编号的列表。
- 列表
- 第二项
- 下一层
- 第三项
- 带编号的列表
- 第二项
- 用缩进表示更深的层
- 完了
* 列表
* 第二项
* 下一层
* 第三项
- 带编号的列表
- 第二项
- 用缩进表示更深的层
- 完了
同时可以关注 列表项目常见问题解答.
文本转换
DokuWiki 可以将预定义的字符或者字符串转换成图片、其他文本或 HTML。
文本到图片的转换,主要用作表情符号。文本到 HTML 的转换,多用於显示符号替换,但也可以配置为使用其他 HTML。
表情符号
DokuWiki 会将一些常用的 表情符号 转换为图像。除了默认的表情符号以外,您也可以在 Smileys 文件夹中放入更多的表情图,然后在 conf/smileys.conf 中设置它们即可。下面是 Dokuwiki 包含了的表情图像:
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME
印刷样式
DokuWiki 可以将特定字符转换为印刷时所用的样式。下面是可以识别的这类字符的列表:
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
请注意:在配置文件中可以禁用这类自动转换。
层次显示
有时候(特别是讨论时)您想把某些文字(尤为各次的回复)标示作不同的层次,您可以使用下列的语法:
我认为我们应该一起行动 > 不行,不能一起行动 >> 嗯……,我感觉能行 > 真的吗? >> 是! >>> 那么,一起行动吧!
我认为我们应该一起行动
不行,不能一起行动
嗯……,我感觉能行
真的吗?
是!
那么,一起行动吧!
表格
DokuWiki 可以用简单的语法创建表格。
| 标题 1 | 标题 2 | 标题 3 |
|---|---|---|
| (WOK) | (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,0) | 这次示范垂直合并 | (1,3) |
| (2,1) | (2,3) | |
| (3,1) | (3,3) |
除跨行合并语法:::外,单元格中不能包含其他内容。
^ 标题 1 ^ 标题 2 ^ 标题 3 ^ | (1,1) | 这次示范垂直合并 | (1,3) | | (2,1) | ::: | (2,3) | | (3,1) | ::: | (3,3) |
您可以对齐表格的文字。只需要添加多余两个的空格在您需要对齐的方向的反向即可:如果需要右对齐,在左边添加两个空格;反之,则在右边添加。在两边均添加空格可以实现中间对齐。
| 有对齐的表格 | ||
|---|---|---|
| 右对齐 | 居中 | 左对齐 |
| 左对齐 | 右对齐 | 居中 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
下面是源文件中的格式:
^ 有对齐的表格 ^^^ | 右对齐| 居中 |左对齐 | |左对齐 | 右对齐| 居中 | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
注意:不支持垂直对齐
无格式区块
若要略过某段内含维基语法,不对该段文字作任何处理, 可以使用 <nowiki> 标签或更简单一点用 2 个 %% 放在该段文字的前后,请参考下面例子:
正如本段示范里,本来包含了网址:http://www.splitbrain.org,以及**加上格式的文字**,但它没有给格式化。连表情符号;-)的转换,也与//__加上格式的文字__//一样,全都失效了。
使用百分号对 //__这段__ 文字// 可以达到同样的效果 ;-).
<nowiki>正如本段示范里,本来包含了网址:http://www.splitbrain.org,以及**加上格式的文字**,但它没有给格式化。连表情符号;-)的转换,也与//__加上格式的文字__//一样,全都失效了。</nowiki> 使用百分号对 %%//__这段__ 文字// 可以达到同样的效果 ;-)%%。
代码区块
在一段文字的最前面加上 2 个空白,来直接作为「文本框」不对它做加工处理(就像前面那些说明一样)。或者也可以用 <code> 或 <file> 这两个标签(tag)都可以达到类似效果。
这段是用 <code> 产生的,所有空格及所有原始格式都会照样显示,还其本色。
就像 <-这个
这段跟上段很像,但是改用 <file> ,可以把它用在「引述名言(Quote)」效果上。
remember, information is not knowledge,
knowledge is not wisdom
wisdom is not truth
truth is not beauty
beauty is not love
love is not music
music is the best
-- frank zappa
这些区域的源码如下:
这段是用 <code> 产生的,所有空格及所有原始格式都会照样显示,还其本色。
<code> 就像 <-这个 </code>
<file>
这段跟上段很像,但是改用 <file> ,可以把它用在「引述名言(Quote)」效果上。
remember, information is not knowledge,
knowledge is not wisdom
wisdom is not truth
truth is not beauty
beauty is not love
love is not music
music is the best
-- frank zappa
</file>
语法的高亮度显示
DokuWiki 可把原始码语法来做高亮度显示(Syntax Highlighting),来更加具可读性。 它采用的是 GeSHi Generic Syntax Highlighter —— 所以只要 GeSHi 有支持的,DokuWiki 亦可。
用法就类似前例的 <code> ,但要在标签(tag)内指定该原始码所使用的语言。比如 <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. } }
目前支持的语言有: actionscript, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, html4strict, java, javascript, lisp, lua, mpasm, nsis, objc, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, visualfoxpro, xml
可下载的代码块
若您使用上述的 <code> 或 <file> 语法,您或許希望让浏览者直接下载该段代码。您可以在语言代码后方指定一個文件名,方便浏览者下载:
<file php myexample.php> <?php echo "hello world!"; ?> </file>
- myexample.php
<?php echo "hello world!"; ?>
若您不想把语法高亮显示出,但想方便浏览者下载,您可以用链接号 - 作语言代码。例如:<code – myfile.foo>。
在内容中嵌入HTML或PHP语法
可以在文件里透过加入 <html> or <php> 标签来使用HTML或PHP,比如:
这是一段用 <font color="red" size="+1">HTML 写的红色字(size=+1)</font>
<html> 这是一段用 <font color="red" size="+1">HTML 写的红色字(size=+1)</font> </html>
22
echo '由 PHP 所产生 Logo:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=
' . php_logo_guid() . '"
alt="PHP Logo !" />';
<php>
echo '由 PHP 所产生 Logo:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=
' . php_logo_guid() . '"
alt="PHP Logo !" />';
</php>
请特别注意:HTML 及 PHP 语法可以在设定选项中决定支持与否。若您的 DokuWiki 设定不打开这两项功能(可单独打开两者之一功能)那么上面的例子就不会被执行,而是直接显示出来原始写法。
RSS/ATOM Feed 聚合
DokuWiki 能從外部 XML feed 中聚合數據。為分析這些 XML feed,DokuWiki 使用了SimplePie。凡是 SimplePie 能理解的格式,都可用於 DokuWiki 中。您可以更改不同的參數,以改變其渲染。參數之間請用空格隔開:
| 參數 | 描述 |
|---|---|
| any number | 最多顯示多少項內容;預設值是8。 |
| reverse | 將最新條目顯示在前面。 |
| author | 顯示條目的作者名字。 |
| date | 顯示條目數據。 |
| description | 顯示條目的描述;如果 HTML 被禁用,所有標籤將被過濾掉 |
| n[dhm] | 刷新周期,其中,d=日數,h=小時數,m=分。例如,12h=12小時。 |
預設的刷新周期是 4 小時。小於 10 分鐘者亦視為 10 分鐘。DokuWiki 通常會提供頁面的暫存版,但這做法不適用於包含動態外部內容的頁面。上面的參數則告訴 DokuWiki:若對上一次渲染時間已經過了刷新周期,就要重新渲染頁面。
範例:
{{rss>http://slashdot.org/index.rss 5 author date 1h }}
- Harvard Votes On Limiting 'A' Grades 由 BeauHD (2026/05/14 00:00)
- Meta Employees Launch Protest Against Mouse-Tracking Tech At US Offices 由 BeauHD (2026/05/13 23:00)
- CERN Open Sources Its KiCad Component Libraries 由 BeauHD (2026/05/13 19:00)
- Why Are Some People Mosquito Magnets? 由 BeauHD (2026/05/13 15:00)
- Sam Altman Testifies That Elon Musk Wanted Control of OpenAI 由 BeauHD (2026/05/13 11:30)
控制宏
控制宏会影响 DokuWiki 对页面的渲染,而自身不输出任何內容。可用的控制宏如下:
| 宏 | 描述 |
|---|---|
| ~~NOTOC~~ | 如果页面中出现该控制宏,将不会为该页创建目录。 |
| ~~NOCACHE~~ | DokuWiki 默认会缓存所有的输出。有时您并不希望内容被缓存(例如您使用了上述的<php>语法,页面会动态生成),便可使用这个控制宏,强制 DokuWiki 在每次访问时都重新生成页面。 |
扩展插件
使用插件,可以扩充 DokuWiki 的语法。插件的的安装方法,请参见其他相应页面中的说明。
2026-2-5 06:43:58
Welcome to your new DokuWiki
Congratulations, your wiki is now up and running. Here are a few more tips to get you started.
Enjoy your work with DokuWiki,
– the developers
Create your first pages
Your wiki needs to have a start page. As long as it doesn't exist, this link will be red: start.
Go on, follow that link and create the page. If you need help with using the syntax you can always refer to the syntax page.
You might also want to use a sidebar. To create it, just edit the sidebar page. Everything in that page will be shown in a margin column on the side. Read our FAQ on sidebars to learn more.
Please be aware that not all templates support sidebars.
Customize your Wiki
Once you're comfortable with creating and editing pages you might want to have a look at the configuration settings (be sure to login as superuser first).
You may also want to see what plugins and templates are available at DokuWiki.org to extend the functionality and looks of your DokuWiki installation.
Join the Community
DokuWiki is an Open Source project that thrives through user contributions. A good way to stay informed on what's going on and to get useful tips in using DokuWiki is subscribing to the newsletter.
The DokuWiki User Forum is an excellent way to get in contact with other DokuWiki users and is just one of the many ways to get support.
Of course we'd be more than happy to have you getting involved with DokuWiki.
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.
Links
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:
- Links to existing pages are shown in a different style from nonexisting ones.
- When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
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:
- For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
- For Mozilla and Firefox it can be enabled through different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in
conf/lang/en/lang.php(more details at localization):- 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 4) 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.
Resize to given width and height5):
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.
{{ 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.
| Image | gif, jpg, png |
| Video | webm, ogv, mp4 |
| Audio | ogg, mp3, wav |
| Flash | swf |
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.
- 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
* 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:
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME
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 vertically | Row 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 |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
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 <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 ;-)%%.
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 <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>
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
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:
<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>.
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:
<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 '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>
echo 'The PHP version: ';
echo phpversion();
echo ' (inline HTML)';
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<td>'.phpversion().'</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.
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 }}
- KDE Receives $1.4 Million Investment From Sovereign Tech Fund 由 BeauHD (2026/05/14 01:00)
- Harvard Votes On Limiting 'A' Grades 由 BeauHD (2026/05/14 00:00)
- Meta Employees Launch Protest Against Mouse-Tracking Tech At US Offices 由 BeauHD (2026/05/13 23:00)
- CERN Open Sources Its KiCad Component Libraries 由 BeauHD (2026/05/13 19:00)
- Why Are Some People Mosquito Magnets? 由 BeauHD (2026/05/13 15:00)
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:
- Add New Page 2016-12-23 由 Benjamin Santalucia, Sam Wilson, Michael Braun, Gerrit Uitslag, Albert Chern
Adds a "new page form" to any wiki page. - Tag Plugin 2017-08-24 由 Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - Blog 2023-10-24 由 Michael Hamann, Michael Klier, Gina Haeussge
Use DokuWiki as blogging tool. (previous authors: Esther Brunner) - include plugin 2018-11-29 由 Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page - Footer plugin 2020-12-17 由 Juergen aus Zuendorf
Add footer text in every page in a namespace without the need to edit pages - Pagelist Plugin 2017-08-24 由 Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way
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 Formatting 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.
Read the DokuWiki Manual to unleash the full power of DokuWiki.
Download
DokuWiki is available at http://download.dokuwiki.org/
Read More
All documentation and additional information besides the syntax description is maintained in the DokuWiki at www.dokuwiki.org.
About DokuWiki
Installing DokuWiki
Using DokuWiki
Customizing DokuWiki
DokuWiki Feedback and Community
Copyright
2004-2015 © Andreas Gohr andi@splitbrain.org6) and the DokuWiki Community
The DokuWiki engine is licensed under GNU General Public License Version 2. If you use DokuWiki in your company, consider donating a few bucks
.
Not sure what this means? See the FAQ on the Licenses.
all above flags does not work, the index pages in sub namespace is still included .
This is global configuration, you should configure it inConfiguration Manager. — Siyuan Liu 2023-08-17
Discussion
Please report bugs or feature requests at the Bug tracker.
Is it possible to make a blog in one namespace be in ascending order, and a blog in a different namespace to be in descending order?
2026-2-5 15:55:33


