Bryan: 1 revision

2013-09-03T22:34:12Z

1 revision

New page

{{documentation subpage}}
{{high-risk| 410,000+ }}


This is the {{tl|basepage subpage}} meta-template.

This template helps other templates detect if they are on a '''basepage''', '''subpage''' or '''subsubpage'''. However, a subpage can be detected without using another template, by instead using a single <code>#ifeq</code> with parser function <code>#titleparts</code> (see below: [[#Alternatives for simpler text|Alternatives for simpler text]]).

=== Usage ===

This template takes one or more parameters, like this:
<pre>
{{basepage subpage
| Basepage text
| Subpage text
}}
</pre>

If the template is on the page "User:Example", it shall return this:

:{{basepage subpage
| Basepage text
| Subpage text
| page = User:Example
}}

If the template is on "User:Example/test" or "User:Example/test/test" or any page lower than that, it will return this:

:{{basepage subpage
| Basepage text
| Subpage text
| page = User:Example/test/test
}}

This template can also detect "subsubpages", like this:

<pre>
{{basepage subpage
| Basepage text
| Subpage text
| Subsubpage text
}}
</pre>

If the template is on "User:Example/test/test" or any page lower than that, it will return this:

:{{basepage subpage
| Basepage text
| Subpage text
| Subsubpage text
| page = User:Example/test/test
}}

By using an empty parameter you can make it so the template doesn't render anything for some specific page type. Like this:

<pre>
{{basepage subpage
| Basepage text
| Subpage text
|
}}
</pre>

The code above will render nothing when on "User:Example/test/test" or lower, but will return this when on "User:Example/test":

:{{basepage subpage
| Basepage text
| Subpage text
|
| page = User:Example/test
}}

=== The "page" parameter ===

For testing and demonstration purposes this template can take a parameter named '''page'''. Like this:

<pre>
{{basepage subpage
| Basepage text
| Subpage text
| page = User:Example/test
}}
</pre>

No matter on what kind of page the code above is used it will return this:

:{{basepage subpage
| Basepage text
| Subpage text
| page = User:Example/test
}}

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:

<pre>
{{basepage subpage
| Basepage text
| Subpage text
| page = {{{page|}}}
}}
</pre>

=== 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:

<pre>
{{basepage subpage
| 1 = Basepage text
| 2 = Subpage text
| 3 = Subsubpage text
| page = {{{page|}}}
}}
</pre>

This template detects subpages even when used in namespaces that doesn't have the MediaWiki [[meta:Link#Subpage feature|subpage feature]] enabled. Thus this template works the same in all namespaces.

=== Alternatives for simpler text ===
A subpage can be detected without using another template, by instead using a single <code>#ifeq</code> along with the title-splitting parser function <code>#titleparts</code>, with expansion depth +1, as follows:
::: <nowiki>{{#ifeq: {{#titleparts:{{PAGENAME}}|1|1}} | {{PAGENAME}}</nowiki>
:::: <nowiki> | ...then on base page...</nowiki>
:::: <nowiki> | ...else on a subpage...</nowiki>
::: <nowiki>}}</nowiki>
For example, many templates can check if the page is a /sandbox version, by the similar markup with <code>#ifeq</code> and <code>#titleparts</code>:
::: <nowiki>{{#ifeq: {{#titleparts:{{PAGENAME}}|1|1}} | {{PAGENAME}}</nowiki>
:::: <nowiki> | {{documentation}}</nowiki>
:::: <nowiki> | {{template sandbox notice}}</nowiki>
::: <nowiki>}}</nowiki>
That simple logic works because [[Template:Template_sandbox_notice]] also checks the page name for "/sandbox" before displaying the sandbox notice; otherwise, any other subpage would show no extra text. By avoiding a template, and using a single <code>#ifeq</code>, then the processing uses only +2 expansion depth levels, rather than +7 levels, and avoids "[[wp:exceeded template limits]]" inside a complex /doc page.

=== See also ===

{{pagename detect see also}}

<includeonly>

[[Category:Wikipedia metatemplates]]

[[as:Template:Basepage subpage]]
[[bn:টেমপ্লেট:Basepage subpage]]
[[sl:Predloga:Osnovnastran podstran]]
</includeonly>

Template:Basepage subpage/doc - Revision history

Bryan: 1 revision