Sjabloon:Pgn
This template is new. It has passed all my tests, but I might do some modifications to it during the next few weeks. --David Göthberg (talk) 15:02, 4 December 2009 (UTC) |
This is the {{pgn}} or pagename meta-template.
It helps handling pagenames, especially when working with subpages.
The "page" parameter
The operations this template does is normally based on the pagename of the page it is used on. But any other pagename can be fed as the "page=" parameter. Note that there are two different page parameters. Like this:
{{pgn|page}}
= Pgn{{pgn|page|page=Help:A/B/C/D}}
= A/B/C/D
The double usage of page might seem confusing, but it is convenient when using this template together with other templates such as {{basepage subpage}} and {{namespace detect}} that also understand the "page=" parameter.
Magic words
Some of the functions in this template are mostly here for completeness. When there is an exactly equivalent magic word that works in all namespaces, then it is also listed in these examples. We recommend you use the magic word if there is one, since that is more efficient. It is when working with subpages that this template excels.
Namespace and pagename
This template can return the current namespace, subject space and talk space. Like this:
{{pgn|ns}} = {{NAMESPACE}} {{pgn|ss}} = {{SUBJECTSPACE}} {{pgn|ts}} = {{TALKSPACE}} {{pgn|ts| page=Help:A/B/C/D }} = {{TALKSPACE: Help:A/B/C/D }}
- Sjabloon
- Sjabloon
- Overleg sjabloon
- Overleg help
This template can return the pagename, and it can combine the pagename with the namespace, subject space or talk space. Like this:
{{pgn|page}} = {{PAGENAME}} {{pgn|fullpage}} = {{FULLPAGENAME}} {{pgn|ns|page}} = {{FULLPAGENAME}} {{pgn|ss|page}} = {{SUBJECTPAGENAME}} {{pgn|ts|page}} = {{TALKPAGENAME}} {{pgn|ts|page| page=Help:A/B/C/D }} = {{TALKPAGENAME: Help:A/B/C/D }}
- Pgn
- Sjabloon:Pgn
- Sjabloon:Pgn
- Sjabloon:Pgn
- Overleg sjabloon:Pgn
- Overleg help:A/B/C/D
This template correctly removes the colon ":" for the main (article) space. It also converts namespace aliases such as "Image" to "File". Like this:
{{pgn|ss|page| page=Talk:An article }} = {{SUBJECTPAGENAME: Talk:An article }} {{pgn|ns|page| page=Image:An image }} = {{FULLPAGENAME: Image:An image }} {{pgn|ns|page| page=WP:Village pump }} = {{FULLPAGENAME: WP:Village pump }}
- An article
- Bestand:An image
- WP:Village pump
Subpages
The following examples are about subpages. To see them correctly view this documentation at Template:Pgn/doc instead.
This template can return the basepagename of the current page, and it can combine the basepagename with the namespace, subject space or talk space. Like this:
{{pgn|basepage}} {{pgn|fullbasepage}} {{pgn|ns|basepage}} {{pgn|ss|basepage}} {{pgn|ts|basepage}} {{pgn|ns|basepage| page=Help:A/B/C/D }}
- Pgn
- Sjabloon:Pgn
- Sjabloon:Pgn
- Sjabloon:Pgn
- Overleg sjabloon:Pgn
- Help:A/B/C
This template can return the subpagename. Like this:
{{pgn|subpage}} {{pgn|subpage| page=Help:A/B/C/D }}
- Pgn
- D
This template can return the rootpage. Like this:
{{pgn|rootpage}} {{pgn|ns|rootpage}} {{pgn|fullrootpage}} {{pgn|fullrootpage| page=Help:A/B/C/D }}
- Pgn
- Sjabloon:Pgn
- Sjabloon:Pgn
- Help:A
Relative paths
This template can handle relative paths. And it can take the name of a subpage to add to the path. Like this:
{{pgn|..}} {{pgn|ns|..}} {{pgn|ns|..| sibling }} {{pgn|ns|..| page=Help:A/B/C/D }} {{pgn|ns|..| sibling | page=Help:A/B/C/D }}
- Pgn
- Sjabloon:Pgn
- Sjabloon:Pgn/sibling
- Help:A/B/C
- Help:A/B/C/sibling
This template can handle relative paths up to two levels deep:
{{pgn|ns|..|..}} {{pgn|ns|..|..| uncle }} {{pgn|ns|..|..| page=Help:A/B/C/D }} {{pgn|ns|..|..| uncle | page=Help:A/B/C/D }}
- Sjabloon:Pgn
- Sjabloon:Pgn/uncle
- Help:A/B
- Help:A/B/uncle
Subpage levels
This template can split up and handle each level in a pagename, in up to four subpage levels. (The "+ +" used in this example is to show when this template returns an empty string.) Like this:
{{pgn|page1| page=Help:A/B/C/D }} {{pgn|page2| page=Help:A/B/C/D }} {{pgn|page3| page=Help:A/B/C/D }} {{pgn|page4| page=Help:A/B/C/D }} +{{pgn|page4| page=Help:A/B }}+
- A
- B
- C
- D
- ++
And it can put the parts together in pretty much any way you want. Like this:
{{pgn|ns|page1|page2| page=Help:A/B/C/D }} {{pgn|page3|page4| page=Help:A/B/C/D }}
- Help:A/B
- C/D
Parameters
List of all parameters:
{{pgn| ns / ss / ts | page / basepage / rootpage | page = User:Example }} {{pgn| fullpage / fullbasepage / subpage / fullrootpage }} {{pgn| .. | .. }} {{pgn| page1 | page2 | page3 | page4 }}
Note that several of the parameters can be fed to more than one position.
Technical details
This template detects subpages even when used in namespaces that don't have the MediaWiki subpage feature enabled. Thus this template works the same in all namespaces.
This template calls {{pgn/core}} which holds most of the code for {{pgn}}, while {{pgn}} itself does parameter preprocessing.
See also
This is the {{pagename detect see also}} template.
It is used in the "See also" section of the documentation of the pagename-detection templates. It takes no parameters.
If you update this template, then you should probably also update {{namespace detect see also}}. That template holds almost the same list of templates, but with the namespace-detection templates at the top.
The above documentation is transcluded from Sjabloon:Pgn/doc. (edit | history) Editors can experiment in this template's sandbox (create) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |