Help:模版

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:Templates and the translation is 93% complete.

Other languages:
العربية • ‎جهلسری بلوچی • ‎български • ‎भोजपुरी • ‎català • ‎čeština • ‎Deutsch • ‎Zazaki • ‎English • ‎British English • ‎español • ‎فارسی • ‎suomi • ‎français • ‎עברית • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मैथिली • ‎Napulitano • ‎Nederlands • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎slovenčina • ‎српски / srpski • ‎தமிழ் • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎中文
PD 注意:当你编辑本页面时,你将表示同意以CC0协议授权你的贡献。你可以在公有领域帮助文档找到更多信息。
PD

如果你需要在多个页面上包含同样的文本的话, MediaWiki 的模板功能就起到作用了 (就像上面的帮助文档都会有的标签一样)。 与插件和媒体文件不同的是,模板没有管理中心。编辑者可以从头编写、复制现有模板或导入来自其他维基的模板页面。

创建模板[edit | edit source]

模板其实也是一种 wiki 页面,但它是主要是用于嵌入到其它页面中。模板的页面名称最前面都有 Template:——將它分配到該名字空間。除此之外,像其他页面一样创建就可以了。

下面展示了模板的最簡單使用方法。如果你以如下一段爲內容,創建了一個名叫“Template:Welcome”的模板

您好!歡迎來到維基!

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

{{Welcome}}

到其他任一頁面,當該頁面被訪問時,“Hello! Welcome to the wiki”字樣就會代替{{Welcome}}而顯示。模板的內容會嵌入到其他頁面,例如:它已整合到剛剛的頁面。

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

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

並且重新訪問之前用到該模板的的100個頁面,你會看到新的文字而不是原先的。你用這個方法改變了100個頁面的內容,而不用手動修改它們,因爲模板是被嵌入這些頁面中的。

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

使用模板[edit | edit source]

模板除了作为普通的 wiki 页面之外,还可以有以下三种使用方法:

  • {{模板名称}} 就像上面描述的那样,这个链接在页面上的模板链接被调用时将动态替换为[[Template:模板名称]]当前的内容。链接在页面源文件中不会变化。
  • {{subst:Name}} — when this template link is used, it will be replaced once and for all with the content of [[Template:Name]] as of the time the page with the link is saved: a copy of the contents of [[Template:Name]] will be substituted for the template link. The contents are then a part of the including page, and can be edited normally, separately from the original. Note: later changes to the source template page will not be propagated to the page with the template link.
  • {{safesubst:模板民称}} — 这种链接被解释为允许不打破嵌入包含的替换。见 w:en:Help:Substitution#The safesubst: modifier.
  • {{msgnw:模板名称}} 会将模板的源代码包含在页面中,类似<nowiki>一样。

事實上,在一個普通的維基的頁面也可以使用模板,只要指定它在命名空間:

  • {{Template:頁面名稱}} 包含 [[Template:頁面名稱]]
  • {{Foo:頁面名稱}} 包含 [[Foo:頁面名稱]]
  • {{:頁面名稱}} 包含 [[頁面名稱]]
    • {{subst::頁面名稱}} 把它的內容替換成 [[頁面名稱]]

若不存在這个名字空間,整個標題會被假定成模板的名稱:

  • {{Foo:欄位}} 包含 [[Template:Foo:欄位]]

参数[edit | edit source]

为丰富嵌入包含机制,MediaWiki允许对被嵌入包含的模板传送参数。参数允许模板产生不同的内容或者行为。

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

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


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

为了让任何人可以因为任何原因感谢任何人,你需要创建一个感谢函模板,如Template:Thankyou。使用感谢函模板会让所有感谢函看起来相似,但其中指定部分内容应该可以自定义(如感谢的原因和署名),所以你需要把这些内容设置为变量。感谢函模板的核心内容如下所示:

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

请注意{{{1}}}{{{2}}},这就是变量,它们可以随着模板引入其他页面。声明变量的方法是使用三组花括号:{{{ }}}。这与模板名称的花括号不同。

在调用模板时,需要为变量赋值,变量间用一个竖线符号(|)分隔。MediaWiki允许三种为变量赋值的方式:隐式赋值、按编号赋值、按名称赋值。

隐式赋值[edit | edit source]

隐式赋值要求按变量声明顺序赋值:

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

例中{{Thankyou}}模板接收{{{1}}}=你的努力<code><nowiki>和<code><nowiki>{{{2}}}=张三,输出:

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


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

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

输出结果为:

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


注意:若想为变量隐式赋值,则该模板下所有变量必须全部隐式赋值。任何一个变量使用编号或名称赋值后,该模板便不再接受隐式赋值。

注意:如果等号出现在匿名的模板参数中,它将被解释为一个命名参数,将等号之前文本作为参数名称,等号后面的文本是参数的值。 当您需要在属性中包含外部链接,或者HTML元素,会遇到这个普通问题(参见:Task 16235)。 解决方法是使用命名参数来代替,或编号参数,见下文。

按编号赋值[edit | edit source]

使用编号赋值时,需要写出变量的编号:

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

例中,虽然不是按变量的声明顺序赋值,但模板{{Thankyou}}接收到的是{{{1}}}=你的友好{{{2}}}=张三,输出结果为:

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


按名称赋值[edit | edit source]

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

'''感谢你!'''
感谢{{{原因}}}。
来自 {{{署名}}}

例中用{{{原因}}}{{{署名}}}而不是数字声明了变量。赋值方法如下:

{{Thankyou|署名=张三|原因=你的一切}}

例中{{Thankyou}}模板接收{{{原因}}}=你的一切{{{署名}}}=张三并输出:

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

模板中使用命名参数的优点是,传送参数时的顺序可以灵活掌握,并且使有许多参数的模板的代码更容易理解。

缺省值[edit | edit source]

当你调用了一个模板却没有为变量赋值:

{{Thankyou}}

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

Example sunflower image
感谢你!
感谢{{{1}}}。
来自 {{{2}}}


没有为变量赋值的话,会直接输出变量本身。此时,设置变量的缺省值会方便许多。更改模板内容为:

'''感谢你!'''
感谢{{{原因|一切}}}。
来自 {{{署名|张三}}}

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

Example sunflower image
A little thank you...
for everything.
hugs, Me

Order of evaluation[edit | edit source]

Template parameters are fully evaluated before they are passed to the template. So if one of your parameters is a call to another template, what is actually passed is the expanded parameter.

{{Thankyou|reason=visiting ({{Welcome}})|signature=Me}}

becomes

{{Thankyou|reason=visiting (Hi there! Welcome to this wonderful wiki.)|signature=Me}}

before it becomes:

Example sunflower image
A little thank you...
for visiting (Hi there! Welcome to this wonderful wiki.).
hugs, Me


In a few circumstances, this order of evaluation makes a difference from the alternative. (The alternative being to check the results of the template call to see if there are additional templates to be expanded.)

First, the name of the template can be expanded at the same time and in the same way as the parameters.

Thus

{{Thankyou in {{preferred language}}|signature=Me}}

might expand to

{{Thankyou in french|signature=Me}}

So that a template called Thankyou in french could display the thank you in the preferred language (however that was determined.)

Secondly, the template being called can't construct a template from pieces to be called later. A template that took the form {{start of call}}{{end of call}} would not work if start of call was {{Thankyou| and end of call was signature=Me}}.

Thirdly, the parameter being passed is expanded only once, rather than every place the parameter is used in the template. This is more efficient on the mediawiki server.

Finally, the template being called can't stop the parameter from being expanded altogether. Even if a template only uses a parameter in some circumstances, it will always have been expanded before the call was made.

控制模板嵌入[edit | edit source]

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

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

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

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

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

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

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

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

整理模板[edit | edit source]

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

找模板的方法:

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

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

<noinclude>
== 用法 ==
用这个模板来初始化水属性魔法:
{{模板名称|关键字1+关键字2+关键字3}}
</noinclude>

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

链接到模板[edit | edit source]

要想链接到模板而不是包含模板,请使用{{tl}}模板。 在编辑者想要链接到的模板名称前加上管道符号。 例如: {{tl|navbar}}链接到{{navbar}}模板。

从一个维基向另外一个维基拷贝[edit | edit source]

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

MediaWiki代码[edit | edit source]

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

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

如果没有新维基的导入权限:

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

这将拷贝全部需要的代码,并将满足一些模板的需要。 如果不能工作,请检查编辑框下面“当前版本的页面引用的页面:”下方的红色链接。如果有,到源维基重复上面的步骤。

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

扩展[edit | edit source]

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

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

CSS 和 JavaScript 代码[edit | edit source]

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

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

注释[edit | edit source]

实验显示如果你将模板包含到它本身,并不会导致MediaWiki无限递归。 MediaWiki将发现这种情况,并且停止递归调用,将模板名称置为加粗显示。 例如,如果“Template:Aaaa”的内容是“{{Aaaa}}”,它将显示为“Template:Aaaa”。

参见[edit | edit source]