Difference between revisions of "Template:Documentation"

From Project: Gorgon Wiki
Jump to: navigation, search
m (updating to latest version on http://templates.wikia.com/wiki/Template:Documentation)
m (Fix for documentation starting without SPW and a section or other similar wiki-code.)
Line 42: Line 42:
 
       }}<!--
 
       }}<!--
 
--></div><!--
 
--></div><!--
--><div style="padding: 1em; padding-bottom: 0; margin: 0;"><!--
+
--><div style="padding: 1em; padding-bottom: 0; margin: 0;">
    -->{{#if: {{{content|}}}
+
{{#if: {{{content|}}}
      | <nowiki/>
+
| {{{content}}}
{{{content}}}
+
| {{#ifexist: {{#if: {{{1|}}}
      | {{#ifexist: {{#if: {{{1|}}}
+
              | {{{1}}}
                    | {{{1}}}
+
               | {{FULLPAGENAME}}/doc
                    | {{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 [[w:c:templates:{{#if: {{{1|}}}
 
                                                                  | {{{1}}}
 
                                                                  | {{FULLPAGENAME}}/doc
 
                                                                  }}|Wikia Templates]] which can be copied.
 
              }}{{
 
              #ifeq: {{FULLPAGENAME}} | {{ns:Template}}:Documentation/preload
 
              |
 
              | [[Category:Templates without documentation]]
 
 
               }}
 
               }}
        }}
+
  | {{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 [[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;"><!--

Revision as of 09:31, 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.)