模板:WPBannerMeta/doc
此页面是Template:WPBannerMeta的模板文档。 此页面可能包含了模板的使用说明、分类和其他内容。 |
此模板文档被引用于约671,000个页面,占全部页面的9%。 为了避免造成大规模的影响,所有对此模板文档的编辑应先于沙盒、测试样例或您的沙盒上测试。 测试后无误的版本可以一次性地加入此模板文档中,但是修改前请务必于讨论页发起讨论。 模板引用数量会自动更新。 |
有机器人使用本模板文档
如欲移动、删除或修改此模板文档而无法向下兼容,并会影响机器人运作,请先通知机器人操作者,谢谢您。相关的机器人:User:Cewbot/log/20200122/configuration |
WPBannerMeta是一个元模板,能用来创建专题横幅,能方便地在条目讨论页创建横幅,从而使每个专题协调工作。所有使用该模板的横幅列表见链入页面:WPBannerMeta
该模板为元模板,用途为构建其他模板。因此请不要在讨论页直接使用此模板,而是通过专题模板调用。
语法
编辑
| ||
|
WPBannerMeta能以不同的复杂度使用,既可很简单也可极复杂。简单的选项在此先行列出,而其余复杂的内容则在页面下方。
WPBannerMeta使用两类不同的参数,分别是格式和显示参数。格式参数可为特定专题自定义本元模板,用于定义链接目标、分类、图像和文字。所有格式参数均使用大写字母,并用下划线(_)代替空格(例如|PROJECT=
和|NOTE_1_CAT=
)。显示参数则为横幅所在的单个条目定义其模板输出,这些参数会出现在条目讨论页(|class=
,|importance=
等),并且在底层必须由专题横幅“传递”到元模板。为传递参数foo
,则需要包含代码foo={{{foo|}}}
。
下文将以当前并不存在的郁金香主题与郁金香专题为例介绍专题横幅的构建。
简单选项
编辑PROJECT
(专题,必填)– 专题名称,不含“专题”二字。例如:郁金香
substcheck
(替换引用检查)– 该参数允许模板侦测其是否误被替换引用,而非内嵌于页面,并会给出错误消息。substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
small
(微型,必填) – 尺寸参数必须传递至模板以正确显示。例如:small={{{small|}}}
category
(分类,必填)– “category”参数必须传递至模板。例如:category={{{category|¬}}}
。category_trad
(分类是否为繁体)–当“PROJECT
”参数以繁体中文填写时,请指定该参数为yes
,确保条目评级分类不会繁简混杂。
listas
(列为,必填)– “listas”参数必须传递至模板。例如:listas={{{listas|}}}
(横幅名称,必填)– 横幅页面的全名。例如:BANNER_NAME={{subst:FULLPAGENAME}}
Template:WikiProject Tulips
PROJECT_LINK
(专题链接)– 模板默认专题位于"专题:<PROJECT>"
。若属其他情况,请在此参数定义专题页的完整链接。例如:专题:郁金香
IMAGE_LEFT
(左侧图像)– 横幅左上角的图像地址,请勿加入“'File:”或“File:”前缀。专题横幅使用的图像必须是自由图像,不得使用合理使用图像。例如:Tulipa suaveolens floriade to Canberra.jpg
IMAGE_LEFT_SMALL
(左侧小图)– 横幅以“微型”显示时的IMAGE_LEFT
的图片大小,默认为40px。例如:25px
IMAGE_LEFT_LARGE
(左侧大图)– 通常显示的IMAGE_LEFT
图片大小,默认为80px。例如:50px
IMAGE_RIGHT
(右侧图像)– 横幅右上角的图像地址,请勿加入“'File:”或“File:”前缀。专题横幅使用的图像必须是自由图像,不得使用合理使用图像。例如:Tulipa suaveolens floriade to Canberra.jpg
IMAGE_RIGHT_SMALL
(右侧小图)– 横幅以“微型”显示时的IMAGE_RIGHT
的图片大小,默认为40px。例如:25px
IMAGE_RIGHT_LARGE
(右侧大图)– 通常显示的IMAGE_RIGHT
图片大小,默认为80px。例如:50px
MAIN_TEXT
(主文本)– 默认文本为“本条目属于[[{{{PROJECT}}}专题]]的范畴,一个旨在改善中文维基百科{{{PROJECT或MAIN_ARTICLE}}}类条目内容的项目。如果您有意参与,请浏览专题主页,参与其[[Talk:{{{PROJECT_LINK}}}]]并完成相应的开放性任务。”定义本参数则可显示其他文本。PORTAL
(主题)– 若该专题包含有主题,请为此参数定义主题名。例如:郁金香
PORTAL_IMG
(主题图像)– 默认为“拼图”图标,可定义此参数换用其他图像。 例如:Icon tools.svg。
MAIN_CAT
(主分类)– 默认不创建主分类,若定义该参数,所有显示该模板的页面都将归入Category:MAIN_CAT
。例如:郁金香专题条目
→ Category:郁金香专题条目BOTTOM_TEXT
(底文本)– 若定义此项,文本将显示在横幅底部、折叠区(若显示)上端。请勿使用此参数挂接其他代码到模板底部,请参见下文钩子一节寻求更好的解决办法。
- 示例
{{WPBannerMeta |PROJECT = 郁金香 |BANNER_NAME = Template:WikiProject Tulips |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly> |small={{{small|}}} |category={{{category|¬}}} |listas={{{listas|}}} |PROJECT_LINK = 专题:郁金香 |IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg |IMAGE_LEFT_SMALL = 25px |IMAGE_LEFT_LARGE = 50px |MAIN_ARTICLE = [[郁金香]]及[[百合科]]相关条目 |PORTAL = 郁金香 |PORTAL_IMG = Tulipa florenskyi 4.jpg }} |
- 显示为:
郁金香专题 | (获评非条目级) | |||||||
---|---|---|---|---|---|---|---|---|
|
评级
编辑许多专题使用条目质量评级标准评价其条目质量,并使用条目重要度评级标准为其排定优先级。为了让专题委员会及各专题使用机器人编制条目状态表,您需要遵守/使用机器人指南,并掌握下列要点:
QUALITY_SCALE
(质量评级标准)– 用于配置质量评级标准,可选项有:class
(等级,必填)– 若使用质量标准,class参数必须传递至元模板。例如:class={{{class|}}}
auto
(自动)若需要自动评级选项,auto参数必须传递至元模板。例如:auto={{{auto|}}}
使用机器人自动为小作品分类的专题,可令机器人在其专题横幅加入|auto=yes
,横幅即可提示该条目系由机器人自动评级。AUTO_ASSESS_CAT
(自动评级分类)–若定义该参数,所有包含|auto=
参数的条目均会归入Category:AUTO_ASSESS_CAT
。默认归类至Category:自动评级PROJECT
条目。例如:自动评级郁金香和水仙条目
→ Category:自动评级郁金香和水仙条目
B_CHECKLIST
(乙级检查表)– 若定义此项,即可启用乙级检查表。乙级条目官方描述包含六项指标,各条目对各项标准的符合/不符状态通过|b1=
至|b6=
加以传递。仅当某条目六项均达标时方可评为乙级,否则则为丙级。b#
– 若使用乙级检查表,六项乙级指标必须传递至元模板。- 若使用自定义等级,必须将标准参数传递至元模板。例如:
b1={{{B-Class-1|{{{b1|}}}}}}
等。 - 若使用标准参数,则例如:
b1={{{b1|}}}
等即可。
- 若使用自定义等级,必须将标准参数传递至元模板。例如:
importance
(重要度)– 若定义此项,即可启用重要度评级标准(极高、高、中、低、极低、无、不适用、未知)。例如:importance={{{importance|}}}
priority
(优先级)– 若定义此项,即可启用优先级评级标准(极高、高、中、低、不适用、未知)。例如:priority={{{priority|}}}
。importance、priority二参数只可用其一。IMPORTANCE_SCALE
- standard(标准)– 使用标准评级标准。本项为默认。
- inline(内联)– 允许使用简单的自定义质量标准,通常搭配{{Class mask}}使用。
- subpage(子页面)– 允许使用更复杂的自定义质量标准,需创建名为“/importance”的子页面。详见自定义掩码。
ASSESSMENT_LINK
(评级链接)– 特定专题质量(和/或重要度)评级标准的链接,若存在"专题: <PROJECTLINK>/评级"
页面,则该页即为默认链接。若需指定其他页面,可将该参数设为no。详见此处。ASSESSMENT_CAT
(评级分类)– 条目会根据其质量等级归入相应分类,因此郁金香“特色条目”默认会归类至Category:特色级郁金香条目。若定义该参数,特色条目则会改归类至Category:特色级ASSESSMENT_CAT
. 例如:百合科条目
→ Category:特色级百合科条目COMMENTS
(评论)– 部分专题可能希望使用条目讨论页的子页面为该条目填写简单的评级相关评论,若评论位于“{{FULLPAGENAME}}/评论
”子页面,则该参数会自动在横幅提示评论页存在与否。例如:yes
COMMENTS_CAT
(评论分类)– 若定义此项,含有评论页的条目会归入Category:COMMENTS_CAT
。页面默认会归入含有评论页的PROJECT条目。例如:(可选)含有评论页的郁金香和水仙条目
→ Category:含有评论页的郁金香和水仙条目。使用none
值则不会归类。COMMENTS_FORCE
(强制评论)– 默认情况下,评论子页面不存在时并不会显示消息。若定义该参数,则会显示消息要求评级者创建评论页。例如:yes
- 示例
{{WPBannerMeta |PROJECT = 郁金香 |BANNER_NAME = Template:郁金香专题 |small={{{small|}}} |category={{{category|¬}}} |listas={{{listas|}}} |IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg |QUALITY_SCALE = extended |class={{{class|}}} |auto={{{auto|}}} |importance={{{importance|}}} |ASSESSMENT_LINK = 专题:郁金香/条目评级 |COMMENTS = yes |COMMENTS_CAT = |COMMENTS_FORCE = yes }} |
- 显示为:
郁金香专题 | (获评模板级、不适用重要度) | |||||||
---|---|---|---|---|---|---|---|---|
|
警报与提示
编辑WPBannerMeta能显示许多包含条目信息和其相关工作组的的字段,并预设有“attention”字段供标记需要立即受到关注的条目,以及“needs-infobox”字段供标记需要信息框的条目。
attention
(关注)– 请传递该参数以启用相关提示。例如:attention={{{attention|}}}
,然后在相关讨论页加入|attention=yes
。ATTENTION_CAT
(关注分类)– 若定义该项,所有显示关注提示的条目都将归类至Category:ATTENTION_CAT
。默认情况下,条目会归入Category:需要关注的PROJECT
条目。例如:需要关注的原种郁金香工作组条目
→ Category:需要关注的原种郁金香工作组条目。使用none
值则不会归类。
infobox
(信息框)– 请传递该参数以启用相关提示。例如:infobox={{{needs-infobox|}}}
,然后在相关讨论页加入|needs-infobox=yes
。INFOBOX_CAT
(信息框分类)–若定义该项,所有显示需要信息框提示的条目都将归类至Category:INFOBOX_CAT
。默认情况下,条目会归入Category:需要信息框的PROJECT
条目。例如:需要信息框的原种郁金香工作组条目
→ Category:需要信息框的原种郁金香工作组条目。使用none
值则不会归类。
note 1
(提示1)–请传递该参数以定义任意提示。例如:note 1={{{needs-photo|}}}
,然后在相关讨论页加入|needs-photo=yes
。横幅核心内最多可定义10个提示信息。NOTE_1_TEXT
(提示1文本,必填)– 提示1的文本。例如:根据标记,本条目需要照片。NOTE_1_IMAGE
(提示1图像)– 每个提示均可指定一幅图像,请谨记必须使用自由图像,而非合理使用图像。例如:Gnome-dev-camera.svg
NOTE_1_FORMAT
(提示1格式)– 注释表格的可选格式(如颜色等)例如:style="background:blue"
NOTE_1_CAT
(提示1分类)–若定义此项,所有显示提示1的条目均会归入Category:NOTE_1_CAT
。例如:需要照片的郁金香条目
→ Category:需要照片的郁金香条目
COLLAPSED
(可否折叠)–当显示在页面的注释和警报多于某一临界值时,便会自动折叠隐藏。设置本参数即可自定义该临界值,确定页面上不会引发折叠的提示的最大数量。默认为3,所以如果页面上有三条提示,此时提示区并不会折叠,但如果显示出第四条便会出现折叠框。因此若设置|COLLAPSED=0
,便能使提示区始终折叠,而设置|COLLAPSED=999
则可使其永不折叠。请参见/notecounter hook。例如:6
- 示例
{{WPBannerMeta |PROJECT = 郁金香 |BANNER_NAME = Template:WikiProject Tulips |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly> |small={{{small|}}} |category=no |listas={{{listas|}}} |IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg |QUALITY_SCALE = extended |class={{{class|}}} |ASSESSMENT_LINK = 专题:郁金香/条目评级 |attention={{{attention|}}} |ATTENTION_CAT = |infobox={{{needs-infobox|}}} |INFOBOX_CAT = |note 1={{{needs-photo|}}} |NOTE_1_TEXT = 根据标记,本条目需要[[照片]]。 |NOTE_1_IMAGE = Gnome-dev-camera.svg |NOTE_1_FORMAT = style="background:blue" |NOTE_1_CAT = 需要照片的郁金香条目 |note 2 = {{{audio-file|}}} |NOTE_2_TEXT = 本条目含有对应[[音频文件格式|音频文件]]。 |NOTE_2_IMAGE = Nuvola apps arts.svg |NOTE_2_CAT = 含音频文件的郁金香条目 }} |
- 显示为:
郁金香专题 | (获评丙级) | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
工作组
编辑WPBannerMeta最多能容纳五个工作组,每个都可以拥有自己的图像、链接和重要度评级标准。下列参数可用:
tf 1
(工作组1)– 必须传递该参数以启用工作组的功能和信息显示。 例如:tf 1={{{floridiae|}}}
TF_1_LINK
(工作组1链接)– 工作组专题页面的完整名称。例如:专题:郁金香/工作组/原种郁金香
TF_1_NAME
(工作组1名称)– 该工作组在内部链接上所显示的名称,若使用|TF_1_TEXT=
则无需此参数。 例如:原种郁金香工作组
TF_1_NESTED
(工作组1嵌套)– 若定义此项,则当该横幅折叠在{{WikiProjectBannerShell}}内时,形如“/ [[{{{TF_1_LINK}}}|{{{TF_1_NESTED}}}]]”的链接会加入在主专题名之后。例如:原种郁金香
TF_1_TEXT
(工作组1文本)– 若定义此项,可替换默认“本条目由……提供支持" 文本。例如:本页面属于[[专题:郁金香/工作组/原种郁金香|原种郁金香工作组]]的范畴,欢迎新成员加入!
TF_1_IMAGE
(工作组1图像)– 可为每个工作组指定图像,请谨记必须使用自由图像,而非合理使用图像。 例如:Tulipa florenskyi 4.jpg
TF_1_SIZE
(工作组1尺寸)– 图像尺寸可在此处指定,默认为30px。使用比|IMAGE_LEFT_LARGE=
还要大的尺寸还出现一些……很有趣的……结果。例如:40px
TF_1_QUALITY
(工作组1质量)– 若定义此项,即可为该特谴队启用与主专题相同的质量评级分类(例如:Category:特色级郁金香条目)。评级由|class=
产生,并使用|QUALITY_SCALE=
。例如:yes
tf 1 importance
(工作组1重要度)– 若定义此项,即可为该特谴队启用单独的重要度(或优先级)评级标准。例如:tf 1 importance={{{原种郁金香-importance|}}}
TF_1_ASSESSMENT_CAT
(工作组1评级分类,若启用评级则必填)– 用于该工作组专门的质量和重要评级的分类,语法与|ASSESSMENT_CAT=
相同。例如:原种郁金香条目
→ Category:特色级原种郁金香条目tf_1_category_trad
(工作组1分类是否为繁体)– 若TF_1_ASSESSMENT_CAT
使用繁体中文,请指定该参数为yes
,确保工作组评级分类不会繁简混杂。
TF_1_MAIN_CAT
(工作组1主分类)– 若定义此项,所有显示“工作组1”的页面均会归入Category:TF_1_MAIN_CAT
。例如:原种郁金香条目
→ Category:原种郁金香条目
- 示例
{{WPBannerMeta |PROJECT = 郁金香 |BANNER_NAME = Template:郁金香专题 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly> |small={{{small|}}} |category={{{category|¬}}} |listas={{{listas|}}} |IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg |QUALITY_SCALE = standard |class={{{class|}}} |tf 1={{{floridiae|}}} |TF_1_LINK = 专题:郁金香/工作组/原种郁金香 |TF_1_NAME = 原种郁金香工作组 |TF_1_NESTED = 原种郁金香 |TF_1_TEXT = |TF_1_IMAGE = Tulipa florenskyi 4.jpg |tf 1 importance={{{floridiae-importance}}} |TF_1_ASSESSMENT_CAT = 原种郁金香条目 |TF_1_MAIN_CAT = 原种郁金香条目 }} |
- 显示为:
本模板文档属于下列维基专题范畴: | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
高级功能
编辑钩子
编辑WPBannerMeta含有许多“钩子”,可提供更多高级和自定义功能。各子模板会传递至关联钩子参数,任何关联参数都应再传递至钩子模板——可能需要重复已经传递至主模板的参数(通常用 (|category={{{category|¬}}}
和|class={{{class|}}}
)。如果您认为您写的钩子可能会被其他专题用到,请将其复制或移动至Template:WPBannerMeta/hooks的子页面,并加入到该页的列表中。
自定义掩码
编辑WPBannerMeta使用掩码规范化|class=
参数的值,以过滤无效输入(如|class=烧饼
),并使类似的输入等效化(如|class=FA
和|class=特色
)。本掩码能有效控制可接受哪些扩展等级标准值(如“模板级”、“重定向级”等)。希望使用其他等级(如“未来级”、“乙+级”),或不想使用全部标准等级(如不用“丙级”)的专题也可以指定自己的自定义掩码。
其他细节
编辑本元模板会自动将所有实例(即特定的专题横幅)归入Category:专题横幅,因此无需在其文档中为各专题横幅加入分类。
WPBannerMeta模板核心:
为降低未使用到WPBannerMeta全部功能的横幅的字节数,大部分可选功能均被拆分至各子页面:
- Template:WPBannerMeta/class – 规范化
|class=
输入的掩码 - Template:WPBannerMeta/comments – 当定义
|COMMENTS=yes
时显示的消息 - Template:WPBannerMeta/importancescale – 重要度评级系统
- Template:WPBannerMeta/warnings – 误植模板时显示的警告
- Template:WPBannerMeta/note – 单独的提示
- Template:WPBannerMeta/qualityscale – 质量评级系统
- Template:WPBannerMeta/taskforce – 显示各工作组
- Template:WPBannerMeta/templatepage – 仅在模板页显示的分类和提示
参见
编辑- Template:Class mask – WPBannerMeta的默认质量等级掩码