Template:Documentation: Difference between revisions

From Project Gorgon
Jump to navigation Jump to search
Trimoon (talk | contribs)
m Fix for documentation starting without SPW and a section or other similar wiki-code.
Trimoon (talk | contribs)
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|}}}
-->{{#ifexist: {{#if: {{{1|}}}
                        | {{{1}}}
| {{{1}}}
                        | {{FULLPAGENAME}}/doc
| {{FULLPAGENAME}}/doc
                        }}
}}
            | &#91;[[{{#if: {{{1|}}}
    | &#91;[[{{#if: {{{1|}}}
                    | {{{1}}}
    | {{{1}}}
                    | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                    }}|view]]<!--
    }}|view]]<!--
          -->&#93; <!--
  -->&#93; <!--
          -->[[{{fullurl:{{#if: {{{1|}}}
  -->[[{{fullurl:{{#if: {{{1|}}}
                          | {{{1}}}
  | {{{1}}}
                          | {{FULLPAGENAME}}/doc
  | {{FULLPAGENAME}}/doc
                          }}
  }}
                | action=edit
| action=edit
                }} edit]] <!--
}} edit]] <!--
          -->[[{{fullurl:{{#if: {{{1|}}}
  -->[[{{fullurl:{{#if: {{{1|}}}
                          | {{{1}}}
  | {{{1}}}
                          | {{FULLPAGENAME}}/doc
  | {{FULLPAGENAME}}/doc
                          }}
  }}
                | action=history
| action=history
                }} history]] <!--
}} history]] <!--
          -->[[{{fullurl:{{FULLPAGENAME}}
  -->[[{{fullurl:{{FULLPAGENAME}}
                | action=purge
| action=purge
                }} refresh]]
}} refresh]]
            | [[{{fullurl:{{#if: {{{1|}}}
    | [[{{fullurl:{{#if: {{{1|}}}
                          | {{{1}}}
  | {{{1}}}
                          | {{FULLPAGENAME}}/doc
  | {{FULLPAGENAME}}/doc
                          }}
  }}
                | action=edit&preload=Template:Documentation/preload
| action=edit&preload=Template:Documentation/preload
                }} create]]
}} create]]
            }}<!--
    }}<!--
       --></span>
       --></span>
       }}<!--
       }}<!--
Line 46: Line 46:
| {{{content}}}
| {{{content}}}
| {{#ifexist: {{#if: {{{1|}}}
| {{#ifexist: {{#if: {{{1|}}}
              | {{{1}}}
      | {{{1}}}
              | {{FULLPAGENAME}}/doc
      | {{FULLPAGENAME}}/doc
              }}
      }}
   | {{tocright}}
   | {{tocright}}
{{{{#ifeq: {{NAMESPACE}} | {{ns:Template}}
{{{{#ifeq: {{NAMESPACE}} | {{ns:Template}}
   |
   |
   | :{{NAMESPACE:{{#if: {{{1|}}}
   | :{{NAMESPACE:{{#if: {{{1|}}}
                | {{{1}}}
| {{{1}}}
                | {{FULLPAGENAME}}
| {{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}}}
      | {{{1}}}
                              | {{FULLPAGENAME}}/doc
      | {{FULLPAGENAME}}/doc
                              }}
      }}
                    | action=edit&preload=Template:Documentation/preload
    | action=edit&preload=Template:Documentation/preload
                    }} writing some]. <!--
    }} 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}}}
    | {{{1}}}
                                                            | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                                                            }}|Wikia Templates]] which can be copied.
    }}|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
    | action=edit
            }} Edit this page]''' to change the above text. ('''[[Template:Documentation|What is this?]]''')
    }} Edit this page]''' to change the above text. ('''[[Template:Documentation|What is this?]]''')
       | {{#ifexist: {{#if: {{{1|}}}
       | {{#ifexist: {{#if: {{{1|}}}
                    | {{{1}}}
    | {{{1}}}
                    | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                    }}
    }}
        | The above text is '''[[m:Transclusion|<span class="color1">transcluded</span>]]''' <!--
| The above text is '''[[m:Transclusion|<span class="color1">transcluded</span>]]''' <!--
          -->from '''[[{{#if: {{{1|}}}
  -->from '''[[{{#if: {{{1|}}}
                        | {{{1}}}
| {{{1}}}
                        | {{FULLPAGENAME}}/doc
| {{FULLPAGENAME}}/doc
                        }}]]'''; <!--
}}]]'''; <!--
          -->you can '''[{{fullurl:{{#if: {{{1|}}}
  -->you can '''[{{fullurl:{{#if: {{{1|}}}
                                    | {{{1}}}
    | {{{1}}}
                                    | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                                    }}
    }}
                          | action=edit
  | action=edit
                          }} change it]''' <!--
  }} change it]''' <!--
          -->or '''[{{fullurl:{{#if: {{{1|}}}
  -->or '''[{{fullurl:{{#if: {{{1|}}}
                              | {{{1}}}
      | {{{1}}}
                              | {{FULLPAGENAME}}/doc
      | {{FULLPAGENAME}}/doc
                              }}
      }}
                    | action=history
    | action=history
                    }} view its history]'''. <!--
    }} view its history]'''. <!--
          -->('''[[Template:Documentation|How does this work?]]''')
  -->('''[[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|}}}
                                    | {{{1}}}
    | {{{1}}}
                                    | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                                    }}
    }}
                          | action=edit&preload=Template:Documentation/preload
  | action=edit&preload=Template:Documentation/preload
                          }} create it]''' <!--
  }} create it]''' <!--
          -->if you know how the template is used. <!--
  -->if you know how the template is used. <!--
          -->('''[[Template:Documentation|What is this?]]''')
  -->('''[[Template:Documentation|What is this?]]''')
        }}
}}
       }}<br />If you're done making changes, <!--
       }}<br />If you're done making changes, <!--
        -->please '''[{{fullurl:{{FULLPAGENAME}}
-->please '''[{{fullurl:{{FULLPAGENAME}}
                      | action=purge
      | action=purge
                      }} refresh the text]'''. <!--
      }} refresh the text]'''. <!--
        -->('''[[Help:Purge|Why?]]''')<br /><!--
-->('''[[Help:Purge|Why?]]''')<br /><!--
        -->You can experiment in this template's <!--
-->You can experiment in this template's <!--
            -->{{#ifexist: {{#if: {{{sandbox|}}}
    -->{{#ifexist: {{#if: {{{sandbox|}}}
                          | {{{sandbox}}}
  | {{{sandbox}}}
                          | {{FULLPAGENAME}}/sandbox
  | {{FULLPAGENAME}}/sandbox
                          }}
  }}
              | '''[[{{#if: {{{sandbox|}}}
      | '''[[{{#if: {{{sandbox|}}}
                      | {{{sandbox}}}
      | {{{sandbox}}}
                      | {{FULLPAGENAME}}/sandbox
      | {{FULLPAGENAME}}/sandbox
                      }}|sandbox]]''' <!--
      }}|sandbox]]''' <!--
                -->('''[{{fullurl:{{#if: {{{sandbox|}}}
-->('''[{{fullurl:{{#if: {{{sandbox|}}}
                                  | {{{sandbox}}}
  | {{{sandbox}}}
                                  | {{FULLPAGENAME}}/sandbox
  | {{FULLPAGENAME}}/sandbox
                                  }}
  }}
                        | action=edit
| action=edit
                        }} edit]''' <!--
}} edit]''' <!--
                -->&#124; <!--
-->&#124; <!--
                -->'''[{{fullurl:Special:ComparePages
-->'''[{{fullurl:Special:ComparePages
                        | page1={{FULLPAGENAMEE}}&page2={{urlencode:{{#if: {{{sandbox|}}}
| page1={{FULLPAGENAMEE}}&page2={{urlencode:{{#if: {{{sandbox|}}}
                                                                    | {{{sandbox}}}
    | {{{sandbox}}}
                                                                    | {{FULLPAGENAME}}/sandbox
    | {{FULLPAGENAME}}/sandbox
                                                                    }}
    }}
                                                        }}
}}
                        }} diff]'''<!--
}} diff]'''<!--
                -->)
-->)
              | sandbox ('''[{{fullurl:{{#if: {{{sandbox|}}}
      | sandbox ('''[{{fullurl:{{#if: {{{sandbox|}}}
                                        | {{{sandbox}}}
| {{{sandbox}}}
                                        | {{FULLPAGENAME}}/sandbox
| {{FULLPAGENAME}}/sandbox
                                        }}
}}
                              | action=edit&preload=Template:Documentation/preload-sandbox
      | action=edit&preload=Template:Documentation/preload-sandbox
                              }} create]''' <!--
      }} create]''' <!--
                -->&#124; <!--
-->&#124; <!--
                -->'''[{{fullurl:{{#if: {{{sandbox|}}}
-->'''[{{fullurl:{{#if: {{{sandbox|}}}
                                  | {{{sandbox}}}
  | {{{sandbox}}}
                                  | {{FULLPAGENAME}}/sandbox
  | {{FULLPAGENAME}}/sandbox
                                  }}
  }}
                        | action=edit&preload={{FULLPAGENAMEE}}&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}
| action=edit&preload={{FULLPAGENAMEE}}&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}
                        }} mirror]''' <!--
}} mirror]''' <!--
                -->)
-->)
              }} <!--
      }} <!--
            -->and {{#ifexist: {{#if: {{{testcases|}}}
    -->and {{#ifexist: {{#if: {{{testcases|}}}
                              | {{{testcases}}}
      | {{{testcases}}}
                              | {{FULLPAGENAME}}/testcases
      | {{FULLPAGENAME}}/testcases
                              }}
      }}
                  | '''[[{{#if: {{{testcases|}}}
  | '''[[{{#if: {{{testcases|}}}
                          | {{{testcases}}}
  | {{{testcases}}}
                          | {{FULLPAGENAME}}/testcases
  | {{FULLPAGENAME}}/testcases
                          }}|testcases]]''' <!--
  }}|testcases]]''' <!--
                    -->('''[{{fullurl:{{#if: {{{testcases|}}}
    -->('''[{{fullurl:{{#if: {{{testcases|}}}
                                      | {{{testcases}}}
      | {{{testcases}}}
                                      | {{FULLPAGENAME}}/testcases
      | {{FULLPAGENAME}}/testcases
                                      }}
      }}
                            | action=edit
    | action=edit
                            }} edit]''')
    }} edit]''')
                  | testcases ('''[{{fullurl:{{#if: {{{testcases|}}}
  | testcases ('''[{{fullurl:{{#if: {{{testcases|}}}
                                              | {{{testcases}}}
      | {{{testcases}}}
                                              | {{FULLPAGENAME}}/testcases
      | {{FULLPAGENAME}}/testcases
                                              }}
      }}
                                    | action=edit&preload=Template:Documentation/preload-testcases
    | action=edit&preload=Template:Documentation/preload-testcases
                                    }} create]''')
    }} create]''')
                  }} <!--
  }} <!--
            -->pages.<!--
    -->pages.<!--
            -->{{#if: {{{content|}}}
    -->{{#if: {{{content|}}}
              |
      |
              | <br />Please add '''[[Help:Categories|categories]]''' and '''[[Help:Interwiki link|interwikis]]''' to <!--
      | <br />Please add '''[[Help:Categories|categories]]''' and '''[[Help:Interwiki link|interwikis]]''' to <!--
                -->{{#ifexist: {{#if: {{{1|}}}
-->{{#ifexist: {{#if: {{{1|}}}
                                | {{{1}}}
| {{{1}}}
                                | {{FULLPAGENAME}}/doc
| {{FULLPAGENAME}}/doc
                                }}
}}
                    | '''[[{{#if: {{{1|}}}
    | '''[[{{#if: {{{1|}}}
                          | {{{1}}}
  | {{{1}}}
                          | {{FULLPAGENAME}}/doc
  | {{FULLPAGENAME}}/doc
                          }}]]'''
  }}]]'''
                    | '''[{{fullurl:{{#if: {{{1|}}}
    | '''[{{fullurl:{{#if: {{{1|}}}
                                    | {{{1}}}
    | {{{1}}}
                                    | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                                    }}
    }}
                          | action=edit&preload=Template:Documentation/preload
  | action=edit&preload=Template:Documentation/preload
                          }} {{#if: {{{1|}}}
  }} {{#if: {{{1|}}}
                            | {{{1}}}
    | {{{1}}}
                            | {{FULLPAGENAME}}/doc
    | {{FULLPAGENAME}}/doc
                            }}]'''
    }}]'''
                    }}.
    }}.
              }} <!--
      }} <!--
            -->('''[[Special:PrefixIndex/{{FULLPAGENAME}}/|View all subpages of this page]]'''.)<!--
    -->('''[[Special:PrefixIndex/{{FULLPAGENAME}}/|View all subpages of this page]]'''.)<!--
--></div>
--></div>
</div>
</div>

Revision as of 13:38, 10 April 2016

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