Help:模板

本頁使用了標題或全文手工轉換
From mediawiki.org
This page is a translated version of the page Help:Templates and the translation is 98% complete.
Outdated translations are marked like this.
PD 注意:當您編輯本頁面時,即同意以CC0協議授權您的貢獻。您可以在公有領域说明页面找到更多信息。
PD

如果你需要在多个页面上包含同样的文本的话,MediaWiki的模板功能就起到作用了。 与插件和媒体文件不同的是,模板没有管理中心。编辑者可以编写新的模板、从其他wiki(如维基百科)的现有模板导入,或者导出到其他的wiki。

创建模板

模板其实也是一种标准wiki页面,但它主要会被嵌入(transclude)到其它页面中。模板的页面名称最前面都有“Template:”——將它分配到該名字空間。除此之外,创建一个模板时,像其他页面一样创建就可以了。

下面展示了模板的最簡單使用方法。假设你创建了一個名叫“Template:Welcome”的模板,其内容如下:

您好!歡迎來到wiki。

這樣,你就創建了你的第一個模板!如果你接下來插入:

{{Welcome}}

到其他任一頁面,那么,访问这个插入了模板的页面时,将会看到“您好!欢迎来到wiki。”的字样,而不是看到{{Welcome}}。模板的內容被“嵌入(transclude)”到了其他頁面,也就是说,被整合到了这个页面。

你可以在任一頁面的任何位置添加{{Welcome}},來歡迎其他人。設想一下該模板被用在100個頁面中。假设你後來將模板內容改成:

嗨,您好!歡迎來到這個奇妙的wiki。

並且重新訪問之前用到了該模板的那100個頁面,你将會看到新的文字,而不是原先的文字。你用這個方法改變了100個頁面的內容,而并不是手动修改这100个页面的内容,因爲这个模板是被嵌入這100个頁面中的。

这只是模板的一个最基本的应用。除此之外,模板还具有更多灵活易用的功能。

使用

模板有以下三种使用方法:

  • {{模板名称}}—就像上面描述的那样,当带有这个模板链接的页面被加载时,这个链接将会被[[Template:模板名称]]的当前的内容动态地替换。在页面源代码中,这个链接不会变化。
  • {{subst:模板名称}}—当这个模板链接被使用时,它将被一次性替换为截至含有这个链接的页面被保存时[[Template:模板名称]]内容:模板链接会被“替换(substitute)”为[[Template:模板名称]]的内容。这个内容成为包含的页面的一部分,可以像一般内容一样被编辑,与原来的内容分开。注意:由于引用的模板链接直接被替代,如果此后原始模板页面被更改,包含这种模板链接的页面将不会变化。
  • {{safesubst:模板名称}}—这种链接被解释为允许不打破嵌入包含的替换。见zh:Help:替换引用#safesubst
  • {{msgnw:模板名称}} 会将模板的源代码包含在页面中,类似‎<nowiki>一样。

事實上,一個普通的維基頁面也可以被用作,只要指定它所在的名字空間,所以:

  • {{Template:頁面名稱}}会包含[[Template:頁面名稱]]的内容
  • {{Talk:頁面名稱}}会包含[[Talk:頁面名稱]]的内容
  • {{:頁面名稱}}会包含[[頁面名稱]]的内容
    • {{subst::頁面名稱}}将会把它自己的內容替換为[[頁面名稱]]的内容

若這个名字空間不存在,完整的標題就會被看成模板的名稱:

  • {{Foo:Bar}}会包含[[Template:Foo:Bar]]的内容

参数

为丰富嵌入包含机制,当一个模板被嵌入时,MediaWiki允许对这个模板传递参数。由于参数的作用,模板可以提供不同的内容,拥有不同的行为。

假设你希望在其他用户的讨论页插入一条感谢函,例如:


感谢你! 感谢你的努力。 来自张三


感谢函包括感谢的原因(示例中的“你的努力”)和署名(“张三”)。您的目标是任何用户可以感谢其他用户,无论任何原因。

为了让任何人可以因为任意原因感谢任何一个人,你需要定义一个感谢函模板,这个模板被命名为Template:Thankyou 。 使用感谢函模板会让所有感谢函看起来相似,但其中指定部分内容可以自定义(如感谢的原因和署名)。 所以你需要把这些内容设置为参数。感谢函模板的核心内容如下所示。 如果我们忽略剩余元素,以对框进行格式化并放置图片,模板的核心内容将会是这样:

'''感谢你!'''
感谢 {{{1}}}。
来自 {{{2}}}

请注意{{{1}}}{{{2}}},这就是参数,它们可以随着模板引入其他页面。注意:在模板内,每一个变量都是被三组花括号包围:{{{ }}}。这与模板名称的花括号不同。

在使用模板时,需要为参数赋值,不同参数间用一个管道符(|)分隔。MediaWiki允许三种为变量赋值的方式:隐式赋值(Anonymously)、按编号赋值(Numbered)、按名称赋值(Named)。

隐式赋值

隐式赋值要求按照一定的顺序赋值:

{{Thankyou|你的努力|张三}}

在这个例子中,{{Thankyou}}模板接收参数{{{1}}}=你的努力{{{2}}}=张三,于是输出:


感谢你! 感谢你的努力。 来自张三


隐式赋值时,赋值的顺序十分重要。假如颠倒了赋值顺序:

{{Thankyou|张三|你的努力}}

输出结果为:


感谢你! 感谢张三。 来自你的努力


若想为变量隐式赋值,则该模板下所有变量必须全部隐式赋值。使用编号或名称赋值的一个变量后,便就无法访问使用隐式赋值的模板。 Any parameters identified by name, as shown below, will not be accessible to the template using ordinal numbers.
如果等号(=)出现在一个隐式模板参数的一个变量里,它将被错误地解释为一个已命名参数(在下面有解释),把等号之前的文本误认为参数名称,并把等号后面的文本作为参数的值。 当您需要在属性中包含外部链接或者HTML元素时,就会遇到这个常见的问题(参见任务T16235)。 避免这个问题的方法是使用命名参数来代替,或编号参数,见下文。

按编号赋值

按编号赋值时,需要在传递参数时给出变量的编号:

{{Thankyou|2=张三|1=你的友好}}

例中,虽然没有按变量的声明顺序赋值,但模板{{Thankyou}}接收到的是{{{1}}}=你的友好{{{2}}}=张三,所以将会输出:


感谢你! 感谢你的友好。 来自张三


如果任意的已编号参数含有“=”这个字符,这可能也会显得有用。
範例:
<span lang="en" dir="ltr" class="mw-content-ltr">{{Thankyou|1=adding “=”|2=Me}}</span>

会生成


感谢你! 感谢添加 “=”。 来自我

警告 警告: 这也需要其他的参数被编码。

按名称赋值

与按编号赋值类似,第三种赋值方法只是把编号换成了名称。为了演示,需要将模板内容改为:

'''感谢你!'''
感谢{{{reason}}}。
来自{{{signatrue}}}

例中用{{{reason}}}{{{signature}}}声明参数,而不是使用数字,其赋值方法如下:

{{Thankyou|signature=张三|reason=你的一切}}

例中{{Thankyou}}模板接收{{{reason}}}=你的一切{{{signature}}}=张三并输出:


感谢你! 感谢你的全部。 来自张三


已命名的参数是区分大小写的,所以:

{{Thankyou|signature=我|Reason=为你是谁|reason=为大小写敏感}}

会成为:


感谢你! 感谢对大小写敏感。 来自我


在你的模板中使用命名参数的优点是,除了参数顺序灵活,还可以在有许多参数时使模板代码更容易理解。

缺省值

当您嵌入了一个应该有参数的模板,但未提供它需要的参数的话,即:

{{Thankyou}}

以用编号声明变量的模板为例,输出结果为:


感谢你! 感谢{{{1}}}。 来自{{{2}}}


当没有包含一个参数时,它会直接输出变量本身。此时,设置变量的缺省值会方便许多。比如,如果更改模板内容为:

'''感谢你!'''
感谢{{{reason|一切}}}。
来自 {{{signature|张三}}}

{{{reason|一切}}}表示如果{{{reason}}}变量的参数没有被赋值,则输出缺省值一切。类似的,{{{signature|张三}}}{{{signature}}}变量缺省输出张三。修改后的模板输出如下结果:


感谢你! 感谢一切。 来自我


The value of a parameter can be an empty string. For example, in {{foo|bar=}} or {{foo|bar=|baz=qux}}, the foo template considers the bar parameter to be "". This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.

通常缺省值可以用来指定参数的第二名称。 例如,如果你有{{{a|{{{b|}}} }}},模板先查找名为a的参数。 如果这个参数不存在,则使用名为b的参数。 如果a和b都不存在,则什么都不输出。


评价

这是高级话题,需要时才需要阅读。

通常来说,模板参数会在标记化(tokenization)之后被替换为模板,但依旧照原样。 这些参数直到使用时才会被评估。

这会有一些后果。 First of all, if you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. 你依然可以使用模板控制参数或者模板的名称,但是你不能在多个模板中分隔一个模板调用。

第二个后果是死代码消除(dead-code elimination)。 If you make a template call like {{foo|{{DISPLAYTITLE:Bar}} }}, and Template:Foo does not contain {{{1}}}, then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language.

Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

很多(但不是所有)在特殊页面嵌入的的解析器函数、解析器标签不会像模板那样被包含,而是被替换为“strip marker”。 这意味着,你不能使用像padleft:这样的解析器函数或者扩展中的类似函数处理这些结果,因为这些函数会将这些结果其视为strip marker而非解析器函数的结果。


在模板中递归

将模板包含到它本身并不会导致MediaWiki无限递归。 MediaWiki将停止递归调用,将模板名称置为加粗显示。 例如,如果Template:Aaaa的内容是a {{Aaaa}} z,它将显示为a a Template loop detected: Template:Aaaa z z。

Forbidden idiom

This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example template:d can either be called {{d|20200311}} or {{d|y=2020|m=3|d=11}}. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.

{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}

If template:d is modified to recurse into template:d/2 and template:d/2 is an identical manual copy of template:d this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters

Since the syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.[1]

控制模板嵌入

默认状态,模板内容被显示在实例中,无论被直接查看还是包含到其他页面中。当然,你可以用‎<noinclude>‎<includeonly>‎<onlyinclude> 来控制模板的哪些部分会被嵌入。

任何在‎<noinclude>‎</noinclude>之间的标记,都只会在直接查看模板页面的时候显示出来,而不会被包含在页面中。当你不想让包括在模板中的文本或代码传播到任何包括它页面这各功能很有用,比如:

  • 为模板归类请使用分类链接
  • 跨语言链接 可连接到其他语言版本中的类似模板
  • 关于如何使用该模板的解释文字

与此相对的是‎<includeonly>。在‎<includeonly>‎</includeonly>之间的文字只会在嵌入页面的时候才会被处理或显示,直接查看时不会显示。比如:

  • 很明显的一个使用方式是将所有有某个模板的页面加入某个分类,而不将模板本身加入这个分类。注意 注意: 当你改变模板中的分类的时候,使用这个模板的分类可能不会立即改变;这会在工作排队 中处理。
  • 确认查看模板页面本身时模板代码没有执行。典型地,这是因为它需要参数,并且没有参数时执行会产生不想要的结果。

当模板页面被直接查看和被其他页面包含时,所有‎<noinclude>‎<includeonly>之外的代码都会被处理和显示。 关键是这两个标记之间的内容。

所有‎<onlyinclude>标记之外的代码在嵌入时被弃置不用。 即使段落被标记为 includeonly,在嵌入时一样会被弃用,除非它们也被标记为 onlyinclude。 关键在于标记之外的东西。

也可以嵌套这些标签。

这三部分嵌入标记实现了处理和表达所有可能的组合。 评论也能起效。

整理模板

为了使模板起作用,用户需要找到并且了解如何使用模板。

找模板的方法:

  1. 点击特殊页面>所有页面
  2. 命名空间:列表中,选择Template,并点击前往

要说明用法,请包含一个示例,就像下面的例子:

<noinclude>
== 用法 ==
欢迎用户:
{{Thankyou|reason=原因|signature=名字}}
</noinclude>

然后,编辑者就可以剪切粘贴来插入这个模板。

链接到模板

模板页面可以像任何其他Wiki页面一样链接。例如,使用wikicode[[Template:Navbar]]生成链接Template:Navbar

在许多维基上,Template:Tl 可用于提供指向模板的链接,该模板的格式为显示转换模板所需的“双花括号”wikicode,而不实际进行转换。例如,代码 {{tl|Navbar}}可用于创建链接{{Navbar}}。

此构造通常用于模板文档,帮助页面以及引用模板时的谈话页面。 使用 {{[[Template:Navbar|Navbar]]}}可以实现相同的效果,但是 {{tl}} 方法用字更少。 在任何给定的wiki上,Tl模板(如果存在)可能会也可能不会在“code”元素中呈现为等宽文本,如此处所示。 如果没有(就像在本wiki上),另一个类似命名的模板可能会这样做。 例如,请参阅英语维基百科的en:Template:Tl文档的“See also”部分。

从一个wiki复制到另一个wiki

模板常需要CSS或其他模板,用户常在从一个wiki到另一个wiki复制模板时遇到问题。下列步骤对大多数模板的复制有效。

MediaWiki代码

如果你在新维基上有导入权限:

  1. 到源维基的Special:Export,下载一个包含完整历史和需要的模板的.xml文件,如下:
    • 在大文本输入框中输入模板名字,比如"Template:Welcome"。请特别关注大写字母和特殊字符。如果模板名字不完全正确,导出时也将获得.xml文件,但是里面不是想要的数据。
    • 选择“包含模板”。
    • 选择“仅包含当前版本,而不是完整历史”。
    • 点击“导出”。
  2. 到新wiki的Special:导入,上传.xml文件。

如果没有新wiki的导入权限:

  1. 到源wiki上你想复制的模板页面,编辑页面,复制维基文本;
  2. 打开新wiki,到源wiki上的模板同名的页面,点击创建/编辑,粘贴刚才拷贝的维基文本。在编辑摘要链接到源模板页面。
  3. 回到源wiki刚才复制代码的页面,在编辑区域下方,查看“本页使用的模板”。每个模板都按上述步骤复制,穷尽所有与所有上述模板有关系的模板。

这将复制全部需要的代码,并将满足一些模板的需要。 注意只有渲染页面时解析了的页面元素会被导出,例如,文档子页面不会被导出。 如果不起效果,请检查编辑框下面“当前版本的页面引用的页面:”下方的红色链接。如果有,到源wiki重复上面的步骤并复制模块中的代码。

成功导入其他维基上的模板和它链接的模板后,可以个性化编辑以适用于新wiki。例如更改Logo、删除冗余分类和红色链接等。

擴充功能

模板常用的扩展是解析器函数。 访问幫助:扩展:解析器函數 页面,查看你拷贝的模板是否包含其中列明的函数。 如果包含,表明你需要安装扩展:解析器函数 扩展。 你需要新wiki所在的服务器的管理员权限才能安装。

另外,模板可依赖的东西还有Lua,比如维基百科网站就是如此。在模板代码中使用{{#invoke: }}是一个好主意。 这时需要安装 Scribunto 扩展(也需要系统管理员权限)。 您可以参看其页面来了解如何安装和使用该扩展。

CSS 和 JavaScript 代码

在MediaWiki代码之外,许多模板要用到CSS,有些模板还以来JavaScript才能完全生效。如果复制来的模板不能很好的起效果,这也是可能的原因之一。要将需要的CSS和JavaScript复制到你的wiki,一般来说你需要有管理员权限,因为你将需要编辑"MediaWiki:"名字空间中的系统消息。

  1. 查看模板用到的CSS类(与class="foobar"类似的文本)。这些类中如果出现了源wiki上的"MediaWiki:Common.css" 或 "MediaWiki:Monobook.css",请将那些类复制到新wiki"MediaWiki:Common.css"页面,再去检查模板现在是不是工作。
  2. 如果复制来的模板仍然不能很好的工作,检查是否有代码在源wiki上 "MediaWiki:Common.js" 或者 "MediaWiki:Monobook.js"中,如果有,你可以试着复制到"MediaWiki:Common.js"。一般情况下,应该复制信任的代码,首先检查代码,然后选定有关代码。你可能会发现一些注释,可以给检查各被部分功能提供一些线索。

參見

外部链接