Editing Template:Documentation/doc

==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>&lt;nowiki>{{templatename|input}}&lt;/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.
@@ Line 1: / Line 1: @@
-{{Documentation/Header}}
+==Description==
-{{Lua|Documentation}}
+This template is used to insert descriptions on template pages.
-{{CSS}}
-This template is used to insert documentation to template pages.
 ==Syntax==
-* {{T|Documentation}} will produce the documentation template.
+Add <code><nowiki><noinclude></nowiki>{{t|Documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
-* {{T|Documentation|foo}} will fill in the documentation from the "<code>foo</code>" template.
-* {{T|Documentation|p1=content=This template does something}} will fill in the documentation with the content "<code>This template does something</code>." (not recommended except for very, very short documentation)
-* {{T|Documentation|p1=heading=Important information}} will replace the default heading with "<code>Important information</code>".
-* {{T|Documentation|p1=type=category}} will add the "<code>category Templates</code>" category.
-==Template Data==
+Add <code><nowiki><noinclude></nowiki>{{t|Documentation|documentation page}}<nowiki></noinclude></nowiki></code> to transclude an alternative page from the /doc subpage.
-<templatedata>
-{
+==Usage==
-	"description": {
-		"en": "This template is used to insert descriptions on template pages."
+===On the Template page===
-	},
+This is the normal format when used:
-	"format": "inline",
-	"params": {
+<pre>
-		"1": {
+TEMPLATE CODE
-			"label": {
+<includeonly>Any categories to be inserted into articles by the template</includeonly>
-				"en": "Custom Documentation Page"
+<noinclude>{{Documentation}}</noinclude>
-			},
+</pre>
-			"description": {
-				"en": "Page containing the documentation"
+''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).''
-			},
-			"default": "{{FULLPAGENAME}}/doc",
+''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.''
-			"type": "wiki-page-name"
-		},
+===On the documentation page===
-		"heading": {
+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]]).
-			"label": {
-				"en": "Heading"
+Normally, you will want to write something like the following on the documentation page:
-			},
-			"description": {
+<pre>
-				"en": "Custom heading"
+==Description==
-			},
+This template is used to do something.
-			"default": {
-				"en": "[[File:Template-icon.svg|50px|link=|alt=Documentation icon]] Documentation"
+==Syntax==
-			},
+Type <code>{{t|templatename}}</code> somewhere.
-			"type": "line"
-		},
+==Samples==
-		"preload": {
+<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>
-			"label": {
-				"en": "Preload Page"
+results in...
-			},
-			"description": {
+{{templatename|input}}
-				"en": "The page to preload if the `/doc` subpage doesn't exist."
-			},
+<includeonly>Any categories for the template itself</includeonly>
-			"default": "Template:Documentation/preload",
+<noinclude>[[Category:Template documentation]]</noinclude>
-			"type": "wiki-page-name"
+</pre>
-		},
-		"content": {
+Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
-			"label": {
-				"en": "Content",
+Note that the above example also uses the [[Template:T]] template.
-				"tr": "İçerik"
-			},
-			"description": {
-				"en": "Custom documentation content, prevents transclusion of `/doc` subpage."
-			},
-			"type": "content"
-		},
-		"type": {
-			"label": "Type",
-			"description": "Category to categorize template in.",
-			"type": "string",
-			"suggested": true
-		}
-	}
-}
-</templatedata>