Template:Documentation/core: Difference between revisions
From Halachipedia
(Blanked the page) |
No edit summary |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<!-- | |||
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|¬}}} | <!--Defined but empty--> | |||
| <!--"heading=", do nothing--> | |||
| <div style="padding-bottom: 3px; border-bottom: 1px solid #aaa; margin-bottom: 1ex;">{{ | |||
#if: {{{content|}}} | |||
| | |||
| <!--Add the [edit][purge] or [create] links--> | |||
<span class="editsection plainlinks" id="doc_editlinks">{{ | |||
#if: {{{doc exist|yes}}} | |||
| [[[{{{docpage|{{FULLPAGENAME}}/doc}}}|view]]] [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]] [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=history}} history]] [{{purge|purge}}] | |||
| <!--/doc doesn't exist--> | |||
[[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit&preload={{ | |||
#if: {{{preload|}}} | |||
| {{urlencode:{{{preload}}}}} | |||
| {{#ifeq: {{SUBJECTSPACE}} | {{ns:File}} | |||
| Template:Documentation/preload-filespace | |||
| Template:Documentation/preload | |||
}} }} }} create]] | |||
}}</span> | |||
}} <span style="{{#if: {{{heading-style|}}} | |||
| {{{heading-style|}}} | |||
| {{#ifeq: {{SUBJECTSPACE}} | {{ns:Template}} | |||
| font-weight: bold; font-size: 125% | |||
| font-size: 150% | |||
}} | |||
}}">{{#switch: {{{heading|¬}}} | |||
| ¬ = | |||
<!--"heading" not defined in this or previous level--> | |||
{{#switch: {{SUBJECTSPACE}} | |||
| {{ns:Template}} = [[Image:Template-info.svg|50px|alt=]] Template documentation | |||
| {{ns:File}} = Summary | |||
| #default = Documentation | |||
}} | |||
| #default = | |||
<!--"heading" has data or is empty but defined--> | |||
{{{heading|}}} | |||
}}</span></div> | |||
}}<!-- | |||
Load the /doc content: | |||
Note: The line breaks between this comment and the if-case | |||
and between the if-case and the following div are necessary so | |||
"=== Headings ===" at the start and end of docs are interpreted. | |||
--> | |||
{{#if: {{{content|}}} | |||
| {{{content|}}} | |||
| {{#if: {{{doc exist|yes}}} | |||
| {{ {{{docpage|{{FULLPAGENAME}}/doc}}} }} | |||
}} | |||
}} | |||
<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--><!-- | |||
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] | [{{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] <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] <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 {{ | |||
#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]]. | |||
}} | |||
}}{{#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]] | |||
}} | |||
}} | |||
}}<!--End link box--><!-- | |||
Detect and report strange usage: | |||
-->{{#if: | |||
<!--Check if {{documentation}} is transcluded | |||
on a /doc or /testcases page--> | |||
{{#switch: {{SUBPAGENAME}} | |||
| doc | |||
| testcases = strange | |||
}} | |||
<!--More checks can be added here, just return anything | |||
to make the surrounding if-case trigger--> | |||
| <includeonly>[[Category:Wikipedia pages with strange ((documentation)) usage|{{main other|Main:}}{{FULLPAGENAME}}]]<!-- Sort on namespace --></includeonly> | |||
}}<noinclude> | |||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | |||
</noinclude> |
Revision as of 18:11, 1 March 2013
[view] [edit] [history] [ ] 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
The above documentation is transcluded from Template:Documentation/core/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |