Template:Documentation/doc

From Syra D&D Wiki

Revision as of 06:55, 5 August 2011 (view source) Dark T Zeratul (Talk | contribs) (Created page with 'Test') ← Older edit		Current revision as of 01:21, 15 January 2012 (view source) Dark T Zeratul (Talk | contribs)
(7 intermediate revisions not shown)
Line 1:		Line 1:
-	Test	+	;Description
		+	:This template is used to insert descriptions on template pages.
		+	;Syntax
		+	:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the top of the template page.
		+
		+	==General usage==
		+	===On the Template page===
		+	<pre><noinclude>{{documentation}}
		+	</noinclude>Template code
		+	<includeonly>Categories applied to pages using the template</includeonly>
		+	</pre>
		+
		+	The line break before <code><nowiki><includeonly></nowiki></code> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <code><nowiki><includeonly></nowiki></code> to immediately after <code><nowiki></noinclude></nowiki></code>, hiding the template from view.
		+
		+	===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}}
		+
		+	<includeonly>Any categories for the template itself</includeonly>
		+	<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.
		+
		+	<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

---

Current revision as of 01:21, 15 January 2012

Description

This template is used to insert descriptions on template pages.

Syntax

Type <noinclude>{{documentation}}</noinclude> at the top of the template page.

General usage

On the Template page

<noinclude>{{documentation}}
</noinclude>Template code
<includeonly>Categories applied to pages using the template</includeonly>

The line break before <includeonly> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <includeonly> to immediately after </noinclude>, hiding the template from view.

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</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.

Note that the above example also uses the Template:T and Template:T/piece templates.