用户工具

站点工具


about:editing_guide

Wiki 编辑教程

本教程面向获得编辑权限的维护者,介绍页面编辑、DokuWiki 常用语法、图片上传、创建页面和新建分类的方法。

一、编辑前先了解

  • 页面:一个可独立访问的词条,例如 `study:gpa`。
  • 分类(命名空间):用英文冒号分隔的页面集合,例如 `study:*`。
  • 分类首页:分类中的 `start` 页面,例如 `study:start`。
  • 分类侧栏:分类中的 `sidebar` 页面,例如 `study:sidebar`。

页面 ID 建议只使用小写英文字母、数字和下划线。不要使用空格,不要随意改动已经被大量引用的页面 ID。

二、编辑现有页面

  1. 登录后打开要修改的页面。
  2. 点击右侧的“编辑本页”图标;也可以使用页面标题旁的“编辑本段”。
  3. 修改内容后填写“编辑摘要”,简要说明改了什么。
  4. 先点击“预览”,检查标题、链接、列表和表格。
  5. 确认无误后保存。

建议一次只处理一个主题。涉及政策、费用、时间、联系方式或办理流程时,应附官方来源和核对日期。

三、标题与段落

DokuWiki 使用等号表示标题,等号越多,标题层级越高:

====== 页面标题 ======

===== 一级小节 =====

==== 二级小节 ====

=== 三级小节 ===

每个页面只使用一个最高级标题。普通段落之间留一个空行,不要用连续空格模拟缩进。

四、文字格式

**粗体**
//斜体//
__下划线__
''等宽文字''
<del>删除线</del>

强制换行可在行末使用两个反斜杠:

第一行\\
第二行

只有确实需要时才使用强制换行,普通段落优先留空行。

五、列表

无序列表使用两个空格加星号:

  * 第一项
  * 第二项
    * 子项目

有序列表使用两个空格加减号:

  - 第一步
  - 第二步
    - 子步骤

不要手动输入“1.”、“2.”模拟步骤,否则插入新步骤后编号不会自动更新。

六、链接

站内页面

[[study:gpa|GPA 计算]]
[[campus:start|校园生活]]
[[study:gpa#常见误区|跳到 GPA 页的常见误区]]

外部链接

[[https://www.ahu.edu.cn/|安徽大学官网]]

链接文字要能说明目的,避免使用“点这里”。保存前检查链接是否为红色;红色链接表示目标页面不存在。

七、图片与附件

  1. 在编辑器中点击媒体管理器。
  2. 选择与页面相同或相关的分类上传文件。
  3. 文件名使用小写英文、数字和下划线。
  4. 插入图片时填写替代文字,说明图片内容。
{{:campus:building.jpg?800|教学楼外观}}
{{:study:course_table.pdf|课程安排附件}}

数字表示图片显示宽度。不要上传含有身份证号、手机号、宿舍门牌、人脸等敏感信息的图片;转载图片必须确认授权并标明来源。

八、引用、代码与原样文本

引用或重要提醒可使用引用符号:

> 政策与办理时间请以学校最新通知为准。

代码块:

<code bash> echo "example" </code>

需要展示 DokuWiki 语法而不让它被解析时,使用:

<nowiki>[[study:gpa|这段不会变成链接]]</nowiki>

九、表格

表头使用 `^`,普通单元格使用 `|`:

^ 项目 ^ 说明 ^
| 地点 | 龙河校区 |
| 状态 | 以最新通知为准 |

表格适合对比短信息。长篇说明应改用标题、段落或列表,避免在手机上出现过宽表格。

十、脚注与分隔线

脚注写法:

这是一条需要补充说明的信息((脚注内容写在这里。))。

水平分隔线:

----

分隔线不要滥用,通常标题层级已经足够区分内容。

十一、新建普通页面

推荐先在现有页面中添加链接:

[[study:new_topic|新主题]]

保存后点击红色链接,再选择“创建此页”。这样可以避免输错页面 ID,也能保证新页面至少有一个入口。

新页面应包含:

  • 清晰且唯一的页面标题。
  • 一段说明适用范围的开头。
  • 可执行的步骤或经过整理的信息。
  • 相关页面链接。
  • 政策类内容的来源和核对日期。

十二、新建分类

假设要创建 `services` 分类:

1. 创建分类首页

先创建 `services:start`:

====== 校园服务 ======

本分类收录校内办事与公共服务。

  * [[services:student_center|学生服务中心]]
  * [[services:repair|报修]]

2. 创建分类侧栏

再创建 `services:sidebar`:

**[[services:start|校园服务]]**

  * [[services:student_center|学生服务中心]]
  * [[services:repair|报修]]

----

  * [[start|返回 Wiki 首页]]

DokuWiki 会在 `services:*` 页面中优先显示这个侧栏。

3. 创建分类内页面

创建 `services:student_center`、`services:repair` 等页面,并确保侧栏中的每个链接都有实际内容。

4. 添加全站入口

编辑根侧栏 `sidebar` 和首页 `start`,加入 [[services:start|校园服务]]。如果不添加全站入口,读者很难发现新分类。

5. 检查权限

新分类可能继承上级权限。若需要限制编辑或阅读,联系管理员调整 ACL;不要通过隐藏链接代替权限控制。

十三、移动、重命名与删除

DokuWiki 默认不一定提供完整的页面移动功能。需要重命名时:

  1. 先创建新 ID 的页面并复制内容。
  2. 更新所有侧栏和正文链接。
  3. 检查“反向链接”中是否还有旧链接。
  4. 确认无引用后,再清空旧页面内容完成删除。

删除或批量移动分类前应先备份,并由管理员处理。

十四、内容质量与安全

  • 不写无法核实的政策结论,不把往年规则描述成当前规则。
  • 不公开邀请码、账号、密码、手机号、身份证号或内部文件。
  • 不提供绕过课程、考试、门禁、网络或安全规定的方法。
  • 学生经验应明确写成“经验”,并允许其他维护者修正。
  • 引用外部图片和文字时遵守版权要求。

十五、发布前检查

  1. 标题层级是否连续?
  2. 页面 ID 和分类是否正确?
  3. 是否存在红色的意外链接?
  4. 图片是否有替代文字和来源?
  5. 表格在手机端是否容易阅读?
  6. 政策、费用、时间和联系方式是否附来源与核对日期?
  7. 编辑摘要是否说明了本次变化?

完成后保存页面,并再次打开确认最终显示效果。

最后修改: