- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
Difference between revisions of "Template:Documentation subpage/doc"
(init) |
(→Related pages: remove related links) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
== Usage == | == Usage == | ||
| − | + | <nowiki>{{Documentation subpage}}</nowiki> | |
| − | + | or | |
| − | + | <nowiki>{{Documentation subpage|[[Page where the documentation transcluded]]}}</nowiki> | |
| − | <br><br> | + | <br><br> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Text customization=== | ===Text customization=== | ||
| Line 41: | Line 35: | ||
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 [[m:Help:Categories#Sort order|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F". | 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 [[m:Help:Categories#Sort order|sort key]] to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F". | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<includeonly>{{Sandbox other||<!-- Make sure only the template page is categorised. No subpages, and not after transclusion. This /doc page is reused, btw. | <includeonly>{{Sandbox other||<!-- Make sure only the template page is categorised. No subpages, and not after transclusion. This /doc page is reused, btw. | ||
Latest revision as of 02:31, 26 January 2023
This template displays a message that the current page is a documentation subpage.
Usage[edit]
{{Documentation subpage}} or {{Documentation subpage|[[Page where the documentation transcluded]]}}
Text customization[edit]
The parameters |text1= and |text2= 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:
Template:Hidden begin
{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}
 |
This is a documentation subpage for [page] . It contains usage information, categories and other content that is not part of the original text2 appears here. |
Template:Hidden end
Template:Hidden begin
{{Documentation subpage |text2='''''text2 appears here'''''}}
|
|
This is a documentation subpage for [page] . It contains usage information, categories and other content that is not part of the original text2 appears here. |
Template:Hidden end
Template:Hidden begin
{{Documentation subpage |text1='''''text1 appears here'''''}}
|
|
This is a documentation subpage for [page] . It contains usage information, categories and other content that is not part of the original text1 appears here. |
Other parameters[edit]
|inhibit=yes 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[edit]
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
Template:Template link) will automatically note that the documentation is transcluded from a subpage.
Functions[edit]
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".