Template:Documentation/doc: Difference between revisions

From Eco - English Wiki
[checked revision][checked revision]
Created page with "==Description== This template is used to insert descriptions on template pages. <includeonly>Category:Documentation templates</includeonly><noinclude></noinclude> <noinclude>Category:Template Docs</noinclude>"
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
(8 intermediate revisions by the same user not shown)
Line 2: Line 2:
This template is used to insert descriptions on template pages.
This template is used to insert descriptions on template pages.


<includeonly>[[Category:Documentation templates]]</includeonly><noinclude></noinclude>
==Syntax==
Add <code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code> at the end of the template page.
 
==Usage==
 
===On the Template page===
This is the normal format when used:
 
<syntaxhighlight lang="mediawiki">
TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>
</syntaxhighlight>
 
===On the documentation page===
The documentation page is located on the /doc subpage for a template.
 
<syntaxhighlight lang="mediawiki">
== Description ==
This template is used to do something.
 
== Syntax ==
Type <code>{{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 Docs]]</noinclude>
</syntaxhighlight>
 
<includeonly>[[Category:Documentation Templates]]</includeonly>
<noinclude>[[Category:Template Docs]]</noinclude>
<noinclude>[[Category:Template Docs]]</noinclude>

Latest revision as of 10:53, 20 May 2024

Description[edit source]

This template is used to insert descriptions on template pages.

Syntax[edit source]

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

Usage[edit source]

On the Template page[edit source]

This is the normal format when used:

TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>

On the documentation page[edit source]

The documentation page is located on the /doc subpage for a template.

== Description ==
This template is used to do something.

== Syntax ==
Type <code>{{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 Docs]]</noinclude>