Template:Documentation/core: Difference between revisions

From Halachipedia
(Created page with '<!-- Start of green doc box --><div id="template-documentation" class="template-documentation iezoomfix"><!-- Add the heading at the top of the doc box: -->{{#ifeq: {{{headin…')
 
m (41 revisions)
 
(7 intermediate revisions by 2 users not shown)
Line 11: Line 11:
     <span class="editsection plainlinks" id="doc_editlinks">{{
     <span class="editsection plainlinks" id="doc_editlinks">{{
     #if: {{{doc exist|yes}}}
     #if: {{{doc exist|yes}}}
     | [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [{{purge|purge}}]  
     | &#91;[[{{{docpage|{{FULLPAGENAME}}/doc}}}|view]]&#93; [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=history}} history]] [{{purge|purge}}]  
     | <!--/doc doesn't exist-->
     | <!--/doc doesn't exist-->
       [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit&preload={{
       [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit&preload={{
         #ifeq: {{SUBJECTSPACE}} | {{ns:File}}
         #if: {{{preload|}}}
        | Template:Documentation/preload-filespace
        | {{urlencode:{{{preload}}}}}
        | Template:Documentation/preload
        | {{#ifeq: {{SUBJECTSPACE}} | {{ns:File}}
        }} }} create]]
          | Template:Documentation/preload-filespace
          | Template:Documentation/preload
          }} }} }} create]]
     }}</span>
     }}</span>
   }} <span style="{{#if: {{{heading-style|}}}
   }} <span style="{{#if: {{{heading-style|}}}
Line 73: Line 75:
     | {{#if: {{{doc exist|yes}}}
     | {{#if: {{{doc exist|yes}}}
       | <!--/doc exists, link to it-->
       | <!--/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>
         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:
         Add links to /sandbox and /testcases when appropriate:
Line 81: Line 83:
         Editors can experiment in this template's {{
         Editors can experiment in this template's {{
         #ifexist: {{{sandbox| {{FULLPAGENAME}}/sandbox }}}
         #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| {{FULLPAGENAME}}/sandbox }}}|sandbox]] <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit }} edit] <nowiki>|</nowiki> [{{fullurl:Special:ComparePages | page1={{urlencode:{{{template page|{{FULLPAGENAME}}}}}}}&page2={{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>  
         | sandbox <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit&preload=Template:Documentation/preload-sandbox }} create] <nowiki>|</nowiki> [{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit&preload={{urlencode:{{{template page|{{FULLPAGENAME}}}}}}}&summary={{urlencode:Create sandbox version of [[{{{template page|{{FULLPAGENAME}}}}}]]}} }} mirror])</small>  
         }} and {{
         }} and {{
         #ifexist: {{{testcases| {{FULLPAGENAME}}/testcases }}}
         #ifexist: {{{testcases| {{FULLPAGENAME}}/testcases }}}
         | [[{{{testcases| {{FULLPAGENAME}}/testcases }}}|testcases]] <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLPAGENAME}}/testcases }}} | action=edit }} edit])</small>
         | [[{{{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>
         | testcases <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLPAGENAME}}/testcases }}} | action=edit&preload=Template:Documentation/preload-testcases }} create])</small>
         }} pages. <br>
         }} pages. <br />
       }}<!--
       }}<!--
         Show the cats and interwiki text, but not  
         Show the cats and interwiki text, but not  
Line 103: Line 105:
       }}
       }}
     }}{{#ifexist:{{FULLPAGENAME}}/Print
     }}{{#ifexist:{{FULLPAGENAME}}/Print
     |</br>A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at [[/Print]]. If you make a change to this template, please update the print version as well.[[Category:Templates with print versions]]
     |<br />A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at [[/Print]]. If you make a change to this template, please update the print version as well.[[Category:Templates with print versions]]
     }}
     }}
   }}
   }}
Line 124: Line 126:
}}<noinclude>
}}<noinclude>


{{pp-template}}
<!-- Add categories and interwikis to the /doc subpage, not here! -->
<!-- Add categories and interwikis to the /doc subpage, not here! -->
</noinclude>
</noinclude>

Latest revision as of 15:29, 31 March 2013

[view] [edit] [history] [purge] File:Template-info.svg Template documentation

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

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

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

Technical details

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}}. pt:Predefinição:Documentation/core