Template:Documentation/doc - 版本历史

2025年5月4日 (日) 14:20 九千天华

2025-05-04T14:20:08Z

←上一版本		2025年5月4日 (日) 22:20的版本
第1行：		第1行：
			__NOTOC__
	==描述==		==描述==
	这是一个用于创建文档的模板		这是一个用于创建文档的模板

2025年5月4日 (日) 14:19 九千天华

2025-05-04T14:19:50Z

←上一版本		2025年5月4日 (日) 22:19的版本
第1行：		第1行：
	==介绍==		==描述==
	这是一个用于创建文档的模板		这是一个用于创建文档的模板

	==用法==		==用法==

	===在使用这个模板的页面上===		===在这个模板的页面上===

	<pre>		<pre>
	~~TEMPLATE CODE~~<includeonly>~~Any categories to be inserted into articles by the template~~</includeonly><noinclude>		模版代码<includeonly>使用该模板将加入的列表</includeonly><noinclude>
	{{doc}}</noinclude>		{{doc}}</noinclude>
	</pre>		</pre>

	''~~If your template is not a completed~~ div or table~~, you may need to close the tags just before~~ <code><nowiki>{{doc}}</nowiki></code> ~~is inserted (within the~~ noinclude ~~tags).~~''		'''如果你的模板不是一个完整的 div 或 table 你可能需要在 <code><nowiki>{{doc}}</nowiki></code> 前插入关闭标签（当然，是在 noinclude 标签内部）。'''

	''~~A line break right before~~ <code><nowiki>{{doc}}</nowiki></code> ~~can also be useful as it helps prevent the documentation template "running into" previous code.~~''		'''最好在 <code><nowiki>{{doc}}</nowiki></code> 前添加一个换行，这有助于避免模板与前面的代码连在一起。'''

	===~~On the Template/doc page~~===		===在模板的文档页面===
	~~Normally, you will want to write something like the following on the documentation page:~~		通常按照下述格式：

	<pre>		<pre>
	==~~Description~~==		==描述==
	~~This template is used to do something.~~		这个模板用来干嘛

	==~~Syntax~~==		==语法==
	~~Type~~ <code>{{tl\|~~templatename~~}}</code> ~~somewhere~~.		把 <code>{{模版名\|参数}}</code> 丢到随便哪里.

	==~~Samples~~==		==示例==
	<code>~~<~~nowiki>{{~~templatename~~\|~~input~~}}~~<~~/nowiki></code>		<code><nowiki>{{模版\|参数}}</nowiki></code>

	~~results in...~~		效果为

	{{~~templatename~~\|~~input~~}}		{{模版\|参数}}

	<includeonly>~~Any categories for the template itself~~</includeonly>		<includeonly>模版本身所属的任何类别</includeonly>
	</pre>		</pre>

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

2025年5月4日 (日) 14:10 九千天华

2025-05-04T14:10:15Z

←上一版本		2025年5月4日 (日) 22:10的版本
第1行：		第1行：
	==~~Usage~~==		==介绍==
			这是一个用于创建文档的模板

	===~~On the Template page~~===		==用法==
	~~This is the normal format when used:~~
			===在使用这个模板的页面上===

	<pre>		<pre>

2025年5月4日 (日) 14:07 九千天华

2025-05-04T14:07:28Z

←上一版本		2025年5月4日 (日) 22:07的版本
第1行：		第1行：
	~~== X ==~~

	~~==Description==~~
	~~这是一个用于创建文档的模板~~

	==Usage==		==Usage==

2025年5月4日 (日) 14:07 九千天华

2025-05-04T14:07:03Z

←上一版本		2025年5月4日 (日) 22:07的版本
第1行：		第1行：
			== X ==

	==Description==		==Description==
	这是一个用于创建文档的模板		这是一个用于创建文档的模板

2025年5月4日 (日) 14:01 九千天华

2025-05-04T14:01:13Z

←上一版本		2025年5月4日 (日) 22:01的版本
第1行：		第1行：
	==Description==		==Description==
	~~This template is used to insert descriptions on template pages.~~		这是一个用于创建文档的模板

	~~==Syntax==~~
	Add <code><nowiki><noinclude></nowiki>{{tl\|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl\|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.
	* If <code><nowiki>notoc=1</nowiki></code>, the catalogue will not be displayed.
	* Use <code><nowiki>toc=</nowiki></code> will set the alignment of the catalogue.

	==Usage==		==Usage==
第38行：		第33行：
	{{templatename\|input}}		{{templatename\|input}}

	<includeonly>Any categories for the template itself</includeonly~~><noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude~~>		<includeonly>Any categories for the template itself</includeonly>
	</pre>		</pre>

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

	~~<noinclude>[[Category:Template documentation\|{{PAGENAME}}]]</noinclude>~~

九千天华：创建页面，内容为“==Description== This template is used to insert descriptions on template pages. ==Syntax== Add `{{tl|documentation}}`
or `{{tl|doc}}` at the end of the template page. * If `notoc=1`, the catalogue will not be displayed. * Use `toc=` will set the alignment of the cata…”

2025-05-02T23:23:57Z

创建页面，内容为“==Description== This template is used to insert descriptions on template pages. ==Syntax== Add <code><nowiki><noinclude></nowiki>{{tl|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page. * If <code><nowiki>notoc=1</nowiki></code>, the catalogue will not be displayed. * Use <code><nowiki>toc=</nowiki></code> will set the alignment of the cata…”

新页面

==Description==
This template is used to insert descriptions on template pages.

==Syntax==
Add <code><nowiki><noinclude></nowiki>{{tl|documentation}}<nowiki></noinclude></nowiki></code><br />or <code><nowiki><noinclude></nowiki>{{tl|doc}}<nowiki></noinclude></nowiki></code> at the end of the template page.
* If <code><nowiki>notoc=1</nowiki></code>, the catalogue will not be displayed.
* Use <code><nowiki>toc=</nowiki></code> will set the alignment of the catalogue.

==Usage==

===On the Template page===
This is the normal format when used:

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

''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{doc}}</nowiki></code> is inserted (within the noinclude tags).''

''A line break right before <code><nowiki>{{doc}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''

===On the Template/doc page===
Normally, you will want to write something like the following on the documentation page:

<pre>
==Description==
This template is used to do something.

==Syntax==
Type <code>{{tl|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|{{PAGENAME}}]]</noinclude>
</pre>

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

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>