CSS守则

译注:本文当前仅适用于英文站,此处仅供参考


以下守则涉及了CSS版式,主要为那些自我包含且可能导入到其它页面的版式,但本守则的大部分同样适用于在独立页面中的嵌入式CSS。

创作

CSS版式应于沙盒页面中起草。

在你觉得版式已经完工之后,你才可以将其完全移至维基中。而只有在你收到能够确认你的版式与本守则符合的技术团队(在IRC的#site11中)成员许可后,才能在维基上创建带有版式标签且处于theme:分类下的新页面。

某些老旧的版式发布到了component:分类中。请使用theme:分类。

版式必须符合如下列出的限制条件。

限制条件

若要被准许在网站上是有,你的版式必须遵守几点限制条件。

许可

版式必须发布于与维基上的其它内容相同的知识共享许可之下。

你能改什么与不能改什么

你可以改变除了工作人员在本守则上规定的东西外的任何维基上的组件样式。

你不能移除、隐藏,或“破坏”任何维基上的导航元素或评分模组。

你不能破坏维基预计期望中的结构与外观。网站应该仍然是可识别且可读的。

你可以用CSS3滤镜或者别的东西改变翻译模组(.scpnet-interwiki-frame)的样式,但是你不能将其完全移除(即使你试过用滤镜还是有非常可怕的冲突)。

基础功能

你的CSS版式必须能够在主流浏览器(Chromium、Firefox、Safari)上运作良好且至少能够在次要浏览器(IE 11等)上运作。

你的CSS版式必须如在桌面端一般在移动端运行良好。

设置好版式页

版式页就是你的CSS版式源代码存放的地方。

你必须指导用户用Wikidot的[[include]]法把你的版式加到他们的页面里(并且相应地设定好你的版式页。这里是模板。)

你不能指导用户用CSS的@import法把你的版式加到他们的页面里。1

你不能指导用户使用任何使用HTTP链接的Wikidot语法,链接必须为HTTPS。

你必须在你的版式页中提供用法介绍。注意这仅指要告诉用户输入什么才能让这个版式展现到他们的文章里。如果你的版式有什么作者应该知道如何使用的特性,那也必须要有说明。你无需引入你的版式格式实例——即使你完全可以,且绝对应该这么做!

你的版式页必须要将你的版式应用上去——也就是说,你的页面必须作为你的版式的预览。如果你用了上文的模板的话,那么这些就都已经为你做好了。

通过你的版式的技术团队成员会期望不但能看到你的CSS源代码,还能看到你的版式页的草稿。

代码膨胀

CSS版式不能含有大量无用代码。CSS版式的源代码应该包含有一点,如果有的话,除了这个版式从Sigma-9(维基的基础CSS版式)修改来的内容外的东西。大段从Sigma-9处复制黏贴的行为是严格禁止的。

对CSS熟悉的人应该能够查看你的版式并明确了解你的意图。至少你应该能够说出你为什么要选择引用某一行。

此外,若非特别需要,你应当尽量避免使用!important标记,比如在增加优先级也无法满足时提供与其它CSS的兼容性。

可访问性

在编写CSS版式时,应该要考虑到可访问性的问题。举例:

  • 这个版式对色盲人士来说可读吗?(比如其应用了如红+绿的糟糕色彩使得色盲用户难以浏览网站)
  • 这个版式是否有妨碍到屏幕阅读器的使用?(比如其有添加“隐形”内容而使得其能够被屏幕阅读器阅读到但不会被视力正常读者看见)
  • 它用的字体对所有读者来说都是易读的吗?(比如其主体字体大小过小、字体本身难以阅读)

等等。通过粗略的谷歌搜索可以很轻松地获得解决所有这些潜在问题的的最佳做法与建议。

热链

热链即将文件链接至另一个网站的做法,这既是一种非常糟糕的做法,又违反了站规。强迫他人的网站负荷你的版式图片是非常不礼貌的,且还会给你的版式带来一定程度的不可靠性——那如果那个网站消失了呢?

若想防止热链行为,在CSS版式里用到的所有的图片、字体与其它文件必须要上传到版式页内而不是从互联网上的某个地方链接过来。

然而,你允许使用某些明确鼓励用热链来为用户提供文件的网站。显著例子包括谷歌字体Lorem Picsum。若有疑问,谨慎行事并询问技术团队

此外,CSS不可由沙盒页或别的不是主网站(且在工坊外)的地方链接过来。你必须在维基用theme:页面来承载CSS版式。

HTTPS

你的CSS版式必须能完全运作于网站的HTTPS版(https://scp-wiki.wikidot.com/)下。这意味着任何内部@importurl(……)参考都必须指向HTTPS的URL。对于Wikidot来说,这意味着链接要是https://scp-wiki.wdfiles.com/local--files/分页名/文件名的形式。

注意HTTPS的wdfiles链接甚至能在普遍不支持HTTPS的沙盒中运作。

批准

在发布之前,你的版式必须要被技术团队的一员批准。他们会查看你的版式并确认其是否符合该守则。

只有运营职员及以上职位可以批准CSS版式。技术团队队长对任何批准都有最终决定权。

你可以在IRC的#site11中找到技术团队,或者通过Wikidot私信他们。

CSS版式的删除守则

CSS版式需如普通页面一样其他用户不允许对你的作品进行较大修改。小的错误被认为等同于拼写与语法错误且任何善意的用户都可以修正。

CSS版式收到通常删除守则的影响,且一旦其跌至-10的评分就会被删除。

修正不兼容的版式

若你的版式无法在主流浏览器(Chromium、Firefox、Safari、移动端、IE11)上起作用且表现完全破坏了导航、功能、或可访问性,其就需要被于网站上移除(或最低限度地,从引用块中移除),然后按照这个顺序修复。我们首先要做的是兼容性,功能,然后是可访问性。

除非特别注明,本页内容采用以下授权方式: Creative Commons Attribution-ShareAlike 3.0 License