Documentation: Difference between revisions

From SL Pro Wrestling Wiki
/>Wumbolo
m bypassed redirect
m 303 revisions imported
 
(224 intermediate revisions by 17 users not shown)
Line 1: Line 1:
<!--    -*- mode:MediawikiNG; tab-width:8; indent-tabs-mode:tab; -*-
<includeonly>{| class="article-table plainlinks" style="width:100%;" role="complementary"
NOTE:
|- style="font-size:18px;"
    PLEASE keep the indentations intact !
! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
    The above emacs Modeline will preset most intelligent editors
|-
with correct setting. If your editor doesn't understand
| ''Note: portions of the template sample may not be visible without values provided.''
'mode:MediawikiNG;' then use 'mode:PHP;'
|-
    Please keep this and oter HTML-comment it does not negatively impact
| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
any of the functioning of the template but improves readability
|-
that is crucial in maintainability by other editors.
| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/sandbox|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages.
 
|}
TODO:
<div style="margin:0 1em;">
    I used SublimeText with tab-size set to 4 then just
{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]</noinclude>
before saving to wiki i did "Convert Indentation to Spaces"
then changed tab-size set to 8 and did "Convert Indentation to Tabs".
    After those 2 steps i commited to wiki.
    This is needed so people using the editor on wiki will not see
unaligned code and try to correct it unnecessarily.
    When you use SublimeText also you can reverse the steps before editing
to make life easier :)
--><div
class="template-documentation"
style="clear:both; border:1px solid black; margin:1em;"
><div
    class="color1"
    style="padding:1em; margin:0;"
    ><b>Template documentation</b> <!--
--><span
style="font-size:85%;"
>(for the above template, sometimes partially or fully invisible)<!--
--></span><!--
-->{{#if:
{{{content|}}}
    |
    |  <span
    id="doc_editlinks"
    class="editsection plainlinks"
    style="font-size:75%; float:right;"
    >{{#ifexist:
{{{1|{{FULLPAGENAME}}/doc}}}
    |  &#91;[[{{{1|{{FULLPAGENAME}}/doc}}}|view]]&#93; <!--
    -->&#91;[{{fullurl:    {{{1|{{FULLPAGENAME}}/doc}}}
      | action=edit
      }} edit]&#93; <!--
    -->&#91;[{{fullurl:    {{{1|{{FULLPAGENAME}}/doc}}}
      | action=history
      }} history]&#93; <!--
    -->&#91;[{{fullurl:    {{FULLPAGENAME}}
      | action=purge
      }} refresh]&#93;
    |  &#91;[{{fullurl:    {{{1|{{FULLPAGENAME}}/doc}}}
      | action=edit&preload=Template:Documentation/preload
      }} create]&#93;
    }}<!--
    --></span>
    }}<!--
    --></div><!--
    --><div
    style="padding:1em; padding-bottom:0; margin:0;"
    >{{#if:
{{{content|}}}
    |  {{{content}}}
    |  {{#ifexist:
    {{{1|{{FULLPAGENAME}}/doc}}}
|  {{tocright}}<!--
-->{{:{{{1|{{FULLPAGENAME}}/doc}}} }}
|  :<!--
--><strong
class="error"
>This template doesn't have any documentation yet!<!--
--></strong> <!--
-->Help out by [{{fullurl: {{{1|{{FULLPAGENAME}}/doc}}}
| action=edit&preload=Template:Documentation/preload
}} writing some]. <!--
-->{{#ifeq:
{{NAMESPACE}} | {{ns:Template}}
    |  There may also be documentation on <!--
-->[[w:c:templates:{{{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|}}}
    |  <b><!--
-->[{{fullurl:  {{FULLPAGENAME}}
    | action=edit
    }} Edit this page]<!--
    --></b> to change the above text. <!--
    -->(<!--
--><b><!--
    -->[[Template:Documentation|What is this?]]<!--
--></b><!--
    -->)
    |  {{#ifexist:
    {{{1|{{FULLPAGENAME}}/doc}}}
|  The above text is <!--
    --><b><!--
-->[[m:Help:Transclusion|<span
class="color1"
>transcluded<!--
--></span>]]<!--
    --></b> <!--
-->from <b><!--
-->[[{{{1|{{FULLPAGENAME}}/doc}}}]]<!--
      --></b>; <!--
-->you can <b><!--
    -->[{{fullurl:  {{{1|{{FULLPAGENAME}}/doc}}}
| action=edit
}} change it]<!--
--></b> <!--
-->or <b><!--
      -->[{{fullurl:  {{{1|{{FULLPAGENAME}}/doc}}}
  | action=history
  }} view its history]<!--
    --></b>. <!--
-->(<!--
    --><b><!--
-->[[Template:Documentation|How does this work?]]<!--
    --></b><!--
-->)
|  This template currently doesn't have any documentation; <!--
-->you can <b><!--
    -->[{{fullurl:  {{{1|{{FULLPAGENAME}}/doc}}}
| action=edit&preload=Template:Documentation/preload
}} create it]<!--
--></b> <!--
-->if you know how the template is used. <!--
-->(<!--
    --><b><!--
-->[[Template:Documentation|What is this?]]<!--
    --></b><!--
-->)
}}
    }}<br/><!--
-->If you're done making changes, please <!--
    --><b><!--
-->[{{fullurl:  {{FULLPAGENAME}}
    | action=purge
    }} refresh the text]<!--
    --></b>. <!--
    -->(<!--
--><b><!--
    -->[[mw:Manual:Purge|Why?]]<!--
--></b><!--
    -->)<br/><!--
-->You can experiment in this template's <!--
    -->{{#ifexist:
    {{{sandbox|{{FULLPAGENAME}}/sandbox}}}
|  <b><!--
    -->[[{{{sandbox|{{FULLPAGENAME}}/sandbox}}}|sandbox]]<!--
--></b> <!--
-->(<!--
    --><b><!--
-->[{{fullurl: {{{sandbox|{{FULLPAGENAME}}/sandbox}}}
    | action=edit
    }} edit]<!--
    --></b> <!--
    -->&#124; <!--
    --><b><!--
-->[{{fullurl: Special:ComparePages
    | page1={{FULLPAGENAMEE}}&page2={{urlencode:
    {{{sandbox|{{FULLPAGENAME}}/sandbox}}}
}}
    }} diff]<!--
    --></b><!--
-->)
|   sandbox <!--
-->(<!--
    --><b><!--
-->[{{fullurl:  {{{sandbox|{{FULLPAGENAME}}/sandbox}}}
    | action=edit&preload=Template:Documentation/preload-sandbox
    }} create]<!--
    --></b> <!--
    -->&#124; <!--
    --><b><!--
-->[{{fullurl:  {{{sandbox|{{FULLPAGENAME}}/sandbox}}}
    | action=edit&preload={{FULLPAGENAMEE}}&summary={{urlencode:
    Create sandbox version of [[{{FULLPAGENAME}}]]
}}
    }} mirror]<!--
    --></b><!--
-->)
}} <!--
    -->and <!--
    -->{{#ifexist:
    {{{testcases|{{FULLPAGENAME}}/testcases}}}
|  <b><!--
    -->[[{{{testcases|{{FULLPAGENAME}}/testcases}}}|testcases]]<!--
--></b> <!--
-->(<!--
    --><b><!--
-->[{{fullurl:  {{{testcases|{{FULLPAGENAME}}/testcases}}}
    | action=edit
    }} edit]<!--
    --></b><!--
-->)
|  testcases <!--
-->(<!--
    --><b><!--
-->[{{fullurl:  {{{testcases|{{FULLPAGENAME}}/testcases}}}
    | action=edit&preload=Template:Documentation/preload-testcases
    }} create]<!--
    --></b><!--
-->)
}} <!--
    -->pages.<br/><!--
-->{{#if:
{{{content|}}}
    |
    |  Please add <b><!--
    -->[[Help:Categories|categories]]<!--
--></b> <!--
    -->and <b><!--
    -->[[Help:Interwiki link|interwikis]]<!--
--></b> <!--
    -->to <b><!--
    -->{{#ifexist:
    {{{1|{{FULLPAGENAME}}/doc}}}
      |    [[{{{1|{{FULLPAGENAME}}/doc}}}]]
      |    [{{fullurl: {{{1|{{FULLPAGENAME}}/doc}}}
    | action=edit&preload=Template:Documentation/preload
    }} {{{1|{{FULLPAGENAME}}/doc}}}]
}}<!--
--></b>.
    }} <!--
-->(<!--
    --><b><!--
-->[[Special:PrefixIndex/{{FULLPAGENAME}}/|View all subpages of this page]]<!--
    --></b>.<!--
-->)<!--
    --></div><!--
--></div>

Latest revision as of 08:12, 2 August 2024