Difference between revisions of "Documentation"
From ACES
(Created page with "<includeonly>{| class="article-table" style="width:100%;" role="complementary" |- style="font-size:18px;" ! style="padding:0px;" | <div style="width:100%; padding:3px 0px; tex...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
< | <div style="clear: both; border: 1px solid; margin: 1em;"> | ||
<div style="padding: 1em; margin: 0;">'''Template documentation''' <span style="font-size: 85%; float: right;">{{Edit shortcuts|doc}}</span></div> | |||
<div style="padding: 1em; padding-bottom: 0; margin: 0;">{{#if: {{{content|}}} | |||
| <nowiki/> | |||
| | {{{content}}} | ||
| | | {{#ifexist: {{#if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} | ||
| | | {{tocright}} | ||
| | {{{{#ifeq: {{NAMESPACE}} | {{ns:Template}} | ||
| | || :{{NAMESPACE:{{#if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}} }}}}: | ||
| | }}{{ #if: {{{1|}}} | {{PAGENAME:{{{1}}}}} | {{PAGENAME}}/doc}} }} | ||
| :<strong class="error">This template doesn't have any documentation yet!</strong> Help out by [{{fullurl:{{ #if: {{{1|}}} | {{ urlencode: {{{1}}} }} | {{FULLPAGENAMEE}}/doc }}|action=edit&preload=Template:Documentation/preload}} writing some]. {{ | |||
{{{{{1|{{ | #ifeq: {{NAMESPACE}} | {{ns:10}} | ||
| There may also be documentation on [[w:c:templates:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|Wikia Templates]] which can be copied. | |||
}}[[Category:Templates without documentation]] | |||
}} | |||
}} | |||
<br/> | |||
</div> | |||
<div style="padding: 0.5em; margin: 0;"></div> | |||
</div> | |||
<noinclude> | |||
[[Category:Data templates]] | |||
</noinclude> | |||
Latest revision as of 16:46, 15 September 2021
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.
Add <noinclude>{{documentation|documentation page}}</noinclude> to transclude an alternative page from the /doc subpage.
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>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.
On the documentation page[edit source]
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).
Normally, you will want to write something like the following on the documentation page:
==Description==
This template is used to do something.
==Syntax==
Type <code>{{t|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 documentation|{{PAGENAME}}]]</noinclude>
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 and Template:T/piece templates.