Template:When on basepage/doc: Difference between revisions
meta>Davidgothberg Adding more "Technical details". |
meta>Davidgothberg Adding a caution that I might change the syntax for the demospace parameter. And adding some "See also" links. |
||
| Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
{{caution | |||
| This template is new. It is tested and works well. But I am thinking of changing how the '''demospace''' parameter works. However, the functionality of parameters 1-3 will not be changed. <br> --[[User:Davidgothberg|David Göthberg]] ([[User talk:Davidgothberg|talk]]) 01:18, 4 November 2009 (UTC) | |||
}} | |||
This is the {{tl|basepage subpage}} meta-template. | This is the {{tl|basepage subpage}} meta-template. | ||
| Line 108: | Line 112: | ||
=== Technical details === | === Technical details === | ||
Templates have a problem to handle parameter data that contains equal signs "<code>=</code>". But that is easily solved by using numbered parameters. Like this: | Templates have a problem to handle parameter data that contains equal signs "<code>=</code>". But that is easily solved by using numbered parameters. Like this: | ||
| Line 121: | Line 123: | ||
}} | }} | ||
</pre> | </pre> | ||
This template detects subpages even when used in namespaces that doesn't have the MediaWiki subpage feature enabled. Thus this template works the same in all namespaces. | |||
=== See also === | === See also === | ||
* [[mw:Help:Magic words]] – About <code><nowiki>{{PAGENAME}}</nowiki></code> etc. | |||
* [[meta:Link#Subpage feature]] – About the MediaWiki subpage feature. | |||
<includeonly> | <includeonly> | ||
Revision as of 01:18, 4 November 2009
 | This is a documentation subpage for Template:When on basepage. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is new. It is tested and works well. But I am thinking of changing how the demospace parameter works. However, the functionality of parameters 1-3 will not be changed. --David Göthberg (talk) 01:18, 4 November 2009 (UTC) |
This is the {{basepage subpage}} meta-template.
This template helps other templates detect if they are on a basepage, subpage or subsubpage.
Usage
This template takes one or more parameters, like this:
{{basepage subpage
| Basepage text
| Subpage text
}}
If the template is on the page "User:Example", it will return this:
- Subpage text
If the template is on "User:Example/test" or "User:Example/test/test" or any page lower than that, it will return this:
- Subpage text
This template can also detect "subsubpages", like this:
{{basepage subpage
| Basepage text
| Subpage text
| Subsubpage text
}}
If the template is on "User:Example/test/test" or any page lower than that, it will return this:
- Subpage text
By using an empty parameter you can make it so the template doesn't render anything for some specific page type. Like this:
{{basepage subpage
| Basepage text
| Subpage text
|
}}
The code above will render nothing when on "User:Example/test/test" or lower, but will return this when on "User:Example/test":
- Subpage text
Demospace
For testing and demonstration purposes this template can take a parameter named demospace.
- If it has the value basepage it returns the basepage text.
- It if has the value subpage it returns the subpage text.
- It if has the value subsubpage it returns the subsubpage text if there is one, otherwise it returns the subpage text.
- If the parameter is empty or undefined, the actual page type determines the result.
Like this:
{{basepage subpage
| Basepage text
| Subpage text
| demospace = subpage
}}
No matter on what kind of page the code above is used it will return this:
- Subpage text
You can make it so your template also understands the demospace parameter. That means you can demonstrate the different appearances of your template in the documentation for your template. Then do like this:
{{basepage subpage
| Basepage text
| Subpage text
| demospace = {{{demospace|}}}
}}
Technical details
Templates have a problem to handle parameter data that contains equal signs "=". But that is easily solved by using numbered parameters. Like this:
{{basepage subpage
| 1 = Basepage text
| 2 = Subpage text
| 3 = Subsubpage text
| demospace = {{{demospace|}}}
}}
This template detects subpages even when used in namespaces that doesn't have the MediaWiki subpage feature enabled. Thus this template works the same in all namespaces.
See also
- mw:Help:Magic words – About
{{PAGENAME}}etc. - meta:Link#Subpage feature – About the MediaWiki subpage feature.
