前端收录

来自istudylinux

命名

命名使用前端:功能名称,通常是比较容易通过命名来看出该前端的一个使用场景,比如前端:置顶按钮

内容

页面内容通常包含以下几个方面:
  • 来源
  • 依赖
  • 源码
  • 文档

来源

这个很重要!除非该前端页面是由你亲自从零开始编写,否则从哪个网站摘录复制,从中修改都请注明。通常是直接链接到参考的模板页面。

依赖

如果使用者要使用该前端,该前端可能会依赖些什么,一般来说可能会有以下情况

  1. 就模板内会使用一些解析器函数,这些函数可能被包含于某个扩展,所以在该模板的依赖可能包含某些扩展
  2. 可能模板内需要使用一些配置,比如需要在LocalSettings.php里面设置相关的变量,这个需要添加

源码

该标题下添加对应模板的源码,需要声明该模板有哪些文件,比如:

消息盒子
Mediawiki:common.js
Mediawiki:common.css

上面的内容说明了该前端具备3个页面,一个前端的主体调用页面,一个前端所使用的CSS页面,一个前端所使用的JS页面。

使用者在使用复制源码的时候,也应该使用这种层级的页面命名或者部署。 然后使用如下的模板和内容进行填充操作:

{{TabbedWindowBegin}}
=== 页面名称 ===
* 消息盒子
* Mediawiki:common.js
* Mediawiki:common.css

=== 消息盒子 ===
<syntaxhighlight lang="html" line="true">
消息盒子相关代码
</syntaxhighlight>

=== Mediawiki:common.js ===
<syntaxhighlight lang="JavaScript" line="true">
Mediawiki:common.js相关代码
</syntaxhighlight>

=== Mediawiki:common.css ===
<syntaxhighlight lang="css" line="true">
Mediawiki:common.css相关代码
</syntaxhighlight>
{{TabbedWindowEnd}}

文档

文档这个就不好说了,毕竟有的大型的模板文档里面关于如何使用都是哗啦哗啦的巨幅篇章。能复制就复制,不能复制就使用链接指过去吧。

分类

分类必须包含仓库前端