查看“帮助:模板”的源代码

{{引自其他wiki|中文维基百科|帮助:模板}}

'''模板'''在维基系统（MediaWiki）中是一个可以加入另一个页面的页面。这一加入过程叫做嵌入，就好像计算机语言中的子程序。

本文提供维基百科模板的使用手册和指南，另外，
*模板简介在[[帮助:模板入门]]；
*模板分类在[[:分类:页面模板]]；
*模板名字空间的帮助信息在[[希灵百科:名字空间#“模板”名字空间|希灵百科:名字空间]]；

==概述==

'''模板名字空间'''是以“'''Template:'''”开头的[[希灵百科:名字空间|名字空间]]，这个前缀是跨语言的。

在此名字空间的页面叫做'''模板'''，此页面的内容是用来通过嵌入技术加入到其他页面中，从而创建复杂的文档。

将名为“Template:模板名”的模板加入页面中的语法是<code><nowiki>{{模板名}}</nowiki></code>，这个叫做模板标签。例如：“<code>一二<nowiki>{{三到六}}</nowiki>七八</code>”中使用了内容为“<code>三四五六</code>”的模板[[Template:三到六]]，结果就是“一二三四五六七八”。模板标签使得编辑页面在生成时找到并添加了模板，有时候我们还用诸如“调用”、“参考”、“包括”、“嵌入”、“使用”等词来替代“添加”或者“加入”，实际上描述的都是同一个过程。

如果“Template:模板名”不存在，<code><nowiki>{{模板名}}</nowiki></code>的作用就与<code><nowiki>[[Template:模板名]]</nowiki></code>相同，提供一个连接到不存在页面的链接。所以，一种创建模板的方法就是先放一个模板标签在页面里，然后点击它开始编辑模板。

如果一个页面不是以“Template:”开头，则不属于模板，但也可以使用模板标签，例如<code><nowiki>{{帮助:模板入门}}</nowiki></code>会将[[帮助:模板入门]]中的内容加入到该页来。这样一来，所有页面都可以当作是模板。但是，使用在模板名字空间的页面（即真正的模板）有以下独特的好处：
*所有被页面使用的模板都在页面编辑页显示出来。
*当模板改变时，所有使用模板页面的服务器缓存（相对于浏览器缓存）自动被清空；而位于其他名字空间的页面，服务器缓存往往要手工清空。

而模板名字空间以外的页面一般在如下情况下作为模板使用：
*引用维基百科名字空间的界面消息。
*将长页面（名字就叫做“长页面”）拆分为较短页面时，可以将短页面命名为“长页面/第一部分”、“长页面/第二部分”等，然后使用<code><nowiki>{{/第一部分}}<br />{{/第二部分}}</nowiki></code>来拼成长页面。[[希灵百科:模板消息/全部]]就是一个好例子。

一个模板可以调用另一个模板，它也可以调用它自己（自我调用），但只有一层自我调用有效。例如：<nowiki>[[Template:模板1]]</nowiki>的内容编辑内容是<code><nowiki>“一次，{{模板1}}”</nowiki></code>，在<nowiki>[[Template:模板1]]</nowiki>中将显示：<nowiki>“一次，一次，{{模板1}}”</nowiki>，如果其他条目调用该模板，所加入的文字将是<nowiki>“一次，{{模板1}}”</nowiki>。<!-- However, with templates redirecting to the template that one would want to call recursively, one can achieve recursion without having to make copies of the whole template content, with the number of levels limited by the number of redirects. See also Repetition within a page and m:Template:List of template calls (talk, backlinks, edit).-->

模板中[[帮助:变量|变量]]在模板被加入某页面后才被赋值，而不是之前。因此，如果一个模板中含有<code><nowiki>{{PAGENAME}}</nowiki></code>，该模板被某页面调用，相应的位置显示的将是调用页面的名称，而不是被调用模板的名称。

一个页面所调用的所有模板都在该页编辑页面中列出，并提供相应的链接，而且：
*只列出以“Template:”开头的真正模板（位于模板[[帮助:名字空间|名字空间]]的页面），其他被调用的页面则不列出；
*一个段落的编辑页面列出的是所有被调用的模板，包括其他段落调用的模板；
*编辑旧版本的页面，这个列表仍然是当前最新的；
*如果不真正提交编辑，仅仅在预览中使用的模板不被列出。

请注意，如果页面结尾没有换行，编辑页面中总是在结尾添加一个换行，但这并不影响模板的某些效果，即这个换行不真正起作用。例如：
 <nowiki>{{编号演示}}{{编号演示}}</nowiki>
 <nowiki>{{编号演示}}</nowiki>
的结果是：
{{编号演示}}{{编号演示}}
{{编号演示}}

==参数==

模板可以使用[[zhwiki:参数|参数]]，通过参数命名或者编号可以区分各个参数。

===参数的定义和调用===

在模板页面中，用三个[[zhwiki:大括号|大括号]]可以调用参数，例如：<code><nowiki>{{{参数1|参数1的默认值}}}</nowiki></code>可以调用''参数1''，如果在模板调用中参数1没有赋值，则使用''参数1的默认值''作为参数1的赋值。在调用带参数的模板的时候，语法是：
*如果在模板页面中参数使用是名称形式，即诸如<code><nowiki>{{{参数1}}}</nowiki>...<nowiki>{{{参数2}}}</nowiki>...</code>，则调用是使用<code><nowiki>{{甲模板|参数1=参数1的赋值|参数2=参数2的赋值}}</nowiki></code>；
*如果在模板页面中参数使用是编号形式，即诸如<code><nowiki>{{{1}}}</nowiki>...<nowiki>{{{2}}}</nowiki>...</code>，则调用是使用<code><nowiki>{{甲模板|参数1的赋值|参数2的赋值}}</nowiki></code>。

'''注意：'''参数默认值同参数赋空值是不同的。

====例1：含有命名参数的模板====

我们可以创建一个名为'''姓名'''的模板，即<nowiki>[[Template:姓名]]</nowiki>，内容为：
 我是<nowiki>{{{姓}}}{{{名}}}。</nowiki>
如果用<code><nowiki>{{姓名}}</nowiki></code>调用这个模板，我们会得到：
:我是<nowiki>{{{姓}}}{{{名}}}。</nowiki>
如果用<code><nowiki>{{姓名|姓=张|名=飞}}</nowiki></code>，我们则得到：
:我是张飞。

====例2：含有编号参数的模板====

再来一个例子，说明一个编号参数的定义和调用：我们还是先要定义一个带参数的模板，例如模板<nowiki>[[Template:数数]]</nowiki>的内容是
 一二三<nowiki>{{{1|四五六}}}</nowiki>七八九
赋值调用<code><nowiki>{{数数|六五四}}</nowiki></code>的结果是：
:一二三六五四七八九
赋空值调用<code><nowiki>{{数数|}}</nowiki></code>的结果是：
:一二三七八九
未赋值调用，即调用默认值，<code><nowiki>{{数数}}</nowiki></code>的结果是：
:一二三四五六七八九

===参数值的限制===

*如果参数值中含有等号（<code>=</code>），调用模板时则必须使用参数名，即使参数名只是一个编号也要使用。
*如果参数值中含有两个连续的右大括号（<code><nowiki>}}</nowiki></code>），调用参数时必须将其放入nowiki标记中，例如<code><nowiki><nowiki>}}</nowiki></nowiki></code>。
*如果参数值中含有竖线（<code><nowiki>|</nowiki></code>），调用参数时必须将其放入nowiki标记中，例如<code><nowiki><nowiki>|</nowiki></nowiki></code>。
*参数值可以很长，英文帮助中有一个长参数的例子：[http://meta.wikimedia.org/wiki/Help:Long_parameter_demo 例子]。
*参数值中可以包含一对双方括号，用于链接一个条目，但不能含有半个右双方括号，然后再接半个左双方括号。例如<nowiki>[[Template:数数]]</nowiki>中的内容是：
 <nowiki>[[一二{{{1}}}六七]]</nowiki> 
:调用<nowiki>{{数数|三]]四[[五}}</nowiki>的结果是：
::<nowiki>{{数数|三]]四[[五}}</nowiki> 

===命名？还是编号？===

====编号参数的优点====
#调用模板是不需要参数名和等号，从而节约打字和存储空间。
#阿拉伯数字是世界性的，在翻译的时候省事，也可以被不懂中文的人理解。

====命名参数的优点====
*参数的顺序可以变化，模板的参数可以任意添加和修改，而不会对调用模板的页面产生致命影响。
*参数的意义容易理解。
<!---*some special techniques use the fact that multiple assignments of values to the same parameter in the same template call is allowed and results in the last value being used; this implies that at least one parameter name is specified explicitly in the template call --->

====命名参数和编号参数混合使用====

命名参数和编号参数可以混合使用，此时的未命名参数根据位置被编号，命名参数不被编号。

'''例3：'''模板<nowiki>[[Template:又数数]]</nowiki>的内容是
 <nowiki>{{{1}}}、{{{2}}}、{{{3}}}</nowiki> 
<code><nowiki>{{又数数|3=1|2|1=3|4|5|6|7}}</nowiki></code>的结果是
:3、4、5
想想为什么...

===未赋值并且没有默认值的参数===
例如：模板<nowiki>[[Template:再数数]]</nowiki>的内容是
 <nowiki>一-{{{1}}}-三-{{{2}}}-五</nowiki>
调用<code><nowiki>{{再数数||}}</nowiki></code>的结果是
:一--三--五
调用<code><nowiki>{{再数数|二|}}</nowiki></code>的结果是
:一-二-三--五
调用<code><nowiki>{{再数数||二}}</nowiki></code>的结果是
:一--三-二-五
调用<code><nowiki>{{再数数|二|{{{1}}}}}</nowiki></code>的结果是
:一-二-三-<nowiki>{{{1}}}</nowiki>-五
调用<code><nowiki>{{再数数|{{{1}}}|四}}</nowiki></code>的结果是
:<nowiki>一-{{{1}}}-三-四-五</nowiki>
调用<code><nowiki>{{再数数|{{{1}}}|{{{2}}}}}</nowiki></code>的结果是
:<nowiki>一-{{{1}}}-三-{{{2}}}-五</nowiki> 

===参数赋值中包含参数===

如果一个参数未赋值，则在三个大括号中的参数名在模板调用是不起参数的作用。如果要它其作用，一定要赋值。

'''例4：'''
*模板<nowiki>[[Template:数数1]]</nowiki>的内容是
 <nowiki>{{再数数|二}}</nowiki> 
:调用<code><nowiki>{{数数1|四}}</nowiki></code>的结果是：
::一-二-三-<nowiki>{{{2}}}</nowiki>-五
*模板<nowiki>[[Template:数数2]]</nowiki>的内容是
 <nowiki>{{再数数|二|{{{1}}}}}</nowiki> 
:调用<code><nowiki>{{数数2|四}}</nowiki></code>的结果是：
::一-二-三-四-五
*模板<nowiki>[[Template:数数3]]</nowiki>的内容是
 <nowiki>{{再数数|二|2={{{1}}}}}</nowiki> 
:调用<code><nowiki>{{数数3|四}}</nowiki></code>的结果是：
::一-二-三-四-五

最简单的参数迭代办法就是在模板中用同样的参数名。

'''例5：'''模板<nowiki>[[Template:姓名国籍]]</nowiki>中使用
 <nowiki>{{姓名|姓={{{姓}}}|名={{{名}}}}}{{{国籍}}}人。</nowiki> 

====进一步的讨论====

像<code><nowiki>{{再数数||四}}</nowiki></code>这样的调用将空值赋给参数1，而不是没有赋值，所以结果是
:一--三-四-五
如果我们希望参数1不赋值，则应该将参数2用命名参数形式赋值，如
 <nowiki>{{再数数|2=四}}</nowiki>
结果则是
:一-<nowiki>{{{1}}}</nowiki>-三-四-五

如果这样的参数值被赋给如<code><nowiki><font size></nowiki></code>这样的标记，会使编码错误，但这些错误会被系统（MediaWiki）忽略，而不产生奇怪的结果。请参看英文的例子：[http://meta.wikimedia.org/wiki/Template_talk:Fontsize 字体大小]。

参数“02”和参数“2”是不同的，例如模板<nowiki>[[Template:例5]]</nowiki>的内容是
 <nowiki>{{{1}}}{{{2}}}{{{02}}}</nowiki>
调用<code><nowiki>{{例5|3|4|5|6}}</nowiki></code>的结果是
:<nowiki>34{{{02}}}</nowiki> 

'''注意：'''维基系统名字空间的参数名是不同的，它们是<code><nowiki>$1, $2, ...</nowiki></code>，参见[[希灵百科:名字空间]]和[http://meta.wikimedia.org/wiki/Meta-Wikimedia:MediaWiki_namespace_text 英文维基系统名字空间文本帮助]。

==模板页==

维基系统在生成模板页面时，实际上相当于一次没有参数赋值的模板调用，因此如果参数有默认值，将被显示。例如：模板<nowiki>[[Template:数一数]]</nowiki>的内容是
 <nowiki>一二三{{{1|四五六}}}七八九</nowiki>
模板页面的内容是
:一二三四五六七八九

===讨论页===

模板页面同其他条目页面是不同的，它的目的不是将知识传递给读者，而仅仅是为系统定义模板。因此，其讨论页跟普通条目页面的讨论页也不同，主要有两个功能：
*第一部分要解释模板的作用和相关参数
**最好给出例子，调用模板的形式以及结果。
*第二部分则是普通的对模板的讨论。

<!--In complicated cases, "subst:" can be very helpful in the explanation, see below.
You can use {{doctl}} for this task.-->

===跨语言链接===

模板可以含有跨语言链接，但结果是所有调用模板的条目页面都含有了该跨语言链接，这通常是非常糟糕的事情。为了仅仅让模板本身拥有跨语言链接，而不包括使用模板的条目，我们必须使用<nowiki><noinclude></nowiki>标识。例如：
 <nowiki><noinclude></nowiki>
 <nowiki>[[en:Template:Europe]]</nowiki>
 <nowiki>[[zh:Template:欧洲]]</nowiki>
 <nowiki></noinclude> </nowiki> 

'''注意：'''在模板中使用<code><nowiki><noinclude></nowiki></code>标识时要小心！不要在<code><nowiki><noinclude></nowiki></code>之前或者<code><nowiki></noinclude></nowiki></code>之后'''加空行'''，否则空行将被当作模板的一部分反映在调用模板的条目中。系统会自动忽略<code><nowiki></noinclude></nowiki></code>之后的单个空行。

====例6：使用<nowiki><noinclude></nowiki>标识的后果====

如果在例1中的模板<nowiki>[[Template:姓名]]</nowiki>加入跨语言链接
 <nowiki>我是{{{姓}}}{{{名}}}。</nowiki>
 
 <nowiki><noinclude></nowiki>
 <nowiki>[[en:Template:Name]]</nowiki>
 <nowiki></nocinlude></nowiki>
用<code><nowiki>{{姓名国籍|姓=张|名=飞|国籍=蜀国}}</nowiki></code>调用例5中的模板<nowiki>[[Template:姓名国籍]]</nowiki>时，结果是：
:我是张飞。
:
:蜀国人。

如果希望得到的结果是：
:我是张飞。蜀国人。
在<nowiki>[[Template:姓名]]</nowiki>加入跨语言链接应该不含有换行：
 <nowiki>我是{{{姓}}}{{{名}}}。<noinclude>[[en:Template:Name]]</nocinlude></nowiki> 
'''注意：'''我们推荐您使用后面一种方式使用<nowiki><noinclude></nowiki>标识。

===模板分类===

模板也要进行分类，目的是为了更好的整理模板，以便更好的使用和管理模板。模板的分类同条目的分类相似，可以参阅有关条目分类的帮助文件，如[[帮助:分类]]等，不同之处在于对于模板的分类需要使用<code><nowiki><noinclude></nowiki></code>标识，如果不加<code><nowiki><noinclude></nowiki></code>标识，则不仅模板被分类，所有使用该模板的条目也被分入同一类。

所有模板的根目录（即分类）是[[:Category:页面模板]]，所有模板分类名最后一定要含有“模板”二字，以区别于普通条目的分类。

====例7：模板分类方法====
将例1中的模板<nowiki>[[Template:姓名]]</nowiki>分为[[:Category:人物模板]]，需要加入：
 <nowiki>我是{{{姓}}}{{{名}}}。<noinclude>[[Category:人物模板]]</nocinlude></nowiki> 
[[File:Include.png|frame|关于<nowiki><noinclude>和<includeonly></nowiki>也许这张图可以帮助你理解]]

===标识===

'''注意：'''以下内容只限于模板中使用的情况，在其他名字空间使用的情况请参考相关帮助文挡。

====<nowiki><noinclude></nowiki>====

前面已经提到，<code><nowiki><noinclude></nowiki></code>标识的作用是将<code><nowiki><noinclude></nowiki></code>和<code><nowiki></noinclude></nowiki></code>之间的文本加入所在的模板页中，而不加入调用模板的条目或模板中，针对模板的说明、分类和跨语言连接都可以置于该标识之间。

'''例8：'''针对[[Template:网球男单世界第一]]模板的分类[[:Category:体育模板]]就可以置于<code><nowiki><noinclude></nowiki></code>和<code><nowiki></noinclude></nowiki></code>之间，而对于调用该模板条目的分类<code>[[:Category:网球运动员]]</code>可以置于标识之外：
 <nowiki>[[Category:网球运动员]]<noinclude>[[Category:体育模板]]</noinclude></nowiki> 

====<nowiki><includeonly></nowiki>====

<code><nowiki><includeonly></nowiki></code>标识的作用跟<code><nowiki><noinclude></nowiki></code>标识的作用正好相反，是将<code><nowiki><includeonly></nowiki></code>和<code><nowiki></includeonly></nowiki></code>之间的文本'''不'''加入所在的模板页中，而加入调用模板的页面中。

上面的例8中针对调用该模板的条目的分类[[:Category:网球运动员]]实际上应该置于<code><nowiki><includeonly></nowiki></code>和<code><nowiki></includeonly></nowiki></code>之间：
 <nowiki><includeonly>[[Category:网球运动员]]</includeonly></nowiki>
这样，在[[:Category:网球运动员]]分类中就不会出现[[Template:网球男单世界第一]]模板了。

====<nowiki>subst</nowiki>====

'''subst'''的用法是：<code><nowiki>{{subst:模板名}}</nowiki></code>。它的作用是一次性将模板内容编译成维基文挡，加入到页面中去，而不是每次显示页面的时候调用有关模板。这样可以按模板当前的形式编辑条目，并使条目免受模板变化的影响，并减轻服务器负担。<!--大概类似于页面引用了模板的当前的oldid，这样来理解-->
{{clear}}

==作用==

如果想将同一段文本复制到两个或者多个页面，我们可以考虑使用模板，但也并不是一定要用模板。如果使用模板，要修改这段文本时，不需要针对每一个页面进行逐个修改，而只需要修改模板的内容，所有使用该模板的页面都自动被修改。由于有参数存在，所以模板文本并不需要完全一样，对于不同页面，我们可以赋不同值，从而生成不同的文本。模板不仅仅是使用方便，它有时候还可以起到控制页面统一格式的作用。

模板的一般用法有：
*提示模板，例如：[[Template:妹妹不完整]]传递“不完整”的消息。
*导航模板，用于给读者提供类似的条目，例如：[[Template:galgame公司]]。
*信息框模板，用于同一类条目中提供统一格式的信息，例如：[[Template:人物信息]]在条目右边绘制信息框，提供人物的相关信息。
*提供跨语言文本。
*提供合成图片，例如：围棋棋谱[http://en.wikipedia.org/wiki/Template:Game_of_Go_Position Template:Game of Go Position]和国际象棋棋谱和[http://en.wikipedia.org/wiki/Template:Chess_position Template:Chess position]。
*以上几种的组合。

==参见==

===中文===
*[[帮助:模板入门]]
*[[希灵百科:名字空间#“模板”名字空间|希灵百科:名字空间]]

[[分类:帮助]]