miraheze-user->Aeywoo: Updated Template:Documentation/doc.

2024-01-21T05:55:22Z

@@ Line 1: / Line 1: @@
-==Description==
+<!-- you can remove this line and everything above it if you don't see any big bold red text -->
-This template is used to insert descriptions on template pages.
+;Description
+:This template is used to insert documentation on template pages.
-==Syntax==
+;Syntax
-Add <code><nowiki><noinclude></nowiki>{{t|Documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
+:Type <code>&lt;noinclude>{{T|Documentation}}&lt;/noinclude></code> at the end of the template page.
 <pre>
-TEMPLATE CODE
+Template code<noinclude>
-<includeonly>Any categories to be inserted into articles by the template</includeonly>
+{{Documentation}}
-<noinclude>{{Documentation}}</noinclude>
+</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).''
+=== On the Template/doc page ===
 <pre>
-==Description==
+;Description
-This template is used to do something.
+:This template is used to do something.
-==Syntax==
+<includeonly>Any categories for the template itself
-Type <code>{{t|templatename}}</code> somewhere.
+</includeonly><noinclude>
+[[Category:Template documentation]]
-==Samples==
+</noinclude>
-<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>
+</pre>
-results in...
+Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
-{{templatename|input}}
+Note that the above example also uses {{T|T}}.
-Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
+== Dependencies ==
-Note that the above example also uses the [[Template:T]] template.
+== TemplateData ==
-<includeonly>[[Category:Documentation templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
+<includeonly>[[Category:Documentation templates| ]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

miraheze-user->FANDOM at 15:48, 6 July 2021

2021-07-06T15:48:57Z

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]]</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]] template.

<includeonly>[[Category:Documentation templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Template:Documentation/doc - Revision history

miraheze-user->Aeywoo: Updated Template:Documentation/doc.

miraheze-user->FANDOM at 15:48, 6 July 2021