本文作者: 梁如军 (Osmond Liang)

更新日期: 3.0 (2008/06/20)

详细内容: DokuWiki 使用指南

版权声明: 本文基于 作者署名-非商业性-保持一致 (by-nc-sa) 和 GNU FDL 发布。

愿本指南能为您使用 DokuWiki 提供些帮助

使用文本文件存储内容的 Wiki 在 安装/备份/移植 等方面都非常方便。典型的基于文本文件的 Wiki 引擎有：

• PHP 语言的 Dokuwiki
• Python 语言的 MoinMoin
• Perl 语言的 Twiki

本指南为您提供使用 DokuWiki 的帮助。

1. DokuWiki 简介
2. 配置安装环境
3. 安装 DokuWiki
4. 使用 模版 和 插件
5. 使用 DokuWiki 架设个人站点
6. 架设基于 Dokuwiki 的多语种站点
7. 管理 DokuWiki

• Wiki 引擎比较
• DokuWiki MoinMoin TWiki 比较
• DokuWiki 比 PmWiki 更好用

• 网络新潮文化之—维客不完全手册
• wiki爱好者

• 关于 DokuWiki
• DokuWiki 的安装环境
• 安装配置 DokuWiki
• DokuWiki 的基本使用
• Dokuwiki 的插件
• Dokuwiki 的模版
• 使用 Dokuwiki 架设个人站点
• 基于 Dokuwiki 的多语种站点
• Dokuwiki 的日常维护

详情参考如下链接：

• DokuWiki Intro
• DokuWiki Features
• DokuWiki FAQ
• Who use Dockuwiki?

• http://www.splitbrain.org/
• http://www.chimeric.de/
• http://animation.yihui.name/
• http://foosel.org/
• http://wiki.alionet.org/
• http://www.wikistuce.info

• http://dotclear.net/
  • 一个 Dotclear+DokuWiki+PunBB 整合实例
• http://doc.ubuntu-fr.org/
  • 一个 DokuWiki+PunBB+planet 整合实例
• http://qooxdoo.org/
  • 一个 WordPress+DokuWiki 整合实例
• http://flashsandy.org/
  • 一个 WordPress+DokuWiki 整合实例
• http://www.gllabs.org/
  • 一个 Geeklog+DokuWiki插件 整合实例

1. 具有 PHP 支持的 Web 服务器
   • 首选 Apache
2. 对 PHP 的要求
   • 基于某些 安全考虑 强烈建议使用 PHP 4.3.10 及其以上的版本
   • 使用 libGD 2 的PHP's GD extension — 可选项
   • 建议运行于 PHP 的 Safe Mode
   • 建议运行于 PHP 的 register_globals=off 模式

• DokuWiki 默认使用文本文件存储数据，无需数据库支持。
• DokuWiki 默认使用文本文件存储用户认证信息，也可以配置 DokuWiki 使用其他的用户认证信息存储方式
• Dokuwiki 与其他系统整合的信息

• 稳定版：下载
• 开发版：下载

当前的稳定版是 dokuwiki-2008-05-05，本指南讲述的就是这个稳定版本。

• conf/ 目录下的配置文件，这些文件在安装过程中自动生成
  • acl.auth.php
  • local.php
  • users.auth.php
• data/ 目录下的文本和图片目录
  • pages/ – 存放 wiki 文本文件
  • media/ – 存放 wiki 中引用的站内图片等
• lib/ 目录下的模板和插件目录
  • plugins – 可以使用 Dokuwiki 的管理界面安装、更新、删除
  • tpl – 由用户直接上传要使用的模板

• Web 服务器对 data/ 和 data/tmp/ 目录及其子目录可写
• Web 服务器对 lib/plugins/ 子目录可写以便使用插件管理器
• Web 服务器对 conf/local.php 文件可写以便使用浏览器安装系统或日后更改配置
• Web 服务器对 conf/users.auth.php 和 conf/acl.auth.php 文件可写以便使用浏览器安装系统或日后更改用户的 ACL 配置

如果上传用户不是 Web 服务器进程的用户需要适当调整权限。
参考 wiki:install:permissions

• 下载、安装基于 Apache 的集成环境（可任选其一）
  • xampp
  • AppServ
• 下载、安装基于 Lighttpd 的集成环境（可任选其一）
  • LightyPHP — http://lightyphp.recn.net/
  • WLMP Project
• 配置 IIS+PHP

1. 若您已经在 Windows 上配置了支持 PHP 的 Web 服务器可以直接用于 DokuWiki 的安装
2. 若您还未安装 Web 服务器且不打算运行其他基于数据库的 CMS，建议使用轻量级的 LightyPHP

在 Windows 下要安装 Dokuwiki ，一般需要如下的准备工作：

1. 配置支持 PHP 的 Web 服务器
2. 下载 最新版的 DokuWiki，解压下载文件 dokuwiki-YYYY-MM-DD.tgz
3. 复制内容到 Web 文档根目录

• 若您希望以 http://wiki.mytest.net 域名访问 WIKI 站，将 dokuwiki-YYYY-MM-DD 目录里的内容复制到 Web 文档根目录
• 若您希望以 http://mytest.net/dokuwiki 域名访问 WIKI 站，首先将 dokuwiki-YYYY-MM-DD 目录改名为 dokuwiki ，然后将 dokuwiki 目录复制到 Web 文档根目录

1. 安装 Apache2+PHP5
2. 配置 Apache
3. 下载 DokuWiki
4. 解压并修改权限

详情请参考 DokuWiki 的安装环境

1. 安装 Apache2+PHP5
2. 配置 Apache
3. 下载 DokuWiki
4. 解压并修改权限

详情请参考 DokuWiki 的安装环境

$ cd <站点根目录的上一级目录>
$ wget 'http://www.splitbrain.org/_media/projects/dokuwiki/dokuwiki-2008-05-05.tgz?id=projects%3Adokuwiki&cache=cache'
$ tar -xzf dokuwiki-2008-05-05.tgz
$ mv dokuwiki-2008-05-05 dokuwiki

1. 下载 最新版的 DokuWiki
2. 将下载文件 dokuwiki-YYYY-MM-DD.tgz 解压到本地目录
3. 上传文件至服务器的 Web 文档根目录
4. 参照上述 Dokuwiki 目录结构说明部分修改文件、目录权限

打开浏览器，在地址栏中输入 URL 进行安装。

http://www.mytest.net/dokuwiki/install.php

1. 请根据上一节服务器配置的不同选择使用不同的 URL
   • http://www.mytest.net/dokuwiki/install.php
   • http://www.mytest.net/install.php 或 http://wiki.mytest.net/install.php
2. 将 www.mytest.net（wiki.mytest.net） 换成您的域名

在页面中点击 “登录”按钮，进入登录界面，使用在安装时创建的超级用户登录。

点击“管理”按钮即可进入如下的管理界面。

• 访问控制列表（ACL）管理器 — 用于对用户和组进行访问控制
• 用户管理器 — 用户管理用户和组
• 插件管理器 — 用于安装/更新/卸载、启用/禁用 插件
• 还原管理器 — 用于管理垃圾信息
• 配置设置 — 用于对 Dokuwiki 进行配置，包括模版、插件配置等
• 人气反馈 — 收集关于本站点的匿名信息，并允许您将其发送给 DokuWiki 的开发者

点击 “配置设置”进入配置管理器对 DokuWiki 进行设置

• 若使用“面包屑”导航，可以在显示“足迹”的数量修改链接数量
• 若使用“层次式”导航，请勾选显示“您在这里”，并将显示“足迹”的数量修改为0
• 若要使用“驼峰式站内文字链接”，请勾选对链接使用 CamelCase
• 若要将页面的一级标题作为页面 Tittle，请勾选使用“标题 H1”作为页面名称，否则页面 Tittle 为页面的文件名

• 默认创建用户使用的组是 uesr
• 默认管理组(admin)中的所有用户都是超级用户，登录后会显示“管理”链接
• 在 发送新注册用户的信息给这个邮件地址 后填写 Email 地址以便及时通知管理员
• 若您的站点仅仅是个人站点，请勾选 停用 DokuWiki 功能 部分的 注册
• 若您不希望用户查看/导出源文件，请勾选 停用 DokuWiki 功能 部分的 查看源文件/导出源文件

1. 启用 rewrite：
   • 在 使用更整洁的 URL 中选择 .htaccess
   • 勾选 在 URL 中使用斜杠作为命名空间的分隔符
2. 配置 .htaccess 文件
   • 删除文件中的注释 #

参考

• DokuWiki Config userewrite
• mod_rewrite

用 wiki 语法编辑，参见 DokuWiki 语法 或DokuWiki Syntax， 或安装后自带的 语法页面。

您可以查看页面源码来学习 DoduWiki 的语法，方法是： 单击页面中的 显示源码 。

* DokuWiki 可以将源代码作语法高亮以增加可读性。所有被 GeSHi 支持的语言都可以在 DokuWiki 中得到高亮。 * 使用 code 标记时需要指定使用的语言，例如： <code java>。

class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

• DokuWiki 能使用外部 XML feeds 整合数据。
• 为了解析 XML feeds，使用了 SimplePie。
• SimplePie 能认知的所有格式都能被 DokuWiki 使用。

Example:

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

• DokuWiki 支持每个命名空间（namespace）的页面模版。
• namespace 映射到文件系统上就是目录，所以可以在 data/pages 下的每个目录中分别创建该 namespace 下所有页面的模版。
• 页面模版的文件名称约定为 _template.txt。

由于 DokuWiki 默认情况下不允许编辑以 _ 开头的文件，所以要在本地编辑该文件然后上传。

_template.txt 除了可以使用 wiki 语法之外，还支持如下的变量：

参考: Namespace Templates

• 默认情况下，DokuWiki 将在系统的 data/cache 目录下缓存页面。 若不缓存某页面，则需在编辑页面时将 ~~NOCACHE~~ 写入页首
• 默认情况下，DokuWiki 将显示每页的目录。若不显示某页的目录，则需在编辑页面时将 ~~NOTOC~~ 写入页首
• 有些字符或字符串是 Wiki 的语法字符，若只想显示其本身而不被 Wiki 引擎解析，有两种方法
  • 两端使用 %% 将内容括起来
  • 使用 <nowiki> 和 </nowiki> 将内容括起来

• DokuWiki 支持 Plugin （插件）。
• 可以到 DokuWiki Plugins 查找并下载插件。

• 插件的使用方法，请参见各自的说明页面。

• Box Plugin
• Folded Plugin
• Clearfloat Plugin
• Include Plugin
• FlashPlayer Plugin
• Video Plugin
• vCard Plugin
• Gallery Plugin

• Blog Plugin
• Tag Plugin
• Discussion Plugin
• Feed Plugin
• Avatar Plugin
• Cloud Plugin
• BookmarkMe

• Google Analytics for DokuWiki
• Google Adsense for DokuWiki
• Google Maps plugin

• Code Syntax PlugIn
• Note Plugin
• Definition list plugin
• Math Plugin
• Hidden Comment Plugin
• NsToC Syntax Plugin
• Translation Plugin
• S5 Presentations
• Keyboard Plugin
• markdown Plugin

• Task Plugin
• Repository Plugin

• GOTO Plugin
• PageMove Plugin
• BackupTool for DokuWiki

使用 Wiki管理界面中的 插件管理器 进行安装

1. 下载压缩文件
2. 解压缩并上传至 <dokuwiki>/lib/plugins 目录
3. 根据需要修改模版 （并非所有插件都需要此步骤）

一些插件可以使用 Wiki管理界面中的 配置管理器 进行配置，如：Blog/Tag/Feed/BookmarkMe等

Syntax

<box width classes colours | title text> contents text </box>

Example

<box> the box contents </box>
<box 80% round orange|a title> the box contents</box>
<box 50% left blue>the box contents</box|a caption>

Syntax

<note [important|warning|tip]>
……
</note>

<note>
This is my note ! Remember it !!
</note>

<note important>
Warning ! You're about to lose your mind ;-)
</note>

<note tip>
The clues are in the images.
</note>

<note warning>
Beware of the dog when you open the door !!
</note>

<note warning>
Beware of the dog when you open the door !!
<note tip>
The clues are in the images.
</note>
</note>

Syntax

<code lang number |[fh] text |[sh]>
{code to highlight}
</code>

<code>
some text
and more
</code>

<code 1>
some text
and more
</code>

<code JavaScript 12|Listing 2>
var de = function() {
return (typeof(window.de) == 'object') ? window.de : {};
}();
</code>

<code JavaScript 12|h Listing 2>
var de = function() {
return (typeof(window.de) == 'object') ? window.de : {};
}();
</code>

<code console>
$ sudo apt-get update
$ sudo apt-get upgrade
</code>

<code html 1|t The DokuWiki Start-Page>
extern> http://wiki.splitbrain.org/
</code>

DokuWiki 支持 Template （模版、皮肤）。可以到 DokuWiki Templates 查找并下载模版。下面列出了几个比较活跃的模版：

• Arctic
• Masa
• Simple
• Incognitek
• lmcstyle
• r7thblog1

• 较通用的模版是 Arctic、Battlehorse 适用范围比较宽泛
• 对于个人站点，推荐使用 Arctic、Masa、Battlehorse 等
• 对于 BLOG 个人站点，推荐使用 r7thblog1、lmcstyle 等
• 对于封闭性的 WIKI 站点，推荐使用 lmcstyle、mmClean 等
• 对于 WIKI 文档站点，推荐使用类似 MediaWiki 的 Monobook 或 Simple

1. 下载压缩文件
2. 解压缩并上传至 <dokuwiki>/lib/tpl/ 目录
3. 根据各个模版的使用说明进行配置

若更换模板后没有生效，请按住 Ctrl+Alt 的同时按页面刷新按钮。

1. 首先到 http://www.chimeric.de/projects/dokuwiki/template/arctic 下载适用于 Dokuwiki-2008-05-05 所需的软件包
2. 解压缩并上传至 <dokuwiki>/lib/tpl/ 目录

选择使用 Arctic 模板并保存设置

配置 Arctic 模板并保存设置

安装配置结束将显示类似如下的界面。

• 您可以到 arctic other styles 下载其他颜色的 style.ini 文件，下载并上传覆盖原来的 style.ini 文件即可
• 您也可以直接修改 style.ini 文件，例如要改变内容的显示宽度，

可以将如下行：
__wiki_width__     = "84%"
改为：
__wiki_width__     = "94%"

安装如下的插件：

安装支持 sidebar 的模板

一个站点结构示例：

/
|-- start       --- 主页
|-- blog        --- BLOG 首页
|-- blog/       --- 存放 BLOG 文章的目录
|-- archive     --- BLOG Archive 页面
|-- tagcloud    --- 存放 Tag Cloud 页面
|-- doc         --- 文档主页
|-- res         --- 资源链接首页
|-- project     --- 个人项目首页
|-- gallery     --- 个人画廊首页
`-- about

Arctic 模板支持 sidebar。要创建 sidebar 页面可以首先访问主站，然后在 URL 后添加 sidebar，回车创建 sidebar 页面

根据需要配置如下插件：

• 配置 Tag 插件
• 配置 Blog 插件
• 配置 Avatar 插件
• 配置 Discussion 插件
• 配置 Pagelist 插件
• 配置 Include 插件

点击 Main Sidebar 中的 blog 文字链接创建该页，内容如下：

~~NOTOC~~
~~BOOKMARKME:off~~
====== BLOG ======
{{blog>blog?10}}
  * {{blogfeed>blog?10|订阅BLOG内容}}
  * {{commentsfeed>blog|订阅BLOG评注}}
{{tag>blog}}

1. 首先以可写的用户登录系统，然后在 Blog 主页面中的 New blog entry: 后输入文章标题，之后单击 创建本页
2. 用 Wiki 语法写 Blog 的内容
3. 在 {{tag>}} 的 > 之后填写以空格间隔的 Tags
4. 编辑后保存

点击 Sidebar 中的 archive 链接创建 BLOG Archive 页面，内容如下：

====== BLOG Archive ======
===== 2008-06 =====
{{archive>blog?2008-06}}
===== 2008-05 =====
{{archive>blog?2008-05}}

{{tag>BLOG Archive}}

此页面需要不断维护，每隔一个月就应该添加本月的内容

点击 Sidebar 中的 archive 链接创建 BLOG Archive 页面，内容如下：

====== TagCloud ======

~~TAGCLOUD~~

{{tag>tags}}

登录用户可以在界面中书写或回复评论（可以使用 Dokuwiki 语法）。

登录用户显示效果为：

由于安装了 Avatar Plugin，Discussion Plugin 会根据登录用户注册的 Email 地址或匿名用户输入的 Email 地址显示 avatar 头像。

未登录用户默认显示为：

在管理界面中进入配置管理器，对 gallery 插件进行配置：

若您希望使用 AJAX 方式显示全图，请勾选 “Use Lightbox (implies direct linking)”之后的复选框。

点击 Sidebar 上的 gallery 链接，创建该页，内容如下：

====== Gallery ======

  * [[gallery:me:]]
  * [[gallery:penguin:]]
  * [[gallery:books:]]
  * [[gallery:ubuntu:]]
  * [[gallery:dokuwiki:]]

{{tag>gallery}}

例如点击 penguin 链接，创建一个企鹅的画廊，输入如下内容：

====== 企鹅 ======

{{gallery>:gallery:penguin?3}}

{{tag>gallery}}

点击媒体工具按钮，上传图片，之后保存页面。

1. 安装 Translation 插件
2. 配置 Translation 插件
3. 修改模板的 main.php ，在合适的位置添加如下的代码：

<?php
$translation = &plugin_load('syntax','translation');
echo $translation->_showTranslations();
?>

1. 您可以先创建主语言（没有语种名字空间，如 en、fr 等）的页面，再通过插件上的按钮创建其他的语种版本
2. 您也可以先创建一个非主语言的页面（注意在页面名称前添加语种名字空间，如 en、fr 等），再通过插件上的按钮创建其他的语种版本（包括主语言版本）

管理员可以在管理界面的用户管理器中管理用户。

管理员可以在管理界面的访问控制列表（ACL）管理器中管理ACL。

安装 Discussion Plugin 之后，管理界面会多一个 Moderate Discussions 管理工具

最方便的方法是编写脚本使用 rsync 工具进行备份和升级。

详情请参考 Dokuwiki 的日常维护。

更多内容请参考 Tips and Tricks。

谢谢大家！