Template:Documentation/core: Difference between revisions

From Donate
Jump to navigation Jump to search
Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
imported>Davidgothberg
If "content" fed, don't link the /doc page. (Good thing I do detailed testing.)
No edit summary
 
(41 intermediate revisions by 20 users not shown)
Line 1: Line 1:
<!--
<!--
Start of green doc box
Start of green doc box
--><div class="template-documentation"><!--
--><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-->
-->{{#ifeq: {{{heading|¬}}} | <!--Defined but empty-->
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}}]
| [[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}|action=edit}} {{lcfirst:{{int:edit}}}}]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} {{int:code-rev-purge-link}}]]
| <!--/doc doesn't exist-->
| <!--/doc doesn't exist-->
[[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit&preload=Template:Documentation/preload}} create]]
[[{{fullurl:{{{docpage|{{FULLPAGENAME}}/doc}}}| action=edit&preload={{
⚫
#ifeq: {{SUBJECTSPACE}} | {{ns:File}}
| Template:Documentation/preload-filespace
| Template:Documentation/preload
⚫
}} }} create]]
}}</span>
}}</span>
}} <span style="{{#if: {{{heading-style|}}}
}} <span style="{{#if: {{{heading-style|}}}
| {{{heading-style|}}}
| {{{heading-style|}}}
| {{#ifeq: {{NAMESPACE}} | {{ns:Template}}
| {{#ifeq: {{SUBJECTSPACE}} | {{ns:Template}}
| font-weight: bold; font-size: 125%
| font-weight: bold; font-size: 125%
| font-size: 150%
| font-size: 150%
Line 24: Line 28:
| ¬ =
| ¬ =
<!--"heading" not defined in this or previous level-->
<!--"heading" not defined in this or previous level-->
{{#ifeq: {{NAMESPACE}} | {{ns:template}}
{{#switch: {{SUBJECTSPACE}}
| [[Image:Template-info.svg|50px]] Template documentation
| {{ns:Template}} = [[Image:Template-info.svg|50px|alt=]] Template documentation
| Documentation
| {{ns:File}} = Summary
| #default = Documentation
}}
}}
| #default =
| #default =
Line 34: Line 39:
}}<!--
}}<!--
Load the /doc content:
Load the /doc content:
Note: The line breaks between this comment and the if-case
⚫
-->{{#if: {{{content|}}}
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|}}}
| {{{content|}}}
| {{#if: {{{doc exist|yes}}}
| {{#if: {{{doc exist|yes}}}
Line 40: Line 49:
}}
}}
}}
}}
<div style="clear: both;"></div>
<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--><!--
Small box below for the doc meta-data.
Link box below for the doc meta-data:
-->{{#if:
-->{{#if:
<!--Check if we need the small box-->
<!--Check if we should show the link box-->
{{#if: {{{content|}}}
{{#ifeq: {{{link box|}}} | off
|
| <!--Don't link the /doc page-->
| {{{doc exist|yes}}}
| {{{doc exist|yes}}}{{
}}{{#switch: {{SUBJECTSPACE}}
#switch: {{SUBJECTSPACE}}
| {{ns:User}}
| {{ns:User}}
| {{ns:Template}} = yes
| {{ns:Template}} = yes
⚫
}}
}}
}}


| {{fmbox
| {{fmbox
| id = documentation-meta-data
| image = none
| image = none
| style = background-color: #ecfcf4;
| style = background-color: #ecfcf4; width: 100%;
| textstyle = font-style: italic;
| text =
| text =
''{{#if: {{{content|}}}
{{#if: {{{link box|}}}
| <!--Don't link the /doc page-->
| {{{link box}}} <!--Use custom link box content-->
| {{#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 [[w:Wikipedia:Template documentation|documentation]] is [[w: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:
-->{{#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}} = &#32;[[Special:PrefixIndex/{{{template page|{{FULLPAGENAME}}}}}/|Subpages of this template]].
| #default = &#32;[[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]]
⚫
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.
⚫
}}''
}}
}}
}}<!--End link box--><!--
⚫
}}<noinclude>


Detect and report strange usage:
<!-- {{pp-template}} -->
-->{{#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>
[[Category:Utility templates]]
<!-- 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 14:50, 16 May 2018

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.
Retrieved from "https://donate.wikimedia.org/w/index.php?title=Template:Documentation/core&oldid=28851"