Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
No edit summary |
imported>Dinoguy1000 don't categorize preload template |
||
| Line 1: | Line 1: | ||
<div class="template-documentation" style="clear: both; border: 1px solid black; margin: 1em;"> |
|||
<div class="color1" style="padding: 1em; margin: 0;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span>{{ #if: {{{content|}}} || <span id="doc_editlinks" class="editsection plainlinks" style="font-size: 85%;">{{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} |
|||
Header |
|||
| [[[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|view]]] [[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit}} edit]] [[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=history}} history]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} refresh]] |
|||
--><span style="float:right;text-align:right;font-size:85%;margin-top:-11px">{{#ifexist:{{FULLPAGENAME}}/doc|[[{{FULLPAGENAME}}/doc|<span title="View Documentation">View</span>]] · [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} <span title="Edit Documentation">Edit</span>] · [{{fullurl:{{FULLPAGENAME}}/doc|action=history}} <span title="View Documentation History">History</span>]|[{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Template:Preloader/DocumentationPage&redlink=1}} <span title="Create Documentation">Create</span>]}} · [{{fullurl:{{FULLPAGENAME}}|action=purge}} <span title="Reload Documentation if it does not update">Purge</span>]<br />Template: [[Special:WhatLinksHere/{{FULLPAGENAME}}|<span title="View pages using this template">Links</span>]] · [[Special:PrefixIndex/{{FULLPAGENAME}}/|<span title="View subpages of this template">Subpages</span>]]</span>'''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible)</span></div><!-- |
|||
| [[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} create]] |
|||
Actual content |
|||
}}</span> }}</div> |
|||
--><div class="template-docu-content">{{#ifexist:{{FULLPAGENAME}}/doc| |
|||
<div style="padding: 1em; padding-bottom: 0; margin: 0;">{{ #if: {{{content|}}} |
|||
{{#if:{{{notoc|}}}||{{tocright}}}} |
|||
| <nowiki/> |
|||
{{{{PAGENAME}}/doc}}[[Category:Templates with documentation|{{PAGENAME}}]] |
|||
{{{content}}} |
|||
| |
|||
| {{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} |
|||
This template does not yet have any documentation.<br />[{{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Template:Preloader/DocumentationPage&redlink=1}} Add documentation][[Category:Templates without documentation|{{PAGENAME}}]]}} |
|||
| {{tocright}}{{{{ #ifeq: {{NAMESPACE}} | {{ns:Template}} |
|||
| ⚫ | |||
|| :{{NAMESPACE:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}} }}}}: |
|||
Footer |
|||
}}{{ #if: {{{1|}}} | {{PAGENAME:{{{1}}}}} | {{PAGENAME}}/doc}} }} |
|||
--><br style="clear:both;"/><div class="template-docu-footer">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div> |
|||
| :<strong class="error">This template doesn't have any documentation yet!</strong> Help out by [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} writing some]. {{ #ifeq: {{NAMESPACE}} | {{ns:10}} |
|||
| There may also be documentation on [[w:c:templates:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|Wikia Templates]] which can be copied. |
|||
}}{{ #ifeq: {{FULLPAGENAME}} | {{ns:Template}}:Documentation/preload || [[Category:Templates without documentation]] }} |
|||
}} |
|||
}} |
|||
</div> |
|||
<div class="color1" style="clear: both; padding: 0.5em; margin: 0; font-size: 85%; text-align: right;">{{ #if: {{{content|}}} |
|||
| '''[{{fullurl:{{FULLPAGENAME}}|action=edit}} Edit this page]''' to change the above text. ('''[[Template:Documentation|What is this?]]''') |
|||
| {{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} |
|||
| The above text is '''[[m:Transclusion|<span class="color1">transcluded</span>]]''' from '''[[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]]'''; you can '''[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit}} change it]''' or '''[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=history}} view its history]'''. ('''[[Template:Documentation|How does this work?]]''') |
|||
| This template currently doesn't have any documentation; you can '''[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} create it]''' if you know how the template is used. ('''[[Template:Documentation|What is this?]]''') |
|||
}} |
|||
}}<br />If you're done making changes, please '''[{{fullurl:{{FULLPAGENAME}}|action=purge}} refresh the text]'''. ('''[[Help:Purge|Why?]]''')<br />You can experiment in this template's {{ #ifexist: {{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }} | '''[[{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|sandbox]]''' ('''[{{fullurl:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|action=edit}} edit]''' | '''[{{fullurl:Special:ComparePages|page1={{FULLPAGENAMEE}}&page2={{urlencode:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}}}}} diff]''') | sandbox ('''[{{fullurl:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|action=edit&preload=Template:Documentation/preload-sandbox}} create]''' | '''[{{fullurl:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|action=edit&preload={{FULLPAGENAMEE}}&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}}} mirror]''') }} and {{ #ifexist: {{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }} | '''[[{{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }}|testcases]]''' ('''[{{fullurl:{{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }}|action=edit}} edit]''') | testcases ('''[{{fullurl:{{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }}|action=edit&preload=Template:Documentation/preload-testcases}} create]''') }} pages.{{ #if: {{{content|}}} || <br />Please add '''[[Help:Categories|categories]]''' and '''[[Help:Interwiki link|interwikis]]''' to {{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} | '''[[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]]''' | '''[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]''' }}. }} ('''[[Special:PrefixIndex/{{FULLPAGENAME}}/|View all subpages of this page]]'''.)</div> |
|||
| ⚫ | |||
Revision as of 06:01, 6 November 2015
Template documentation (for the above template, sometimes hidden or invisible)[view] [edit] [history] [refresh]
- 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.
The above text is transcluded from Template:Documentation/doc; you can change it or view its history. (How does this work?)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories and interwikis to Template:Documentation/doc. (View all subpages of this page.)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories and interwikis to Template:Documentation/doc. (View all subpages of this page.)
