Format:Documentation subpage/doc
Format:Distinguish This template displays a message that the current page is a documentation subpage.
Usage
[modificare sursă]Userbox documentation
[modificare sursă]To set this template to use "userbox" and "userbox page" rather than "format" and "format page" or "utilizator template" and "utilizator template page", use:
Text customization
[modificare sursă]The parameters Format:Para and Format:Para can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1:
Format:Hidden begin
{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}
Format:Mbox
Format:Hidden end
Format:Hidden begin
{{Documentation subpage |text2='''''text2 appears here'''''}}
Format:Mbox
Format:Hidden end
Format:Hidden begin
{{Documentation subpage |text1='''''text1 appears here'''''}}
Format:Mbox
Format:Hidden end
Other parameters
[modificare sursă]Format:Para will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)
Display
[modificare sursă]This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:
- On a /doc page, it displays a box explaining template documentation and links to the template page.
- On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains
Format:Template link) will automatically note that the documentation is transcluded from a subpage.
Functions
[modificare sursă]In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".