Difference between revisions of "Template:Doc"

From TFC:TNG
Jump to navigation Jump to search
(Created page with "<noinclude><div style="display:none;"></noinclude><div style="border:1px solid black; margin:1em; margin-top:3em;"><div style="background:#ddd; color:#111; padding:1em; margin...")
m (1 revision imported)
 
(No difference)

Latest revision as of 05:15, 24 September 2019

Template documentation (for the above template, sometimes hidden or invisible)
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{Doc}}</noinclude> at the end of the template page.

General usage

On the Template page

<includeonly>Template code and Any categories to be inserted into articles by the template</includeonly><noinclude>
{{doc}}</noinclude>


The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code></code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<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 further usage information sections.



Visit Template:Doc/doc to edit this text! (How does this work?)
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{Doc}}</noinclude> at the end of the template page.

General usage

On the Template page

<includeonly>Template code and Any categories to be inserted into articles by the template</includeonly><noinclude>
{{doc}}</noinclude>


The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code></code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<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 further usage information sections.