跳转至内容

帮助:模板

来自 ArchWiki

模板是一段预定义的 维基文本 (wikitext),可以插入到文章中。模板主要用于辅助格式化内容。

用法

通过在文章中添加以下标记来使用模板

{{Template name}}

一般格式为

{{Template name|parameter_1|parameter_2|…|parameter_N}}

具体使用说明请参见 #模板列表

大多数模板接受额外参数,例如 Template:Note

{{Note|This text should be noted.}}

会生成

注意: 这段文字应当被注意。

某些模板可以使用命名参数,例如 Template:hc

{{hc|head=/etc/machine-id|output=0123456789abcdeffedcba9876543210}}

会生成

/etc/machine-id
0123456789abcdeffedcba9876543210

格式规范

  • 模板的使用必须遵循 其页面 示例中所示的 大小写。例如,{{Pkg|…}}{{ic|…}} 是正确的,而 {{pkg|…}}{{Ic|…}} 则不正确。
  • 模板名称前后 不得有空格。例如,{{Template name|…}} 是正确的,而 {{ Template name |…}} 则不正确。
  • 模板本身不得被分类。

转义破坏模板的字符

有些字符如果在模板内部使用,会破坏其输出:最常见的是 = (等号) 和 | (竖线)。解决此问题的方法如下所述。

提示
  • 竖线符号 (|) 可以使用 {{!}} 魔术字 进行转义。
  • 等号 (=) 可以使用 {{=}} 魔术字进行转义。

命名参数和编号参数

如果问题仅出在 = 号上,推荐的解决方法是显式地使用位置编号或参数名来引入模板参数。

示例

{{Tip|1=https://archlinux.org.cn/?foo=bar}}

结果

这对于以下情况非常有用:

  • 变量定义、
  • URL 中带有查询字符串的 外部链接
  • Shell 字符串和命令、
  • 代码行。

空白字符(例如换行符)会自动从命名参数值的开头和结尾去除。要保留空白字符,请在参数值开头使用 <nowiki/> 标签。

示例

{{Tip|1=<nowiki/>
* https://archlinux.org.cn/?foo=bar
* https://archlinux.org.cn/?foo=baz
}}

结果

多个参数
  • 使用位置参数 12
示例
{{hc|1=$ echo "="|2==}}
结果
$ echo "="
=
  • 使用命名参数 headoutput
示例
{{hc|head=$ echo "="|output==}}
结果
$ echo "="
=

nowiki 标签

如果您在使用 = 以外的字符(例如 })时遇到问题,推荐的解决方法是将整个参数包裹在 <nowiki> 标签中。此方法可以显示所有类型的字符,但会完全阻止维基引擎处理文本标记(如链接或其他模板)。

示例

{{Tip|<nowiki>= | }} https://archlinux.org.cn/ {{ic|foo}}</nowiki>}}

结果

提示: = | }} https://archlinux.org.cn/ {{ic|foo}}

当然,仅将特定部分(甚至单个字符)包裹在 <nowiki> 标签中也是可行的,但为了可读性,建议仅在必须正常显示链接或其他模板时才使用此方法。

示例

{{Tip|<nowiki>= | }}</nowiki> https://archlinux.org.cn/ {{ic|foo}}}}

结果

提示: = | }} https://archlinux.org.cn/ foo

HTML 实体

将冲突字符替换为相应的 HTML 实体始终有效,但由于这会降低源代码的可读性,因此仅在上述方法不可行时才推荐使用。

示例

{{Tip|&#61; &#124; &#123;&#123; &#125;&#125;}}

结果

提示 = | {{ }}

模板列表

下面列出了用户可以直接在 ArchWiki 文章中使用的模板。

有关包含 本地化 模板的完整列表,请参见:

警告
  • 不要拿现有模板做实验。 如果您想编辑一个未受保护的模板,请将文本复制到 Template:Sandbox (模板沙盒),在那里编辑和测试,并在运行正常后复制回原处。另见 #测试
  • 强烈建议(对于受保护模板则是必须的)先在讨论页上提出任何修改建议。另见 #创建模板

代码格式化

软件包 (Package)

仅限在讨论页的草稿中使用

状态

这些模板应当添加在相关文章或章节的开头。另见 帮助:风格指南#文章状态模板

翻译者还应查看 ArchWiki:翻译团队 中的模板指南。

被标记了状态模板的页面会在相应的 维护分类ArchWiki:统计#维护统计 中进行追踪。

名称 推荐用法 参数
Template:Style (格式风格) 内容存在语言、维基语法或风格问题。 1 — 原因。
2 — 可选的讨论页。
section — 默认讨论页中的可选章节。
Template:Accuracy (准确性) 内容错误或具有误导性。
Template:Expansion (扩充) 内容不完整。
Template:Out of date (过时) 内容已过时。
Template:Remove (删除) 内容无关或无助益。
Template:Archive (存档) 已作废的页面。
Template:Laptop style (笔记本风格) 笔记本 页面未遵循 笔记本页面指南
Template:Translateme 不完整的翻译。
Template:Bad translation 有问题的翻译。
Template:TranslationStatus 翻译状态。 1 — 原文标题。
2 — 翻译日期。
3 — 修订版本号。
Template:Merge (合并) 内容与另一篇文章重叠。 1 — 目标页面。
2 — 原因。
3 — 可选的讨论页。
section — 默认讨论页中的可选章节。
Template:Move (移动) 重命名页面,或将章节移动到另一篇文章。
Template:Redirect (重定向) 将页面重定向到另一篇文章。
Template:Unsupported Arch Linux 不支持的用户页面。 1 — 页面作者最后一次复核的日期。

表头

表格单元格

提示: 您可以通过在表格单元格模板前加上前缀来使用属性,例如:| colspan=2 {{Yes}}

文本对齐

名称 对齐方式 维基标记 结果
Template:C 居中 {{C|文本}} 文本
Template:L 左对齐 {{L|文本}} 文本

单元格背景

名称 颜色 维基标记 结果
Template:R 红色 {{R|文本}} 文本
Template:O 橙色 {{O|文本}} 文本
Template:Y 黄色 {{Y|文本}} 文本
Template:G 绿色 {{G|文本}} 文本
Template:B 蓝色 {{B|文本}} 文本
Template:V 紫色 {{V|文本}} 文本
Template:Grey 灰色 {{Grey|文本}} 文本

常用文本

名称 维基标记 结果
Template:Yes {{Yes}}
{{Yes|https://wiki.archlinux.org.cn/}}
Template:No {{No}}
{{No|https://wiki.archlinux.org.cn/}}
Template:- (占位符) {{-}}

分类

维护

元模板

这些模板应仅被其他模板包含(transclude)。

杂项

测试

创建模板

创建新模板时应使用以下模板,以方便他人使用和编辑

<noinclude>
{{Template}}

A brief description of the template

== Usage ==

 <nowiki>{{Template name|param1|param2|...|paramN}}</nowiki>

== Example ==

{{Template name|param1|param2|...|paramN}}</noinclude><includeonly>Template code goes here...</includeonly>

要开始创建过程,只需访问 Template:模板名称(将 模板名称 替换为您想要的名称),然后 进行编辑并添加相关的维基文本

参见

© . This site is unofficial and not affiliated with Arch Linux.

Content is available under GNU Free Documentation License 1.3 or later unless otherwise noted.