用户:LocusAzzurro/draft

本规范旨提供一些准则、规范、方针与指导，使得所有条目的编辑风格变得一致，并增加页面的可读性与可维护性。本篇仅对一些需要注意的部分进行说明，未尽内容请在编辑时运用常识判断。

格式规范

全局

1. 建议在每个主条目的第一段第一句对条目内容进行简要的介绍。（如对于插件可为插件的基本功能介绍。）
2. 条目正文请使用正规的书面汉语，需要注意包括但不限于中文标点使用、列举使用顿号分隔、人称代词等问题，可参考Minecraft中文Wiki相关说明。
3. 分段标题需使用双等号==进行标记，如== 章节标题 ==，更深层分段则使用更多的等号，页面正文不可使用一级标题，分段标题中应避免其他格式代码与连接。
4. 正文中换行优先使用双空行，仅在需要时使用
代码，且需要注意不要添加过多空行。
5. 页面排版请以阅读友好性、页面整洁为前提进行，避免在页面中大量使用，或使用不必要的排版与样式元素。

插件页面

指令与权限列表

1. 权限与指令列表优先使用表格进行排版，并使用class="wikitable"样式。
2. 根据关联性、复杂度和原文格式，权限与指令列表可考虑置于同一表格，若各自说明内容较多则分为两个表格。
3. 指令中所使用的参数可与指令同列，也可分列。一般情况下，尖括号< >标示必须参数(requied)，方括号[ ]表示可选参数(optional)，减号-与字母组合表示标示参数(flag)。

权限	指令	介绍	默认使用者
foo.bar.a	/foo bar a [参数1]	<指令与权限说明>	OP
foo.bar.b	/foo bar b <参数1> [参数2]	<指令与权限说明>	Default

配置文件与语言文件

1. 配置文件的展示方式可使用列表，也可使用代码块，编者可根据原文中的样式与展示方式进行选择。
2. 若配置文件原文提供了明显的键值对，则优先使用表格进行展示，此处同样使用class="wikitable"样式。
3. 若配置文件原文提供了完整的排版后的配置文本，则优先使用代码块进行展示，此处推荐使用语法高亮功能。
4. 语言文件以及其他相关类型文件同理。

配置项	默认值	介绍
foo.bar.a	10	<配置选项说明>
foo.baz	true	<配置选项说明>

Foo:
    Bar: # <comment 1>
       Bar1: 'XYZ'
       Bar2:
           # <comment 2>
           x1: true
           # <comment 3>
           y1: 3
    Qux: true

命名规范

1. 插件主页面名称需使用在发布平台出现的官方命名，而非民间译名或缩写等。
2. 涉及Minecraft原版内容的相关译名，请尽可能参照标准译名。

页面布局

为保证页面可读性与美观性，特定类型的所有页面需遵循一定的布局规则。

全局

1. 页顶提示模板，如Template:待翻译需置于所有内容之上。
2. 分类内容，如[[Category:服务端]]，需置于页面最后。

插件页面

所有插件相关主页面中的内容顺序应遵循规则：

1. 插件信息模板，即Template:Bukkit Plugin Infobox，需置于正文之前，页顶提示模板之后（如有）。
2. 插件分类内容，如[[Category:管理]]，需置于页面最后。

以下来自重构文档

[全局][格式手册] 权限、命令、lang、config列表统一格式 （需讨论格式，蓝鸡建议：权限与命令列表统一使用wikitable style表格，根据需要对列进行命名，可自行处理宽度分配。config/lang若为keypair则使用表格，若为完整yml则使用codeblock）

[全局][格式手册] 清理正文一级标题 （蓝鸡：也许可以弄个检测）

[全局][格式手册] 页顶提示置于正文前 （页顶模板 -> 插件信息模板 -> 正文）

[全局][格式手册] 分类等置于最后

参考

MCW:帮助:编辑手册

MCW:书面汉语指导

WP:格式手册

MCBW:格式规范