Template:Documentation/core: Difference between revisions
Jump to navigation
Jump to search
Created page with "<!-- Start of green doc box --><div id="template-documentation" class="template-documentation iezoomfix"><!-- Add the heading at the top of..." |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
<!-- | |||
Start of green doc box | Start of green doc box | ||
-- | --><div id="template-documentation" class="template-documentation iezoomfix"><!-- | ||
Add the heading at the top of the doc box: | 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|}}} | #if: {{{content|}}} | ||
| | | | ||
| | | <!--Add the [edit][purge] or [create] links--> | ||
<span class="editsection plainlinks" id="doc_editlinks">{{ | |||
#if: {{{doc exist|yes}}} | #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--> | ||
[[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit& | [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit&preload={{ | ||
#ifeq: {{SUBJECTSPACE}} | {{ns:File}} | #ifeq: {{SUBJECTSPACE}} | {{ns:File}} | ||
| Template:Documentation/preload-filespace | | Template:Documentation/preload-filespace | ||
| Template:Documentation/preload | | Template:Documentation/preload | ||
}} }} create]] | }} }} create]] | ||
}} | }}</span> | ||
}} | }} <span style="{{#if: {{{heading-style|}}} | ||
| {{{heading-style|}}} | | {{{heading-style|}}} | ||
| {{#ifeq: {{SUBJECTSPACE}} | {{ns:Template}} | | {{#ifeq: {{SUBJECTSPACE}} | {{ns:Template}} | ||
| Line 25: | Line 25: | ||
| font-size: 150% | | font-size: 150% | ||
}} | }} | ||
}} | }}">{{#switch: {{{heading|¬}}} | ||
| ¬ = | | ¬ = | ||
<!--"heading" not defined in this or previous level--> | |||
{{#switch: {{SUBJECTSPACE}} | {{#switch: {{SUBJECTSPACE}} | ||
| {{ns:Template}} = [[Image:Template-info.svg|50px|alt=]] Template documentation | | {{ns:Template}} = [[Image:Template-info.svg|50px|alt=]] Template documentation | ||
| Line 34: | Line 34: | ||
}} | }} | ||
| #default = | | #default = | ||
<!--"heading" has data or is empty but defined--> | |||
{{{heading|}}} | {{{heading|}}} | ||
}} | }}</span></div> | ||
}} | }}<!-- | ||
Load the /doc content: | Load the /doc content: | ||
Note: The line breaks between this comment and the if-case | Note: The line breaks between this comment and the if-case | ||
and between the if-case and the following div are necessary so | and between the if-case and the following div are necessary so | ||
"=== Headings ===" at the start and end of docs are interpreted. | |||
-- | --> | ||
{{#if: {{{content|}}} | {{#if: {{{content|}}} | ||
| {{{content|}}} | | {{{content|}}} | ||
| Line 49: | Line 49: | ||
}} | }} | ||
}} | }} | ||
<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: | Link box below for the doc meta-data: | ||
-- | -->{{#if: | ||
<!--Check if we should show the link box--> | |||
{{#ifeq: {{{link box|}}} | off | {{#ifeq: {{{link box|}}} | off | ||
| | | | ||
| Line 70: | Line 70: | ||
| text = | | text = | ||
{{#if: {{{link box|}}} | {{#if: {{{link box|}}} | ||
| {{{link box}}} | | {{{link box}}} <!--Use custom link box content--> | ||
| {{#if: {{{doc exist|yes}}} | | {{#if: {{{doc exist|yes}}} | ||
| | | <!--/doc exists, link to it--> | ||
The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{docpage|{{FULLPAGENAME}}/doc}}}]]. | 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: | Add links to /sandbox and /testcases when appropriate: | ||
-- | -->{{#switch: {{SUBJECTSPACE}} | ||
| {{ns:User}} | | {{ns:User}} | ||
| {{ns:Template}} = | | {{ns:Template}} = | ||
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]] | | [[{{{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 | | sandbox <small style="font-style: normal">([{{fullurl: {{{sandbox| {{FULLPAGENAME}}/sandbox }}} | action=edit&preload=Template:Documentation/preload-sandbox }} create])</small> | ||
}} and {{ | }} and {{ | ||
#ifexist: {{{testcases| {{FULLPAGENAME}}/testcases }}} | #ifexist: {{{testcases| {{FULLPAGENAME}}/testcases }}} | ||
| [[{{{testcases| {{FULLPAGENAME}}/testcases }}}|testcases]] | | [[{{{testcases| {{FULLPAGENAME}}/testcases }}}|testcases]] <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLPAGENAME}}/testcases }}} | action=edit }} edit])</small> | ||
| testcases | | testcases <small style="font-style: normal">([{{fullurl: {{{testcases| {{FULLPAGENAME}}/testcases }}} | action=edit&preload=Template:Documentation/preload-testcases }} create])</small> | ||
}} pages. | }} pages. <br> | ||
}} | }}<!-- | ||
Show the cats and interwiki text, but not | Show the cats and interwiki text, but not | ||
if | if "content" fed or "docname fed" since then it is | ||
unclear where to add the cats and interwikis. | unclear where to add the cats and interwikis. | ||
-- | -->{{#if: {{{content|}}} {{{docname fed|}}} | ||
| | | | ||
| Please add categories and interwikis to the [[{{{docpage|{{FULLPAGENAME}}/doc}}}|/doc]] subpage. | | Please add categories and interwikis to the [[{{{docpage|{{FULLPAGENAME}}/doc}}}|/doc]] subpage. | ||
}} | }}<!-- | ||
Show the | Show the "Subpages" link: | ||
-- | -->{{#switch: {{SUBJECTSPACE}} | ||
| {{ns:File}} = | | {{ns:File}} = <!--Don't show it--> | ||
| {{ns:Template}} = & | | {{ns:Template}} =  [[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this template]]. | ||
| #default = & | | #default =  [[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this page]]. | ||
}} | }} | ||
}}{{#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]] | ||
}} | }} | ||
}} | }} | ||
}} | }}<!--End link box--><!-- | ||
Detect and report strange usage: | Detect and report strange usage: | ||
-- | -->{{#if: | ||
<!--Check if {{documentation}} is transcluded | |||
on a /doc or /testcases page-- | on a /doc or /testcases page--> | ||
{{#switch: {{SUBPAGENAME}} | {{#switch: {{SUBPAGENAME}} | ||
| doc | | doc | ||
| testcases = strange | | testcases = strange | ||
}} | }} | ||
<!--More checks can be added here, just return anything | |||
to make the surrounding if-case trigger-- | to make the surrounding if-case trigger--> | ||
| | | <includeonly>[[Category:Wikipedia pages with strange ((documentation)) usage|{{main other|Main:}}{{FULLPAGENAME}}]]<!-- Sort on namespace --></includeonly> | ||
}} | }}<noinclude> | ||
{{pp-template}} | {{pp-template}} | ||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | |||
</noinclude> | |||
Latest revision as of 16:06, 10 October 2010
[edit] [] File:Template-info.svg Template documentation
| The above documentation is transcluded from Template:Documentation/core/doc. (edit | history) Editors can experiment in this template's sandbox (create) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |