Template:Documentation/doc - Revision history

Chromatic Flare at 04:34, 4 April 2025

2025-04-04T04:34:52Z

← Older revision		Revision as of 00:34, 4 April 2025
Line 14:		Line 14:
	</pre>		</pre>

	<noinclude>[[Category:~~Templates documentation~~]]</noinclude>		<noinclude>[[Category:Template Documentation]]</noinclude>

Chromatic Flare at 00:21, 4 April 2025

2025-04-04T00:21:48Z

← Older revision		Revision as of 20:21, 3 April 2025
Line 14:		Line 14:
	</pre>		</pre>

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

Chromatic Flare at 00:07, 4 April 2025

2025-04-04T00:07:15Z

← Older revision		Revision as of 20:07, 3 April 2025
Line 9:		Line 9:

	<pre>		<pre>
	TEMPLATE CODE<~~includeonly~~>		TEMPLATE CODE<noinclude>
	List of categories for the template		List of categories for the template
	{{Documentation}}</~~includeonly~~>		{{Documentation}}</noinclude>
	</pre>		</pre>

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

Chromatic Flare at 00:06, 4 April 2025

2025-04-04T00:06:46Z

← Older revision		Revision as of 20:06, 3 April 2025
Line 11:		Line 11:
	TEMPLATE CODE<includeonly>		TEMPLATE CODE<includeonly>
	List of categories for the template		List of categories for the template
	{{~~T\|documentation~~}}</includeonly>		{{Documentation}}</includeonly>
	</pre>		</pre>

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

Chromatic Flare at 23:56, 3 April 2025

2025-04-03T23:56:26Z

← Older revision		Revision as of 19:56, 3 April 2025
Line 9:		Line 9:

	<pre>		<pre>
	TEMPLATE CODE<includeonly>~~Any~~ categories ~~to be inserted into articles by~~ the template		TEMPLATE CODE<includeonly>
			List of categories for the template
	{{T\|documentation}}</includeonly>		{{T\|documentation}}</includeonly>
	</pre>		</pre>

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

Chromatic Flare at 23:52, 3 April 2025

2025-04-03T23:52:55Z

@@ Line 4: / Line 4: @@
 ==Syntax==
 Add {{T|Documentation}} at the end of the template page.
 ==Usage==
 This is the normal format when used:
 <pre>
-TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
+TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template
-{{documentation}}</noinclude>
+{{T|documentation}}</includeonly>
 </pre>
 <includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Chromatic Flare at 23:29, 3 April 2025

2025-04-03T23:29:47Z

← Older revision		Revision as of 19:29, 3 April 2025
Line 3:		Line 3:

	==Syntax==		==Syntax==
	Add ~~<code><nowiki><noinclude></nowiki>~~{{t\|~~documentation~~}}~~<nowiki></noinclude></nowiki></code>~~ at the end of the template page.		Add {{T\|Documentation}} at the end of the template page.

	Add ~~<code><nowiki><noinclude></nowiki>~~{{t\|~~documentation\|documentation page~~}}~~<nowiki></noinclude></nowiki></code>~~ to transclude an alternative page from the /doc subpage.		Add {{T\|Documentation}} to transclude an alternative page from the /doc subpage.

	==Usage==		==Usage==
Line 31:		Line 31:

	==Syntax==		==Syntax==
	~~Type~~ <~~code~~>{{Documentation}}</~~code~~> ~~somewhere.~~		<noinclude>{{Documentation}}</noinclude>

	==Samples==		==Samples==
	<~~code><nowiki~~>{{Documentation}}~~</nowiki>~~</~~code~~>		<noinclude>{{Documentation}}</noinclude>

	results in...		results in...

Chromatic Flare at 23:05, 3 April 2025

2025-04-03T23:05:39Z

← Older revision		Revision as of 19:05, 3 April 2025
Line 31:		Line 31:

	==Syntax==		==Syntax==
	Type <code>{{~~t\|templatename~~}}</code> somewhere.		Type <code>{{Documentation}}</code> somewhere.

	==Samples==		==Samples==
	<code><nowiki>{{~~templatename\|input~~}}</nowiki></code>		<code><nowiki>{{Documentation}}</nowiki></code>

	results in...		results in...

Chromatic Flare: Created page with "==Description== This template is used to insert descriptions on template pages. ==Syntax== Add {{t|documentation}} at the end of the template page. Add {{t|documentation|documentation page}} to transclude an alternative page from the /doc subpage. ==Usage== ===On the Template page=== This is the normal format when used:

 TE..."

2025-04-03T22:58:43Z

Created page with "==Description== This template is used to insert descriptions on template pages. ==Syntax== Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page. Add <code><nowiki><noinclude></nowiki>{{t|documentation|documentation page}}<nowiki></noinclude></nowiki></code> to transclude an alternative page from the /doc subpage. ==Usage== ===On the Template page=== This is the normal format when used: <pre> TE..."

New page

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

==Syntax==
Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.

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

==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>
{{documentation}}</noinclude>
</pre>

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

''A line break right before <code><nowiki>{{documentation}}</nowiki></code> 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|Syntax]]).

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>{{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|{{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.

Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.

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