什么是 wiki

• wiki 是一种网络应用
• 遵照一定的格式, 使用纯文本书写, 输出 html 文档
• 方便的内链接, 在多个内部页面之间跳转
• 多人编辑, 支持版本历史

如何创建一个 wiki 页面

• 访问一个不存在的 url, 建立一个新的页面
  • 比如 /APageDoesNotExist
• 页面的名字必须是 首字母大写 的, 首字母大写的名字可以被 wiki 识别为内链接
• 点击 “创建页面”, 编辑
• 书写语法见 /WikiFormatting
• 编辑完点击 “预览”, 查看输出的 html 是否符合预期
• 如果没问题, 点击 “提交改动”, 即生成一个新的 wiki 页面

添加附件

• wiki 允许增加附件
• 打开一个存在的 wiki 页面, 点击页面底部的 “附件”
• 选择文件并上传
• 如果可能, 尽量书写一份 wiki 文档而不是上传一个 word 文档作为 wiki 的附件

规划 wiki 文档的层次结构

• wiki 中使用 = 到 ====== 代表 h1 到 h6 标签, 标识文档的层次结构
• 书写 wiki 文档时, 需要合理地规划层次结构, 增加文档的可读性
• 需要合理地使用表格, 列表等 html 元素, 增加文档的可读性
• 更多格式语法见 /WikiFormatting
• 当一个文档过长时, 可以考虑切分成几个文档, 或者当成一个项目

如何创建一个项目的 wiki 页面

• 一个项目通常有很多内容, 需要创建多个页面
• 先创建项目首页, 比如 /NewProject
• 再创建子页面, 比如:
  • 设计文档: /NewProject/Design
  • 如何部署: /NewProject/Deploy
• 每个子页面可以根据需要再创建子页面
• 编辑项目页面, 在底部加入下面的代码, 即可在项目页面上看到所有子页面:

== 文章列表 ==
[[TitleIndex(NewProject)]]