Help:模板

来自 Arch Linux 中文维基
(重定向自Help:Template

模板是一段预先定义的 wikitext,可以直接插入到文章当中,主要用来加入格式化的内容。

本文描述并说明 Arch Wiki 的模板规则,关于中文 Wiki 的额外要求,请访问 Help:翻译.

使用[编辑 | 编辑源代码]

要使用一个模板,在文章中加入如下内容:

{{Template name}}

大部分模板都可以附加额外参数,例如 Template:注意:

{{注意|这是一段应该注意的文字。}}

将显示为:

注意: 这是一段应该注意的文字。

有些模板使用带名称的参数,例如 Template:hc:

{{hc|head=/etc/rc.local|output=exit 0}}

将显示为:

/etc/rc.local
exit 0

一般格式为:

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

每个模板的页面都包含具体的使用方法。

样式[编辑 | 编辑源代码]

  • 模板的大小写应该与模板页面的示例一致,例如应该使用 {{Pkg|...{{ic|... 而不是 {{pkg|...{{Ic|...
  • 模板名的前后不应该有空格,: 应该用{{Template name|... 而不是 {{ Template name |...
  • 不应对模板进行分类。

转义特殊字符[编辑 | 编辑源代码]

有些字符在模板中使用会扰乱输出,常见的如 "=" (等号) 和 "|" (管道字符). 可以用下面方法处理:

提示:
  • 管道字符 "|" 可以通过 magic word {{!}} 显示。
  • 等号 "=" 可以通过 magic word {{=}} 显示。

使用命名和位置编号参数[编辑 | 编辑源代码]

如果问题是 = 引起,可以通过命名或位置编号参数解决。 例如:{{Tip|1=https://archlinux.org/?foo=bar}}

显示为:

此方法非常适合这些情况使用:

  • 变量定义
  • URL中带有查询参数的站外链接
  • 命令行字符串和命令
  • 多行代码

参数前后的多个空行会被自动移除,要保留空白支付,请使用 <nowiki/> 标签。

例如:

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

将显示为:


多个参数[编辑 | 编辑源代码]
  • 使用位置编号参数12
{{hc|1=$ echo "="|2==}}

效果:

$ echo "="
=
  • 使用命名参数headoutput
{{hc|head=$ echo "="|output==}}

效果:

$ echo "="
=

nowiki 标签[编辑 | 编辑源代码]

如果要支持 = 之外的字符,例如 "}", 请用 <nowiki> 包裹完整参数,但是这时他所有 Wiki 语法都会失效,例如链接和其他模板等都只会显示原始文本。示例:

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

当然,在 <nowiki> 标签中只包含特定部分(甚至单个字符)仍然有效,但为了可读性,建议只在链接或其他模板必须正常显示时才使用这种方法。例如:

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

将字符替换为 HTML 实体[编辑 | 编辑源代码]

此方法支持所有字符,但是不利于后续维护,所以仅当上面方法不适用时再使用。示例:

{{Tip|&#61; &#124; &#123;&#123; &#125;&#125;}}
提示:= | {{ }}

创建[编辑 | 编辑源代码]

注意:

创建模板时,在本中文维基中,模板和模板的文档是分开创建的。模板页面的内容像这样:

<includeonly>此处是模板代码...</includeonly><noinclude>{{documentation}}
<!-- 请将分类/语言链接放在文档页面 --></noinclude>

模板文档应该位于模板的/doc子页面。模板内通过 noinclude 标签调用{{Documentation}}后,(预览或者保存后)按模板上的「创建」链接会自动加载所需的文档模板。详情参见模板:模板

要开始创建过程,请先访问 Template:Template name (将Template name替换为要创建的模板名), 然后编辑添加相关内容。

注意: <includeonly><noinclude>标签之外的文本也会出现在模板调用的结果中。<includeonly> 的意思仅仅是不要在模板自己的页面中出现。因此,不要在开始标签前、结束标签后换行,以避免额外的空行出现在使用模板的页面中。

模板列表[编辑 | 编辑源代码]

下列模板可直接于ArchWiki的页面中使用。点击链接可以查看详细使用方法。完整列表位于Special:AllPages/Template:Special:PrefixIndex/Template:Special:MostLinkedTemplates

警告: 请不要直接修改已经存在的模板。如果需要编辑未保护的模板,请将内容复制到Template:Sandbox进行编辑和测试,正常工作后再复制回去。强烈推荐(受保护模板必须)先在讨论页提出修改建议。

沙盒[编辑 | 编辑源代码]

文章状态模板[编辑 | 编辑源代码]

请将下列模板加入文章或段落的开头,详情参阅 Help:风格#文章状态模板.

译者还应检查 ArchWiki:Translation Team 中的模板指南。

下列模板都通过 Wiki 维护分类统一管理,ArchWiki:Statistics#Maintenance statistics 包含相关模板使用情况的统计。

名称 适用情形 参数
Template:Style 内容存在语句、wiki 语法或样式问题. 1 — 原因, 2 — 讨论页面(可选), section — 讨论话题(可选)
Template:Accuracy 不正确、错误或容易引起误解的内容.
Template:Expansion 不全的内容.
Template:Out of date 已经过时的内容.
Template:Remove 不相关、无帮助内容.
Template:Archive 已经过时的页面.
Template:Laptop style Laptop pages not following the Help:Laptop page guidelines|Laptop page guidelines.
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|text}} text
Template:L 靠左 {{L|text}} text

单元格背景:

模板名 颜色 Wiki标记 效果
Template:R red {{R|text}} text
Template:O orange {{O|text}} text
Template:Y yellow {{Y|text}} text
Template:G green {{G|text}} text
Template:B blue {{B|text}} text
Template:V violet {{V|text}} text
Template:Grey grey {{Grey|text}} text

常见文字:

模板名 Wiki标记 效果
Template:是 {{是}}
{{是|https://wiki.archlinux.org/}}
Template:否 {{否}}
{{否|https://wiki.archlinux.org/}}
Template:- {{-}}
提示:将单元格属性前置即可让属性和表格模板并用,例如:| colspan=2 {{是}}

分类模板[编辑 | 编辑源代码]

参见[编辑 | 编辑源代码]