Difference between revisions of "Template:Documentation/core2/doc"

From blackwiki
Jump to navigation Jump to search
test>Dinoguy1000
(Redirected page to Template:Documentation/doc)
test>Redrose64
(Undid revision 845801440 by Dinoguy1000 (talk) absolutely no reason for this undiscussed change)
Line 1: Line 1:
#REDIRECT [[Template:Documentation/doc]]
+
{{Documentation subpage}}
 +
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 +
 
 +
This is the {{tl|documentation/core2}} sub-template.
 +
 
 +
Do not use this template directly, use {{tl|documentation}} instead.
 +
 
 +
{{tlf|documentation}} calls this template, which in turn calls {{tl|documentation/core}}. {{tlf|documentation/core}} holds most of the code for {{tlf|documentation}}, while {{tlf|documentation}} and this template do parameter preprocessing. Thus simplifying the code.
 +
 
 +
=== Technical details ===
 +
 
 +
This sub-template currently expects these parameters:
 +
 
 +
<pre>
 +
{{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-->
 +
 
 +
| docspace =    <!--The namespace for the /doc, /sandbox and
 +
    /testcases. Some namespaces must store them in talk space.-->
 +
 
 +
| 1 = {{{1|}}}  <!--Other docname, if fed-->
 +
 
 +
| template page =  <!--Pagename where the {{documentation}}
 +
    template is placed, but without ending /sandbox or /testcases,
 +
    and without namespace.-->
 +
}}
 +
</pre>
 +
 
 +
For more documentation see {{tl|documentation}}.
 +
 
 +
<includeonly>{{sandbox other||
 +
<!-- CATEGORIES HERE, THANKS -->
 +
[[Category:Template documentation]]
 +
}}</includeonly>

Revision as of 19:43, 14 June 2018

This is the {{documentation/core2}} sub-template.

Do not use this template directly, use {{documentation}} instead.

{{documentation}} calls this template, which in turn calls {{documentation/core}}. {{documentation/core}} holds most of the code for {{documentation}}, while {{documentation}} and this template 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-->

| docspace =    <!--The namespace for the /doc, /sandbox and 
    /testcases. Some namespaces must store them in talk space.-->

| 1 = {{{1|}}}   <!--Other docname, if fed-->

| template page =   <!--Pagename where the {{documentation}} 
    template is placed, but without ending /sandbox or /testcases,
    and without namespace.-->
}}

For more documentation see {{documentation}}.