Template:Documentation/doc - Revision history

Trrgtw at 19:31, 26 October 2025

2025-10-26T19:31:52Z

← Older revision		Revision as of 19:31, 26 October 2025
Line 2:		Line 2:

	==Usage==		==Usage==
	~~Place the following at the bottom of a template:~~		<pre><noinclude>{{Documentation\|<optional page name>}}</noinclude></pre>

	<~~pre~~>~~<noinclude>{{Documentation}}<~~/~~noinclude>~~</~~pre~~>		By default, this template retrieves documentation at <code>Template:YOURTEMPLATE/doc</code>. The unnamed first parameter is optional and can be used to point to documentation on a different page.

	~~This~~ '''must''' come directly after the last character in your template – do not place it on a new line.		Template:Documentation '''must''' come directly after the last character in your template – do not place it on a new line.

	==Example==		==Example==
	If you have a template to create bold text ~~that looks~~ like this:		If you have a template to create bold text, add the documentation template like this:

	<pre>'''{{{1}}}'''</pre>		<pre>'''{{{1}}}'''<noinclude>{{Documentation}}</noinclude></pre>

	~~Add~~ the ~~documentation template~~ like this:		If your template is named ''Template:Bold'', and you want to reuse documentation from ''Template:Italics'', fill in the first parameter like this:

	<pre>'''{{{1}}}'''<noinclude>{{Documentation}}</noinclude></pre>		<pre>'''{{{1}}}'''<noinclude>{{Documentation\|Template:Italics/doc}}</noinclude></pre>

Trrgtw: tweaks

2025-10-22T20:57:07Z

tweaks

← Older revision		Revision as of 20:57, 22 October 2025
Line 1:		Line 1:
	'''Template:Documentation''' is used to add instructions on how to use a template, including an explanation of its syntax and parameters, recommended usage, and example code. When added to a page, it will transclude a subpage, found at <code>Template:YOURTEMPLATE/doc</code> (which initially will be a red link) – write your documentation on that subpage.		'''Template:Documentation''' is used to add instructions on how to use a template, including an explanation of its syntax and parameters, recommended usage, and example code. When added to a page, it will transclude a subpage found at <code>Template:YOURTEMPLATE/doc</code> (which initially will be a red link) – write your documentation on that subpage.

	==Usage==		==Usage==
Line 6:		Line 6:
	<pre><noinclude>{{Documentation}}</noinclude></pre>		<pre><noinclude>{{Documentation}}</noinclude></pre>

	This '''must''' come directly after the last character in your template (do not place it on a new line).		This '''must''' come directly after the last character in your template – do not place it on a new line.

	==Example==		==Example==

Trrgtw: Created page with "'''Template:Documentation''' is used to add instructions on how to use a template, including an explanation of its syntax and parameters, recommended usage, and example code. When added to a page, it will transclude a subpage, found at Template:YOURTEMPLATE/doc (which initially will be a red link) – write your documentation on that subpage. ==Usage== Place the following at the bottom of a template:

{{Documentation}}

Thi..."

2025-10-22T20:53:41Z

Created page with "'''Template:Documentation''' is used to add instructions on how to use a template, including an explanation of its syntax and parameters, recommended usage, and example code. When added to a page, it will transclude a subpage, found at <code>Template:YOURTEMPLATE/doc</code> (which initially will be a red link) – write your documentation on that subpage. ==Usage== Place the following at the bottom of a template: <pre><noinclude>{{Documentation}}</noinclude></pre> Thi..."

New page

'''Template:Documentation''' is used to add instructions on how to use a template, including an explanation of its syntax and parameters, recommended usage, and example code. When added to a page, it will transclude a subpage, found at <code>Template:YOURTEMPLATE/doc</code> (which initially will be a red link) – write your documentation on that subpage.

==Usage==
Place the following at the bottom of a template:

<pre><noinclude>{{Documentation}}</noinclude></pre>

This '''must''' come directly after the last character in your template (do not place it on a new line).

==Example==
If you have a template to create bold text that looks like this:

<pre>'''{{{1}}}'''</pre>

Add the documentation template like this:

<pre>'''{{{1}}}'''<noinclude>{{Documentation}}</noinclude></pre>