Difference between revisions of "Template:Documentation/core/sandbox"

From blackwiki
Jump to navigation Jump to search
test>Thesevenseas
(Added Code)
m (17 revisions imported)
 
(9 intermediate revisions by 9 users not shown)
Line 10: Line 10:
 
   | <!--Add the [edit][purge] or [create] links-->
 
   | <!--Add the [edit][purge] or [create] links-->
 
     <span class="editsection plainlinks" id="doc_editlinks">{{
 
     <span class="editsection plainlinks" id="doc_editlinks">{{
     #if: {{{doc exist|}}}
+
     #if: {{{doc exist|yes}}}
 
     | [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [{{purge|purge}}]  
 
     | [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [{{purge|purge}}]  
 
     | <!--/doc doesn't exist-->
 
     | <!--/doc doesn't exist-->
Line 47: Line 47:
 
{{#if: {{{content|}}}
 
{{#if: {{{content|}}}
 
| {{{content|}}}
 
| {{{content|}}}
| {{#if: {{{doc exist|}}}
+
| {{#if: {{{doc exist|yes}}}
 
   | {{ {{{docpage|{{FULLPAGENAME}}/doc}}} }}
 
   | {{ {{{docpage|{{FULLPAGENAME}}/doc}}} }}
 
   }}
 
   }}
Line 58: Line 58:
 
   {{#ifeq: {{{link box|}}} | off
 
   {{#ifeq: {{{link box|}}} | off
 
   |
 
   |
   | {{{doc exist|}}}{{
+
   | {{{doc exist|yes}}}{{
 
     #switch: {{SUBJECTSPACE}}
 
     #switch: {{SUBJECTSPACE}}
 
     | {{ns:User}}
 
     | {{ns:User}}
Line 73: Line 73:
 
     {{#if: {{{link box|}}}
 
     {{#if: {{{link box|}}}
 
     | {{{link box}}}  <!--Use custom link box content-->
 
     | {{{link box}}}  <!--Use custom link box content-->
     | {{#if: {{{content|}}}
+
     | {{#if: {{{doc exist|yes}}}
      |    <!--Don't link to doc subpage if content parameter is set-->
+
      | <!--/doc exists, link to it-->
      | {{#if: {{{doc exist|}}}
+
        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>
        | <!--/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:
 
         Add links to /sandbox and /testcases when appropriate:
Line 85: Line 82:
 
       | {{ns:Template}} =  
 
       | {{ns:Template}} =  
 
         Editors can experiment in this template's {{
 
         Editors can experiment in this template's {{
         #ifexist: {{{sandbox| {{FULLBASEPAGENAME}}/sandbox }}} <!-- Don't display link if we're in the sandbox page. -->
+
         #ifexist: {{{sandbox| {{FULLPAGENAME}}/sandbox }}}
         | {{#ifeq: {{SUBPAGENAME}} | sandbox | sandbox | [[{{{sandbox| {{FULLBASEPAGENAME}}/sandbox }}}|sandbox]] }} <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLBASEPAGENAME}}/sandbox }}} | action=edit }} edit] {{!}} [{{fullurl:Wikipedia:pagediff | withJS={{urlencode:MediaWiki:Common.js/pagediff.js}}&oldpage={{urlencode:{{{template page|{{FULLBASEPAGENAME}}}}}}}&newpage={{urlencode:{{{sandbox|{{FULLBASEPAGENAME}}/sandbox}}}}}}} diff])</small>  
+
         | [[{{{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| {{FULLBASEPAGENAME}}/sandbox }}} | action=edit&preload=Template:Documentation/preload-sandbox }} create])</small>  
+
         | sandbox <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit&preload={{{template page|{{FULLPAGENAME}}}}} }} create])</small>  
 
         }} and {{
 
         }} and {{
         #ifexist: {{{testcases| {{FULLROOTPAGENAME}}/testcases }}} <!-- Don't display link if we're in the testcases page. -->
+
         #ifexist: {{{testcases| {{FULLPAGENAME}}/testcases }}}
         | {{#ifeq: {{SUBPAGENAME}} | testcases | testcases | [[{{{testcases| {{FULLROOTPAGENAME}}/testcases }}}|testcases]] }} <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLROOTPAGENAME}}/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| {{FULLROOTPAGENAME}}/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 108: 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 118: Line 115:
 
   <!--Check if {{documentation}} is transcluded  
 
   <!--Check if {{documentation}} is transcluded  
 
       on a /doc or /testcases page-->
 
       on a /doc or /testcases page-->
   {{#switch: {{FULLPAGENAME}}
+
   {{#switch: {{SUBPAGENAME}}
   | Template:Documentation/testcases <!--except the documentation testcases page-->
+
   | doc
   | Template:Documentation subpage/testcases <!--and the documentation subpage testcases page-->
+
   | testcases = strange
  | Template:Single notice/testcases <!--and the single notice testcases page-->
 
  | {{#switch: {{SUBPAGENAME}}
 
    | doc
 
    | testcases = strange
 
    }}
 
 
   }}
 
   }}
 
   <!--More checks can be added here, just return anything
 
   <!--More checks can be added here, just return anything
Line 133: Line 125:
  
 
}}<noinclude>
 
}}<noinclude>
 
+
<!-- Add categories to the /doc subpage and interwikis to Wikidata, not here! -->
{{template sandbox notice}}
+
</noinclude>
 +
<noinclude>
 +
{{Documentation}}
 
</noinclude>
 
</noinclude>

Latest revision as of 10:23, 7 September 2020

[edit] [Script error: No such module "Purge".] Template documentation

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

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

{{documentation}} calls {{documentation/core2}} which in turn calls this template. This template holds most of the code for {{documentation}}, while {{documentation}} and {{documentation/core2}} 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}}.


Template documentation[view] [edit] [history] [purge]

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

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

{{documentation}} calls {{documentation/core2}} which in turn calls this template. This template holds most of the code for {{documentation}}, while {{documentation}} and {{documentation/core2}} 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}}.