Template:Documentation/doc: Difference between revisions

From Redemption Wiki
Jump to navigation Jump to search
>Default
(→‎On the Template/doc page: Explained inconsistentcy of category placement. I can not start the discussion page here. So please contact me at http://cannabis.wikia.com/wiki/User:Timeshifter)
>Default
(New page: '''To use this template, type {{t|documentation}} on the template page.''' <includeonly>{{PAGENAME}}</includeonly>)
 
Line 1: Line 1:
;Description
'''To use this template, type {{t|documentation}} on the template page.'''
: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.


==General usage==
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly>
===On the Template page===
<pre>
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
</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).
 
The line break is also useful as it helps prevent the documentation template "running into" previous code.
 
===On the Template/doc page===
<pre>
;Description
: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>
</pre>
 
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.
 
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.
 
Adding
<pre>
<nowiki><includeonly>Any categories for the template itself</includeonly></nowiki>
</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>''
 
 
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 20:46, 26 May 2015

To use this template, type {{documentation}} on the template page.


Retrieved from "https://redemption.su/wiki/index.php?title=Template:Documentation/doc&oldid=230"