Template:Basepage subpage/doc
This is a documentation subpage for Template:Basepage subpage It may contain usage information, categories and other content that is not part of the original template page. |
This is the {{basepage subpage}} meta-template.
This template helps other templates detect if they are on a basepage, subpage or subsubpage.
Usage
[edit source]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:
- Basepage 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:
- Subsubpage 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
The "page" parameter
[edit source]For testing and demonstration purposes this template can take a parameter named page. Like this:
{{basepage subpage | Basepage text | Subpage text | page = User:Example/test }}
No matter on what kind of page the code above is used it will return this:
- Subpage text
The page parameter makes this template behave exactly as if on that page. Thus, if a subsubpagename like "User:Example/test/test" is fed, then it returns the subsubpage text if there is one, otherwise it returns the subpage text.
The pagename doesn't have to be an existing page.
If the parameter is empty or undefined, the name of the current page determines the result.
You can make it so your template also understands the page 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 | page = {{{page|}}} }}
Technical details
[edit source]Templates have a problem handling 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 | page = {{{page|}}} }}
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
[edit source]Pagename-handling and detection templates:
- {{basepage subpage}} – For detecting if on a basepage, subpage, or subsubpage.
- {{if pagename}} – For pattern matching on the pagename.
- {{IP-user other}} – For detecting IP-user pages.
Easy to use namespace-detection templates:
- {{main other}} – For book page templates.
- {{talk other}} – For talk page templates.
- {{user other}} – For user page templates.
- {{wikibooks other}} – For project page templates.
- {{subject other}} - For subject page templates.
- {{file other}} – For file (image) templates.
- {{template other}} – For detecting template pages.
- {{help other}} – For help page templates.
- {{category other}} – For category templates.
- {{wikijunior other}} – For Wikijunior templates.
- {{cookbook other}} – For Cookbook templates.
More complex namespace-detection templates:
- {{namespace detect}} – The very versatile one.
- {{namespace detect showall}} – The extremely versatile one; has input reuse.
- {{talkspace detect}} - For detecting talk pages on various namespaces.
- {{main talk other}} – Separates some namespaces.