Nhwɛdo:Documentation/testcases
This is the template test cases page for the sandbox of Nhwɛdo:Documentation. to update the examples. If there are many examples of a complicated template, later ones may break due to limits in MediaWiki; see the HTML comment "NewPP limit report" in the rendered page. You can also use Special:ExpandTemplates to examine the results of template uses. You can test how this page looks in the different skins and parsers with these links: |
Documentation
sesa mu---- {{documentation}} ---- {{documentation|Template:Documentation/testcases/test1}} ---- {{documentation|Template:Documentation/testcases/test2}} ---- {{documentation|content=This is in line documentation.}} ---- {{documentation|Template:Documentation/testcases/nodoc|content=Documentation.}} ---- {{documentation|Template:Documentation/testcases/test1|content=Documentation.}} ----
Default Documentation
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Script error: No such module "Distinguish".
The For detailed instructions on how and when to use this template, see Wikipedia:Template documentation (shortcut: WP:TDOC). This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the Use of this template allows templates to be protected, where necessary, while allowing anyone to edit the documentation and categories. General syntaxsesa muNormally, the template is used without parameters and is placed inside <!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude>
Transcluding a different pagesesa muTo transclude a different page other than the /doc subpage, simply provide <!--Last line of your template code--><noinclude>
{{Documentation|Template:Other page/doc}}
</noinclude>
Note that when loading the documentation from a page other than the local /doc subpage, it becomes tricky to handle the categories. Using the
sesa mu
|
Namespace | Behavior |
---|---|
Template | Full behavior |
Module | Full behavior, with the addition of a "create documentation" link when the page does not exist |
User | Full behavior |
Other namespaces | Hidden, unless |1= is specified (which will show "The above documentation is transcluded from {{{1}}} ")
|
Alongside that, if |1=
or |content=
is specified, the "Add categories to the /doc subpage" will not show.
Subject namespaces vs. talk namespaces
sesa muThis template is usually placed in the subject namespace. But in some cases this template needs to be on the Talk namespace:
- In the MediaWiki namespace, since
<noinclude>
often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.
When placed on talk pages, this template usually is placed near the top of the page and without <noinclude>...</noinclude>
tags.
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki subpage feature enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.
This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.
Full syntax
sesa mu{{Documentation}}
or
{{Documentation
| [path to documentation page]
}}
{{Documentation
| content =
}}
or
{{Documentation
| [path to documentation page]
| heading-style =
| heading =
| link box =
}}
or
{{Documentation
| [path to documentation page]
| content =
| heading-style =
| heading =
| link box =
| page =
}}
Color scheme
sesa muRGB | HSV | Color | General usage | Note | |
---|---|---|---|---|---|
A | #ECFCF4 | 150°, 6%, 99% | Sample | Current documentation background | |
B | #00FF80 | Hue=150° (41.7%; 106/255dec) 100%, 100% | Basic hue | What we'd call the color | |
1 | #A3BFB1 | 150°, 15%, 75% | Header border only | ||
2 | #CEF2E0 | 150°, 15%, 95% | Main border; header background | ||
3 | #E6FFF2 | 150°, 10%, 100% | 2nd header, accent colour | ||
4 | #F5FFFA | 150°, 4%, 100% | Main background | So saturation in A is a bit off |
Colors for documentation navbox
|
---|
As a suggestion, here are colors for a navbox intended for documentation pages only. They follow the shading of regular blue navbox colors: | titlestyle = background:#ccffe5
| basestyle = background:#ddffee
<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->
For subgroups, in child navboxes: {{Navbox|child
| groupstyle = background:#e6fff2
...
Example: |
See also
sesa mu- {{Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
- {{Barnstar documentation}}, a variant of {{Documentation}} for use with barnstar templates.
- Wikipedia:Template documentation is a how-to guide to template documentation.
- Wikipedia:Template sandbox and test cases explains the use of /sandbox and /testcases subpages and includes more information about template testing.
This is in line documentation.
Documentation/sandbox
sesa mu---- {{documentation/sandbox}} ---- {{documentation/sandbox|Template:Documentation/testcases/test1}} ---- {{documentation/sandbox|Template:Documentation/testcases/test2}} ---- {{documentation/sandbox|content=This is in line documentation.}} ---- {{documentation/sandbox|Template:Documentation/testcases/nodoc|content=Documentation.}} ---- {{documentation/sandbox|Template:Documentation/testcases/test1|content=Documentation.}} ----
Default Documentation
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Script error: No such module "Distinguish".
The For detailed instructions on how and when to use this template, see Wikipedia:Template documentation (shortcut: WP:TDOC). This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the Use of this template allows templates to be protected, where necessary, while allowing anyone to edit the documentation and categories. General syntaxsesa muNormally, the template is used without parameters and is placed inside <!--Last line of your template code--><noinclude>
{{Documentation}}
<!-- Add categories to the /doc subpage -->
</noinclude>
Transcluding a different pagesesa muTo transclude a different page other than the /doc subpage, simply provide <!--Last line of your template code--><noinclude>
{{Documentation|Template:Other page/doc}}
</noinclude>
Note that when loading the documentation from a page other than the local /doc subpage, it becomes tricky to handle the categories. Using the
sesa mu
|
Namespace | Behavior |
---|---|
Template | Full behavior |
Module | Full behavior, with the addition of a "create documentation" link when the page does not exist |
User | Full behavior |
Other namespaces | Hidden, unless |1= is specified (which will show "The above documentation is transcluded from {{{1}}} ")
|
Alongside that, if |1=
or |content=
is specified, the "Add categories to the /doc subpage" will not show.
Subject namespaces vs. talk namespaces
sesa muThis template is usually placed in the subject namespace. But in some cases this template needs to be on the Talk namespace:
- In the MediaWiki namespace, since
<noinclude>
often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.
When placed on talk pages, this template usually is placed near the top of the page and without <noinclude>...</noinclude>
tags.
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki subpage feature enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.
This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.
Full syntax
sesa mu{{Documentation}}
or
{{Documentation
| [path to documentation page]
}}
{{Documentation
| content =
}}
or
{{Documentation
| [path to documentation page]
| heading-style =
| heading =
| link box =
}}
or
{{Documentation
| [path to documentation page]
| content =
| heading-style =
| heading =
| link box =
| page =
}}
Color scheme
sesa muRGB | HSV | Color | General usage | Note | |
---|---|---|---|---|---|
A | #ECFCF4 | 150°, 6%, 99% | Sample | Current documentation background | |
B | #00FF80 | Hue=150° (41.7%; 106/255dec) 100%, 100% | Basic hue | What we'd call the color | |
1 | #A3BFB1 | 150°, 15%, 75% | Header border only | ||
2 | #CEF2E0 | 150°, 15%, 95% | Main border; header background | ||
3 | #E6FFF2 | 150°, 10%, 100% | 2nd header, accent colour | ||
4 | #F5FFFA | 150°, 4%, 100% | Main background | So saturation in A is a bit off |
Colors for documentation navbox
|
---|
As a suggestion, here are colors for a navbox intended for documentation pages only. They follow the shading of regular blue navbox colors: | titlestyle = background:#ccffe5
| basestyle = background:#ddffee
<!-- basestyle= sets groupstyle, abovestyle, belowstyle together -->
For subgroups, in child navboxes: {{Navbox|child
| groupstyle = background:#e6fff2
...
Example: |
See also
sesa mu- {{Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
- {{Barnstar documentation}}, a variant of {{Documentation}} for use with barnstar templates.
- Wikipedia:Template documentation is a how-to guide to template documentation.
- Wikipedia:Template sandbox and test cases explains the use of /sandbox and /testcases subpages and includes more information about template testing.
This is in line documentation.
Notest
sesa muFor {{File mover granted}}:
Live documentation
sesa mu{{documentation|page=Template:File mover granted|notest=y}}
This template should always be substituted (i.e., use Nhwɛdo:Tlsp). |
Sandbox documentation
sesa mu{{documentation/sandbox|page=Template:File mover granted|notest=y}}
This template should always be substituted (i.e., use Nhwɛdo:Tlsp). |