Difference between revisions of "Template:Documentation"

From BTAWiki
Jump to navigation Jump to search
meta>Verdy p
m (some doc pages need a few parameters (e.g. for feeding categories in their includeonly section, or for the actual template name to document))
Line 1: Line 1:
<includeonly><!--
+
{{documentation/core2
  Automatically add {{template sandbox notice}} when on a /sandbox page.
+
| heading = {{{heading|¬}}}<!--defined and empty means no header-->
-->{{#ifeq: {{SUBPAGENAME}} | sandbox |
 
<div style="clear:both" />
 
{{Template sandbox notice|{{{livepage|}}}}}
 
}}<!--
 
  Start of green doc box.
 
-->{{Documentation/start box2
 
| preload = {{{preload|}}}<!-- Allow custom preloads -->
 
| heading = {{{heading|¬}}}<!-- Empty but defined means no header -->
 
 
| heading-style = {{{heading-style|}}}
 
| heading-style = {{{heading-style|}}}
 +
| link box = {{{link box|}}} <!--So "link box=off" works-->
 +
| template page =
 +
  <!--The namespace is added in /core2-->
 +
  {{#switch: {{SUBPAGENAME}}
 +
  | sandbox
 +
  | testcases = {{BASEPAGENAME}}
 +
  | #default = {{PAGENAME}}
 +
  }}
 +
| docspace =
 +
  <!--Some namespaces must have the /doc, /sandbox and /testcases in talk space-->
 +
  {{#switch: {{SUBJECTSPACE}}
 +
  | {{ns:0}}
 +
  | {{ns:File}}
 +
  | {{ns:MediaWiki}}
 +
  | {{ns:Category}} = {{TALKSPACE}}
 +
  | #default = {{SUBJECTSPACE}}
 +
  }}
 
| content = {{{content|}}}
 
| content = {{{content|}}}
| docspace = {{documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
+
| 1 = {{{1|}}} <!--Other docname, if fed-->
| 1 = {{{1|}}}<!-- Other docname, if fed -->
+
| {{#if: {{{2|}}} | 2 | <!--dummy--> }} = {{{2|}}} <!--Other parameters for doc page, if fed-->
| lang = {{{lang|}}}
+
| {{#if: {{{3|}}} | 3 | <!--dummy--> }} = {{{3|}}} <!--Other parameters for doc page, if fed-->
| template page = {{documentation/template page}}<!-- The namespace is added in /start box2 -->
+
| {{#if: {{{4|}}} | 4 | <!--dummy--> }} = {{{4|}}} <!--Other parameters for doc page, if fed-->
}}<!--
+
}}<noinclude>
  Start load the /doc content:
+
<!-- Add categories and interwikis to the /doc subpage, not here! ??? -->
  Note: The line break between this comment and the next line is necessary
 
  so an  "=== Heading ===" at start of doc subpage is correctly interpreted.
 
-->
 
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{Documentation/docspace}}:{{Documentation/template page}}/doc|1|0}}
 
| 0000 | 0100 | 0010 | 0101 = <!-- currently no content to transclude -->
 
| 0001 | 0011 = {{ {{Documentation/docspace}}:{{Documentation/template page}}/doc }}
 
| 0110 | 0111 = {{ {{{1|}}} }}
 
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 = {{{content|}}}
 
}}<!--
 
  End load the /doc content:
 
  Note: The line break between this comment and the next line is necessary
 
  so an "=== Heading ===" at end of doc subpage is correctly interpreted.
 
-->
 
{{Documentation/end box2
 
| preload = {{{preload|}}}<!-- Allow custom preloads -->
 
| content = {{{content|}}}
 
| link box = {{{link box|}}}<!-- So "link box=off" works -->
 
| docspace = {{Documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
 
| 1 = {{{1|}}}<!-- Other docname, if fed -->
 
| lang = {{{lang|}}}
 
| template page = {{Documentation/template page}}<!-- The namespace is added in /end box2 -->
 
}}<!--
 
  End of green doc box
 
--></includeonly><noinclude>
 
{{Documentation}}
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
 
</noinclude>
 
</noinclude>

Revision as of 03:59, 23 January 2014