Template:Documentation/zh-cn

来自Palia Wiki
跳转到导航 跳转到搜索
本页是页面Template:Documentation翻译版本,翻译工作已完成62%。
过时的翻译以此行所示格式标记。
模板文件
注意:如果没有提供数值,可能无法看到模板样本的部分内容。
查看或编辑本文档 (关于模版文件)
编辑者可在该模板的沙盒测试用页面进行实验。

此模板已有关联或子模板: Template:Documentation

Description

This template is used to insert descriptions on template pages.

Syntax

Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.

Add <noinclude>{{Documentation|<documentation page>}}</noinclude> to transclude an alternative page from the /doc subpage.

Usage

On the Template page

This is the normal format when used:

TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>

If your template is not a completed div or table, you may need to close the tags just before {{Documentation}} is inserted (within the noinclude tags).

A line break right before {{Documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.

On the documentation page

The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).

Normally, you will want to write something like the following on the documentation page:

== Description ==

This template is used to do something.

== Syntax ==

Type <code>{{t|templatename}}</code> somewhere.

== Samples ==

<code><nowiki>{{templatename|input}}</nowiki></code>

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly>
<noinclude>{{Category|Template documentation}}</noinclude>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.

Note that the above example also uses the Template:T template.