Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
imported>PedroJJBA No edit summary |
m →top: clean up |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<!--------- |
|||
<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:0em;">'''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible)</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{tocright}} |
|||
Box |
|||
| ⚫ | |||
Note: the reason why a table is not used for the whole box is because sometimes the templates used as examples in the documentation page will enter in conflict with it. |
|||
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div> |
|||
---------> |
|||
{{documentation}}[[Category:Template Documentation| ]]</noinclude> |
|||
<div id="Documentation" style="width:99%; clear:both; border:2px solid #000; margin-top:2em;"> |
|||
<!----------- |
|||
Header |
|||
-----------> |
|||
{| style="width:100%; border-collapse:collapse; background:#ff98ba; color:#000; border-bottom:1px solid #000;" |
|||
| style="width:140px; text-align:center; padding:1em;" | |
|||
| style="padding:1em;" | <span style="font-size:20px;">'''Template Documentation'''</span> <sup style="font-size:12px; font-style:italic;">(sometimes hidden or invisible)</sup> |
|||
<span style="font-size:12px;">'''Template tools:''' [{{fullurl:{{FULLPAGENAME}}|action=purge}} purge] • [[Special:WhatLinksHere/{{FULLPAGENAME}}|what links here]] • [{{fullurl:Special:WhatLinksHere/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} what transclude this] • [[Special:PrefixIndex/{{FULLPAGENAME}}/|subpages]]</span> |
|||
|} |
|||
<!------------------------------ |
|||
View Documentation |
|||
------------------------------> |
|||
<div class="volume" style="padding:10px 5px; background:#fff4f8; font-size: 85%;"> |
|||
{{#ifexist: {{FULLPAGENAME}}/doc |
|||
| {{#if: {{{NOTOC|}}} | __NOTOC__ | {{Tocright}} }}{{{{PAGENAME}}/doc}} |
|||
| <div style="margin:auto;"><strong class="error">This template currently doesn't have any documentation!</strong> |
|||
<br /> |
|||
Help out by [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit&preload=Template:Documentation/preload}} writing some].</div> |
|||
<includeonly>[[Category:Templates Without Documentation]]</includeonly> |
|||
}} |
|||
</div> |
|||
<!------------ |
|||
Footer |
|||
------------> |
|||
<div style="clear:both; background:#ff98ba; color:#000; border-top:1px solid #000; padding:1em; font-size:12px;"> |
|||
Visit {{#ifexist: {{FULLPAGENAME}}/doc |
|||
| [[{{FULLPAGENAME}}/doc]] |
|||
| [{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Template:Documentazione/preload}} {{FULLPAGENAME}}/doc] |
|||
}} to edit this text! ([[Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text) |
|||
</div> |
|||
</div> |
|||
| ⚫ | |||
Latest revision as of 18:58, 23 June 2020
| Template Documentation (sometimes hidden or invisible)
Template tools: purge • what links here • what transclude this • subpages |
- Description
- This template is used to insert a documentation box on template pages. The box makes use of MediaWiki's Transclusion functionality to automatically load the contents of the /doc subpage.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the end of the template page. Make sure the opening <noinclude> starts directly after the template code and not on the line below. This would insert an unwanted newline to the template.
General usage
On the Template page
(Template code here)<noinclude>
{{documentation}}</noinclude>
You may additional add the notoc parameter if the table of contents is not desired.
On the Documentation subpage
On the documentation page you can provide all the needed info for people to know how to use the template.
Every documentation page should start with {{Documentation subpage}}. This will add the appropriate header and category to the page.
The format for the documentation page varies, but try to include at least the following:
- Description: A short description/introduction of what the template does and when/where it should be used.
- Syntax/Parameters: The syntax/parameters that the template uses. Make sure to explain individual parameters if needed.
- Examples: Brief examples demonstrating the template with the various parameters filled in.
Visit Template:Documentation/doc to edit this text! (How does this work?) (Refresh this text)
