Template:Documentation/doc: Difference between revisions

From Screamer Wiki
Jump to: navigation, search
VisualWikitext
imported>Default
(→‎On the Template page: Inconsistency solution. Put category on template page itself. "Any categories for the template itself" placed between the noinclude tags.)
imported>Default
m (Protected "Template:Documentation/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
Line 1: Line 1:
;Description
==Description==
:This template is used to insert descriptions on template pages.
This template is used to insert descriptions on template pages.
;Syntax
 
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
==Syntax==
Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
 
==Usage==


==General usage==
===On the Template page===
===On the Template page===
This is the normal format when used:
<pre>
<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</includeonly><noinclude>
{{documentation}}Any categories for the template itself</noinclude>
{{documentation}}</noinclude>
</pre>
</pre>


Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).
''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).''


The line break is also useful as it helps prevent the documentation template "running into" previous code.
''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 Template/doc page===
===On the Template/doc page===
Normally, you will want to write something like the following on the documentation page:
<pre>
<pre>
;Description
==Description==
:This template is used to do something.
This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code>&lt;nowiki>{{templatename|foo}}&lt;/nowiki></code> gives...
:{{templatename|foo}}


<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
==Syntax==
</pre>
Type <code>{{t|templatename}}</code> somewhere.
 
==Samples==
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>  


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.
results in...


Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.
{{templatename|input}}


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


does not seem to work consistently at getting the template itself to show up in a category. It works for some templates, and not for others. This may be a bug. So it is better to add the template category to the template page itself. Use ''<nowiki><noinclude></noinclude></nowiki>''
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:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Revision as of 12:30, 13 June 2015

Description

This template is used to insert descriptions on template pages.

Syntax

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

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 Template/doc page

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|{{PAGENAME}}]]</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 and Template:T/piece templates.

Retrieved from "https://screamer.wiki/index.php?title=Template:Documentation/doc&oldid=53268"