Difference between revisions of "Template:Documentation"
From Project: Gorgon Wiki
m (updating to latest version on http://templates.wikia.com/wiki/Template:Documentation) |
m (Removed code allowing for easy creation of template sandboxes.) |
||
(4 intermediate revisions by one other user not shown) | |||
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> | ||
}}<!-- | }}<!-- | ||
--></div><!-- | --></div><!-- | ||
− | --><div style="padding: 1em; padding-bottom: 0; margin: 0;"> | + | --><div style="padding: 1em; padding-bottom: 0; margin: 0;"> |
− | + | {{#if: {{{content|}}} | |
− | + | | {{{content}}} | |
− | {{{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|}}} | |
− | + | | {{{1}}} | |
− | + | | {{FULLPAGENAME}}/doc | |
− | + | }} | |
− | + | | action=edit&preload=Template:Documentation/preload | |
− | + | }} writing some]. <!-- | |
− | + | -->{{#ifeq: {{NAMESPACE}} | {{ns:10}} | |
− | + | | There may also be documentation on [[wikia: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><!-- | ||
--><div class="color1" style="clear: both; padding: 0.5em; margin: 0; font-size: 85%; text-align: right;"><!-- | --><div class="color1" style="clear: both; padding: 0.5em; margin: 0; font-size: 85%; text-align: right;"><!-- | ||
-->{{#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 transcluded <!-- | |
− | + | -->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]'''. | |
− | + | | 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]'''. <!-- | |
− | + | -->{{#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> |
Latest revision as of 15:23, 17 June 2021
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.
If you're done making changes, please refresh the text.
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.
Please add categories and interwikis to Template:Documentation/doc. (View all subpages of this page.)