Difference between revisions of "Template:Documentation"
From Project: Gorgon Wiki
m (Fix for documentation starting without SPW and a section or other similar wiki-code.) |
m (copy-over from latest version on http://templates.wikia.com/wiki/Template:Documentation) |
||
| Line 8: | Line 8: | ||
| | | | ||
| <span id="doc_editlinks" class="editsection plainlinks" style="font-size: 85%; float:right;"><!-- | | <span id="doc_editlinks" class="editsection plainlinks" style="font-size: 85%; float:right;"><!-- | ||
| − | + | -->{{#ifexist: {{#if: {{{1|}}} | |
| − | + | | {{{1}}} | |
| − | + | | {{FULLPAGENAME}}/doc | |
| − | + | }} | |
| − | + | | [[[{{#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]] | |
| − | + | | [[{{fullurl:{{#if: {{{1|}}} | |
| − | + | | {{{1}}} | |
| − | + | | {{FULLPAGENAME}}/doc | |
| − | + | }} | |
| − | + | | action=edit&preload=Template:Documentation/preload | |
| − | + | }} create]] | |
| − | + | }}<!-- | |
--></span> | --></span> | ||
}}<!-- | }}<!-- | ||
| Line 46: | Line 46: | ||
| {{{content}}} | | {{{content}}} | ||
| {{#ifexist: {{#if: {{{1|}}} | | {{#ifexist: {{#if: {{{1|}}} | ||
| − | + | | {{{1}}} | |
| − | + | | {{FULLPAGENAME}}/doc | |
| − | + | }} | |
| {{tocright}} | | {{tocright}} | ||
{{{{#ifeq: {{NAMESPACE}} | {{ns:Template}} | {{{{#ifeq: {{NAMESPACE}} | {{ns:Template}} | ||
| | | | ||
| :{{NAMESPACE:{{#if: {{{1|}}} | | :{{NAMESPACE:{{#if: {{{1|}}} | ||
| − | + | | {{{1}}} | |
| − | + | | {{FULLPAGENAME}} | |
| − | + | }} | |
}}: | }}: | ||
}}{{ | }}{{ | ||
| Line 65: | Line 65: | ||
| :<strong class="error">This template doesn't have any documentation yet!</strong> <!-- | | :<strong class="error">This template doesn't have any documentation yet!</strong> <!-- | ||
-->Help out by [{{fullurl:{{#if: {{{1|}}} | -->Help out by [{{fullurl:{{#if: {{{1|}}} | ||
| − | + | | {{{1}}} | |
| − | + | | {{FULLPAGENAME}}/doc | |
| − | + | }} | |
| − | + | | action=edit&preload=Template:Documentation/preload | |
| − | + | }} writing some]. <!-- | |
-->{{#ifeq: {{NAMESPACE}} | {{ns:10}} | -->{{#ifeq: {{NAMESPACE}} | {{ns:10}} | ||
| There may also be documentation on [[w:c:templates:{{#if: {{{1|}}} | | 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 | #ifeq: {{FULLPAGENAME}} | {{ns:Template}}:Documentation/preload | ||
| Line 86: | Line 86: | ||
-->{{#if: {{{content|}}} | -->{{#if: {{{content|}}} | ||
| '''[{{fullurl:{{FULLPAGENAME}} | | '''[{{fullurl:{{FULLPAGENAME}} | ||
| − | + | | action=edit | |
| − | + | }} Edit this page]''' to change the above text. ('''[[Template:Documentation|What is this?]]''') | |
| {{#ifexist: {{#if: {{{1|}}} | | {{#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, <!-- | }}<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> | --></div> | ||
</div> | </div> | ||
Revision as of 09:38, 10 April 2016
Template documentation (for the above template, sometimes hidden or invisible) [view] [edit] [history] [refresh]
 | This template was copied from Template:Documentation on Wikia Templates. That wiki should periodically be checked for a new version of this template. |
- Description
- This template is used to insert documentation on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the end of the template page.
General usage
On the Template page
<noinclude>{{Underconstruction}}
</noinclude><!-- Template code --><noinclude>
{{documentation}}
</noinclude>
On the Template/doc page
|
Preloading
Not needed when using the preload functionality provided by the create link when using the {{Documentation}} template. |
{{SPW|name={{subst:msg:BASEPAGENAME}}}}
<includeonly><!-- Any categories for the template itself -->
</includeonly><noinclude>
[[Category:Template documentation]]
</noinclude>
==Description==
:This template is used to do something.
==Dependencies==
:* Uses (some CSS, JS, file, or other template).
==Syntax==
:Type <code>{{t|templatename}}</code> somewhere.
==Sample output==
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}
- Use any or all of the above description/syntax/sample output sections.
- You may also want to add "see also" or further usage information sections.
- Note that the above example also uses {{T}}.
Dependencies
- Site-wide CSS:
.template-documentation .color1, #bodyContent .template-documentation .color1 a, #bodyContent .template-documentation .color1 a.external { background-color:#36C; color:white; }
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.)
