Wiki写作格式规范

来自Oasis Wiki
Subilan讨论 | 贡献2023年1月15日 (日) 23:44的版本 (已保护“写作规范”([编辑=仅允许管理员](无限期)[移动=仅允许管理员](无限期)))

为了使 Wiki 的文章在整体上呈现出整齐且易于阅读的特征,本写作规范应运而生。在 Oasis Wiki 上开始编写时,请务必遵守基本规范,至于拓展规范则可由本人喜好决定。

基本规范

规范 1:善用标题、善于划定标题层级。

title-tree-structure-example.png

这有助于让文章结构更清晰,且易于读者标记和跳转。

  • 每一段内容都应有一个明确的指向
  • 每若干段内容都应有一个明确的主题,这一主题由这部分的标题指定。
    • 标题一共有六级,最常用到的是前三级。
    • 这些标题以树状的形式划定了整篇文章的内容结构。具体转化关系见右图(单击放大)。

浏览页面时,右侧随滚动变化的目录结构被称为 TOC(Table of Content,目录)它标记了读者当前所处的位置,并且可以让读者通过点选标题跳转到相应的位置,而这一功能优点的完整体现则需要依靠标题层级划分。

规范 2:添加注释

注释可以用于注明对外部内容的引用,即来源注释:

  • 对于文章中引用的外部内容,无需像从前那样以「引用块」的形式呈现。
  • 请对任何引用的内容添加来源注释,具体操作见可视化编辑器 -> 引用 -> 基本(Ctrl+Shift+K)。
    • 在源代码编辑器中,请在引用文字的最后添加 <ref>注释内容</ref> 的标签,并确保在文章最后有 <references/> 标签。

亦可用于一般的解释性注释:

  • 解释性注释的使用操作与来源注释相同。

一个引用的例子:这是一句被引用的话,它来自 https://wiki.oases.red[1]

添加注释以后,再在页面底部添加以注释为标题的部分,并插入「参考文献列表」(在可视化编辑器中,单击插入 -> 更多 -> 参考文件列表),这一步在创建新页面添加注释时不能遗漏。

规范 3:添加空格 & 标准称呼 & 标准格式

中西文混排时,为了使文章内容美观易读,字母数字和中文之间应该有一定的间隙。为了编写方便,这一空隙可以由空格来代替。对于一些名词,尤其是英文名词,请务必使用标准称呼,以便读者查阅相关信息。

以下是一些正误对比,请务必做到使用正确示例里的格式,这将对文章整体观感、行文水平评价和读者体验大有裨益。若一篇文章的不规范内容过多,且文章内容并非主要内容,此文章可能被管理员暂时隐藏(但不会被删除)。

  • 错误示例:在mc中一般每64.16个物品为1组,有些物品不能叠加
  • 正确示例:在 Minecraft 中,一般以每 64 个或者 16 个物品为一组,有些物品不能叠加。
  • 错误示例:遇到问题了?输入指令/help可以查看帮助,或者联系管理员寻求帮助
  • 正确示例:遇到了问题?可输入指令 /help 查看帮助,或者联系管理员寻求帮助。
  • 错误示例:请确保你的电脑有至少4g的内存和1g的储存空间,windows版本在7及以上。
  • 正确示例(使用列表形式)
    • 请确保你的电脑满足如下要求:
      • 物理内存:至少 4G(或者表述为 >=4G 等
      • Windows 版本:7 及以上(或者表述为 >=7 等
  • 错误示例:服务器的官网是www.oases.red,单击此处打开。
  • 正确示例:服务器的官网是 https://oases.red
  • 错误示例:遇到这类问题时,请不要直接在群内提问.在提问的时候请带上相关的截图,配以详细的说明,因为只有这样大家才能更快更有效地解答你的问题.
  • 正确示例(不要把输入法设置为中文+半角符号的模式)遇到这类问题时,请不要直接在群内模糊地提问——请带上相关的截图,配以详细的说明。只有这样,大家才能更快、更有效地解答你的问题。
  • 错误示例:在这个链接:https://baidu.com 下载你所需要的文件,解压即可。
  • 正确示例:此处下载你所需要的文件,解压即可。

更多示例欢迎补充在此。

规范 4:勿矫枉过正

在编写 Wiki 的时候,首要需要注重的应该是内容的质量。至于上述格式方面的要求,可以在日常写作中逐渐锻炼,后期也可以进行修改和完善——而完全不需要在写文章时当作重心。

这是为了避免所谓的“规范”造成了许多阅读理解、排版方面的不便或者怪异。

规范 5:善用分类系统

分类系统可以帮助信息聚合,使得读者能够对特定类别的内容定向浏览,从而节省寻找的时间。分类时,应当按其用途、特点、内容等方面在可选分类中主观划分。

添加标签时,请先查阅目前支持的所有分类列表,再对照分类名添加分类。

注释

  1. 这句话来自 https://wiki.oases.red