帮助:模板

来自 ArchWiki

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

用法

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

{{Template name}}

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

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

产生

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

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

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

产生

/etc/machine-id
0123456789abcdeffedcba9876543210

通用格式是

{{Template name|param1|param2|...|paramN}}

请参阅每个模板的页面以获取具体的使用说明。

样式

  • 模板应使用其页面示例中所示的大小写,例如 {{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> 标签括起来。此方法显示所有类型的字符,但完全阻止 wiki 引擎处理文本标记,例如链接和其他模板。例如

{{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;}}
提示 = | {{ }}

创建

注意
  • 模板命名空间是半保护的。只有 自动确认用户 才能创建或编辑模板。
  • 在创建模板之前,请在 Help talk:Template 中讨论这个想法。
  • 仅创建相关的模板。如果您尝试创建非常专业的模板,可能只会在少数文章中使用,请不要费心,避免模板命名空间变得混乱。
  • 仅创建简洁的模板。请记住 Arch 之道:保持简单,笨蛋!

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

<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:Template name(将 Template name 替换为模板的所需名称),编辑,并添加相关的 wikitext

模板列表

用户可以直接在 ArchWiki 文章中使用的模板在下面列出。单击链接以查看其详细用法。有关还包括本地化和元模板的列表,请参阅 Special:AllPages/Template:Special:PrefixIndex/Template:Special:MostLinkedTemplates

警告: 请不要尝试修改现有模板。如果您想编辑非保护模板,请将文本复制到 Template:Sandbox,在那里编辑和测试,并在工作正常后将其复制回来。强烈建议(对于受保护的模板是必要的)首先在讨论页面上提出任何修改建议。

测试

文章状态模板

这些模板应添加到相关文章或章节的开头。另请参阅 Help:Style#文章状态模板

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

使用文章状态模板标记的页面会在相应的 维护分类ArchWiki:统计#维护统计 中跟踪。

名称 推荐用途 参数
Template:Style 内容存在语言、wiki 语法或样式问题。 1 — 原因,2 — 可选讨论页,section — 默认讨论页中的可选章节
Template:Accuracy 不正确或误导性的内容。
Template:Expansion 不完整的内容。
Template:Out of date 过时的内容。
Template:Remove 不相关或无用的内容。
Template:Archive 过时的页面。
Template:Laptop style 不遵循 Laptop 页面指南Laptop 页面。
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 — 页面作者上次审核日期

相关文章模板

代码格式化模板

注释模板

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

杂项模板

软件包模板

表格单元格模板

文本对齐

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

单元格背景

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

常用文本

名称 Wiki 标记 结果
Template:Yes {{Yes}}
{{Yes|https://wiki.archlinux.org.cn/}}
Template:No {{No}}
{{No|https://wiki.archlinux.org.cn/}}
Template:- {{-}}
提示: 您可以使用属性来设置表格单元格模板,例如:| colspan=2 {{Yes}}

分类模板

参见