• 欢迎来到Minecraft插件百科!
  • 对百科编辑一脸懵逼?帮助:快速入门带您快速熟悉百科编辑!
  • 因近日遭受攻击,百科现已限制编辑,有意编辑请加入插件百科企鹅群:223812289

Studio:格式规范

来自Minecraft插件百科
(重定向自Studio:编辑规范
跳转至: 导航搜索

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

格式规范

全局

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

插件页面

指令与权限列表

  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:管理,需置于页面最后。

子页面规范

关于子页面使用的相关规则。子页面命名规范即为“主页面/子页面”。

插件本体内容

  • 若某个插件的资料篇幅较小,不会因页面过长影响阅读体验,可完全放置在主页面。
  • 反之,若内容较多,可将每个小主题的内容分别放在单独的子页面,如“插件1”为主页面,“插件1/指令”为存放指令列表与用法内容的子页面。创建子页面后需在主页面保有链接,便于浏览,必要情况下可使用大家族模板。
  • 以上两种模式的选择可由编者自由决断,当产生分歧时需进行讨论进行决定。

原创教程内容

本维基站与维基百科一样架构在MediaWiki,不同于维基百科的是运行体制并不完全一致。其中一点体便是本维基站允许“无可靠来源”的内容被加入条目内容,但仅限于“插件运用教程”等原创性内容,且需要归入子页面。

  • 对于某个插件相关的教程,可以放置在对应插件主页面下的“教程”子页面中。举个例子来说,Essentials页面的原创性内容需要并将被归入子页面Essentials/教程
  • 当有多个关于某个插件的教程时,每个教程需放置在插件主页面下“教程”子页面下的一个单独子页面中。在此模式下,插件的“教程”子页面将作为索引使用,存放所有相关教程的链接。如对于“插件1”这个插件,作者A的教程可放置在“插件1/教程/作者A的教程”页面,作者B的教程则放置在“插件1/教程/作者B的教程”页面中,“插件1/教程”页面存放两个子页面的链接。
  • 对于不对应与某个特定插件的教程,如开发教程,可放置在教程页面的子页面中,教程页面为此类教程的索引页面。

参见