Difference between revisions of "Template:Documentation/core"

From CycleChaos
Jump to navigation Jump to search
(New page: <!-- Start of green doc box --><div id="template-documentation" class="template-documentation iezoomfix"><!-- Add the heading at the top of the doc box: -->{{#ifeq: {{{heading|¬}}} | ...)
 
 
Line 51: Line 51:
 
<div style="clear: both;"></div><!--So right or left floating items don't stick out of the doc box.-->
 
<div style="clear: both;"></div><!--So right or left floating items don't stick out of the doc box.-->
 
</div><!--End of green doc box--><!--
 
</div><!--End of green doc box--><!--
   Link box below for the doc meta-data:
+
    
-->{{#if:
 
  <!--Check if we should show the link box-->
 
  {{#ifeq: {{{link box|}}} | off
 
  |
 
  | {{{doc exist|yes}}}{{
 
    #switch: {{SUBJECTSPACE}}
 
    | {{ns:User}}
 
    | {{ns:Template}} = yes
 
    }}
 
  }}
 
 
 
| {{fmbox
 
  | id = documentation-meta-data
 
  | image = none
 
  | style = background-color: #ecfcf4;
 
  | textstyle = font-style: italic;
 
  | text =
 
    {{#if: {{{link box|}}}
 
    | {{{link box}}}  <!--Use custom link box content-->
 
    | {{#if: {{{doc exist|yes}}}
 
      | <!--/doc exists, link to it-->
 
        The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{docpage|{{FULLPAGENAME}}/doc}}}]]. <small style="font-style: normal">([{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit] &#124; [{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=history}} history])</small> <br>
 
      }}<!--
 
        Add links to /sandbox and /testcases when appropriate:
 
  -->{{#switch: {{SUBJECTSPACE}}
 
      | {{ns:User}}
 
      | {{ns:Template}} =
 
        Editors can experiment in this template's {{
 
        #ifexist: {{{sandbox| {{FULLPAGENAME}}/sandbox }}}
 
        | [[{{{sandbox| {{FULLPAGENAME}}/sandbox }}}|sandbox]] <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit }} edit] {{!}} [{{fullurl:Wikipedia:pagediff | withJS={{urlencode:MediaWiki:Common.js/pagediff.js}}&oldpage={{urlencode:{{{template page|{{FULLPAGENAME}}}}}}}&newpage={{urlencode:{{{sandbox|{{FULLPAGENAME}}/sandbox}}}}}}} diff] )</small>
 
        | sandbox <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit&preload=Template:Documentation/preload-sandbox }} create])</small>
 
        }} and {{
 
        #ifexist: {{{testcases| {{FULLPAGENAME}}/testcases }}}
 
        | [[{{{testcases| {{FULLPAGENAME}}/testcases }}}|testcases]] <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLPAGENAME}}/testcases }}} | action=edit }} edit])</small>
 
        | testcases <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLPAGENAME}}/testcases }}} | action=edit&preload=Template:Documentation/preload-testcases }} create])</small>
 
        }} pages. <br>
 
      }}<!--
 
        Show the cats and interwiki text, but not
 
        if "content" fed or "docname fed" since then it is
 
        unclear where to add the cats and interwikis.
 
  -->{{#if: {{{content|}}} {{{docname fed|}}}
 
      |
 
      | Please add categories and interwikis to the [[{{{docpage|{{FULLPAGENAME}}/doc}}}|/doc]] subpage.
 
      }}<!--
 
        Show the "Subpages" link:
 
  -->{{#switch: {{SUBJECTSPACE}}
 
      | {{ns:File}} =  <!--Don't show it-->
 
      | {{ns:Template}} = &#32;[[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this template]].
 
      | #default = &#32;[[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this page]].
 
      }}
 
    }}{{#ifexist:{{FULLPAGENAME}}/Print
 
    |</br>
 
    }}
 
  }}
 
}}<!--End link box--><!--
 
 
 
 
   Detect and report strange usage:
 
   Detect and report strange usage:
 
-->{{#if:
 
-->{{#if:

Latest revision as of 12:49, 26 May 2010

[edit] [[[:Template:Purge]]] Template documentation

This is the {{documentation/core}} sub-template.

Do not use this template directly, use {{documentation}} instead.

Template:Tlf calls {{documentation/core2}} which in turn calls this template. This template holds most of the code for Template:Tlf, while Template:Tlf and Template:Tlf do parameter preprocessing. Thus simplifying the code.

Technical details[edit]

This sub-template currently expects these parameters:

{{documentation/core
| heading = {{{heading|¬}}}   <!--Note that the "¬" is necessary 
     so we can detect the difference between empty and undefined-->
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}    <!--Text instead of a /doc page-->
| link box = {{{link box|}}}  <!--So "link box=off" works-->

| docpage =     <!--Full pagename of the doc page-->
| doc exist =   <!--"yes" if the doc page exists, empty string if not-->
| docname fed = <!--"yes" if a docname was manually fed-->

| sandbox =     <!--Full pagename of the /sandbox-->
| testcases =   <!--Full pagename of the /testcases-->

| template page =   <!--Full pagename where the {{documentation}}
    template is placed, but without ending /sandbox or /testcases.
    Note: Unfortunately might not be the "correct" namespace if 
    the template is in subject space and the {{documentation}} 
    template is in talk space or the other way around.-->
}}

For more documentation see {{documentation}}.