Difference between revisions of "Template:Documentation"

From Project: Gorgon Wiki
Jump to: navigation, search
m (Changing link to purge helppage.)
m (Removed code allowing for easy creation of template sandboxes.)
 
Line 92: Line 92:
 
    | {{FULLPAGENAME}}/doc
 
    | {{FULLPAGENAME}}/doc
 
    }}
 
    }}
| The above text is '''[[m:Transclusion|<span class="color1">transcluded</span>]]''' <!--
+
| The above text is transcluded <!--
 
  -->from '''[[{{#if: {{{1|}}}
 
  -->from '''[[{{#if: {{{1|}}}
 
| {{{1}}}
 
| {{{1}}}
Line 108: Line 108:
 
      }}
 
      }}
 
    | action=history
 
    | action=history
    }} view its history]'''. <!--
+
    }} view its history]'''.
  -->('''[[Template:Documentation|How does this work?]]''')
 
 
| This template currently doesn't have any documentation; <!--
 
| This template currently doesn't have any documentation; <!--
 
  -->you can '''[{{fullurl:{{#if: {{{1|}}}
 
  -->you can '''[{{fullurl:{{#if: {{{1|}}}
Line 124: Line 123:
 
      | action=purge
 
      | action=purge
 
      }} refresh the text]'''. <!--
 
      }} refresh the text]'''. <!--
-->('''[[mw:Manual: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]''' <!--
 
-->&#124; <!--
 
-->'''[{{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]''' <!--
 
-->&#124; <!--
 
-->'''[{{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|}}}
 
    -->{{#if: {{{content|}}}
 
      |
 
      |

Latest revision as of 15:23, 17 June 2021

Template documentation (for the above template, sometimes hidden or invisible) [view] [edit] [history] [refresh]
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

{{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.)