Difference between revisions of "Template:Documentation/core"

From Dolphin Emulator Wiki
Jump to: navigation, search
(Created page with '<!-- Start of green doc box --><div id="template-documentation" class="template-documentation iezoomfix"><!-- Add the heading at the top of the doc box: -->{{#ifeq: {{{headin…')
(removing nonexistent image)
Line 29: Line 29:
     <!--"heading" not defined in this or previous level-->
     <!--"heading" not defined in this or previous level-->
     {{#switch: {{SUBJECTSPACE}}  
     {{#switch: {{SUBJECTSPACE}}  
     | {{ns:Template}} = [[Image:Template-info.svg|50px|alt=]] Template documentation
     | {{ns:Template}} = Template documentation
     | {{ns:File}} = Summary
     | {{ns:File}} = Summary
     | #default = Documentation
     | #default = Documentation

Revision as of 20:07, 22 June 2010

[edit] [purge] Template documentation

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

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

{{documentation}} calls {{documentation/core2}} which in turn calls this template. This template holds most of the code for {{documentation}}, while {{documentation}} and {{documentation/core2}} do parameter preprocessing. Thus simplifying the code.

Technical details

This sub-template currently expects these parameters:

| 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}}.