Difference between revisions of "Template:Documentation/core"
Jump to navigation
Jump to search
test>MSGJ m (fix html comment) |
test>Davidgothberg (Indenting the code and updating some code comments. No change in functionality.) |
||
| 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: | -->{{#if: | ||
| − | <!--Check if we should show the | + | <!--Check if we should show the link box--> |
{{#ifeq: {{{link box|}}} | off | {{#ifeq: {{{link box|}}} | off | ||
| | | | ||
| Line 68: | Line 68: | ||
| style = background-color: #ecfcf4; | | style = background-color: #ecfcf4; | ||
| textstyle = font-style: italic; | | textstyle = font-style: italic; | ||
| − | | text = {{#if:{{{link box|}}} | + | | 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] | [{{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])</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}} =  [[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this template]]. | |
| + | | #default =  [[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this page]]. | ||
| + | }} | ||
}} | }} | ||
| − | |||
}} | }} | ||
| − | }}<!-- | + | }}<!--End link box--><!-- |
Detect and report strange usage: | Detect and report strange usage: | ||
Revision as of 03:38, 20 February 2010
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}}.
| The above documentation is transcluded from Template:Documentation/core/doc. (edit | history) Editors can experiment in this template's sandbox (edit) and testcases (edit) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |