用户:Sheep-realms/插件百科样式整理方案

插件百科内有大量页面样式混乱、年久失修，存在很多问题。现在要对这些问题进行修复，以下是处理方案。

条目基础结构问题

缺失右侧概述表

由于缺失例如{{Bukkit Plugin Infobox}}这样的概述表，导致条目未被归类，无法通过索引找到这些条目，具体数量未知。需要在特殊:所有页面、特殊:长页面中寻找，并补齐资料。

缺失引言

引言是条目的开篇引导语，置于概述表之下（代码层面）、第一个二级标题和目录之上。参考格式为：

'''插件名称'''是一款由作者名称开发的描述一下插件大致功能的Bukkit/Sponge插件。

滥用一级标题

一级标题（= 一级标题 =）是条目标题所用格式，一般不能应用于正文。对于有使用一级标题的条目，需要将一级标题改为二级标题，二级标题改为三级标题，如此类推。若一个条目出现了四级甚至五级标题，则需考虑重新规划结构。

由简至繁，由易至难，由高需求至低需求，循序渐进

部分条目结构规划不合理，不易于读者理解。规划条目结构时，应当将简述对象、安装流程、常见问题等简单易懂、高需求章节放置在前，技术细节、配置文件、参考文献等复杂晦涩、低需求章节放置在后。

超长页面

超长的页面会拖慢浏览器加载速度，也影响读者的阅读体验和编辑者的维护。在特殊:长页面中可以找到存在这类问题的页面。对于这类页面，应当拆分部分内容放入子页面以缩减页面长度。

• 日志、配置类文件 —— 若内容过长可以放入子页面（例如“插件名称/config.yml”），然后在主页调用（{{:插件名称/config.yml}}）。
• 大量命令语法指南 —— 需要放入子页面（例如“插件名称/命令/命令名称”），然后在主页或描述命令的子页面列出命令列表。
• 作品中大量元素的介绍 —— 需要放入子页面（例如“插件名称/物品或方块等元素”），然后在主页面或大家族模板{{Navbox}}中列出。

语法和样式规范

Wiki不是宣传册

百科网站的目的是陈述事实、传播知识。适度的样式包装有利于读者更好地了解其风格与文化，过度的样式包装会影响到最基本的阅读体验。为了确保读者在所有条目中都拥有一致的阅读体验，读者应当能在第一页阅读到条目提示信息、引言、概述表等基本内容，在不影响读者阅读上述内容的情况下可插入导航、面包屑等引导内容，上述导航内容高度不得超过半个屏幕。

此外，还应当移除以下无关信息：

• 编辑者留言
• 广告信息
• 编辑者署名、贡献感谢
• 条目统计数据
• 大版面边框包装、打乱阅读顺序的样式包装
• 巨幅LOGO（应当放置于概述表中）

分类置于底部

基于分类显示在页面底部的特性，为了便于编辑者维护，应当将条目中的分类放置于底部。

滥用br标签

有很多条目通篇使用br标签换行，导致文本排列拥挤、段落结构模糊、维护困难。应当使用两个回车分离段落，这会产生一个明显的段间距，并适当合并语句组成段落，去除不必要的换行。

大量代码文本需要放置于pre标签中/段首空格

在MediaWiki中，段首空格会被视为代码，显示为代码框。从前端设计的角度来讲，如需要首行缩进，应当使用CSS样式来完成，而非手动插入空格。

而真正的代码文本——尤其是大量代码，应当放置于pre标签中，便于编辑者理解。

滥用亮色字体

Wiki中不应使用不合理的亮色字体，须遵循网页无障碍阅读指南（Web Content Accessibility Guidelines），尤其是背景色和前景色过于相近的配色，此类颜色应当去除。

中文语境中滥用英文符号

这是一个普遍存在的问题，不合理的符号使用会影响阅读体验，须修改为正确的标点符号。

过于花里胡哨的外部链接

参考案例：

={{mCColor|&9|链接}}=

[[image:Github2.png|250px|center|link=https://github.com/JustDJplease/EnvironmentalAwareness|Github源码]]
----

改为：

== 注释与外部链接 ==
* [https://github.com/JustDJplease/EnvironmentalAwareness Github源码]

代码规范化

适当的空格与换行可以优化阅读体验。极力不推荐大段内容不留空行分隔段落。

== 二级标题 ==
=== 三级标题 ===
==== 四级标题 ====
===== 五级标题 =====
* 无序列表
̇** 缩进无序列表
# 有序列表
; 假标题
: 缩进

您可以阅读本页面源代码来了解留空行的时机。