Template:Documentation subpage/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
Tag: Manual revert
mNo edit summary
 
(2 intermediate revisions by the same user not shown)
Line 28: Line 28:


=== Other parameters ===
=== Other parameters ===
{{para|inhibit|yes}} will prevent this template from generating any categories. (By default, "''Namespace'' documentation pages" (usually {{c|Template documentation pages}}) is added, or {{c|Documentation subpages without corresponding pages}} if the main page doesn't exist.)
{{para|inhibit|yes}} will prevent this template from generating any categories. (By default, "''Namespace'' documentation pages" (usually {{Cat|Template documentation pages}}) is added, or {{Cat|Documentation subpages without corresponding pages}} if the main page doesn't exist.)


== Display ==
== Display ==
Line 34: Line 34:
* On a /doc page, it displays a box explaining template documentation and links to the template page.
* 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 {{tlc|Documentation}}) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.
* On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains {{tlc|Documentation}}) will automatically note that the documentation is [[Wikipedia:Transclusion|transcluded]] from a subpage.
== Module documentation ==
This template is automatically shown on /doc subpages in the [[Wikipedia:Namespace|module namespace]]. This is done automatically via [[MediaWiki:Scribunto-doc-page-header]].


== Automatic categorization ==
== Automatic categorization ==
In addition to its message, the template adds pages to {{c|Template documentation pages}}, {{c|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".
In addition to its message, the template adds pages to {{Cat|Template documentation pages}}, {{Cat|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".


<includeonly>{{sandbox other||{{testcases other||
<includeonly>{{sandbox other||{{testcases other||


<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Utility templates]]
[[Category:Utility Templates]]
}}}}</includeonly>
}}}}</includeonly>

Latest revision as of 01:54, 20 August 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


This template displays a message that the current page is a documentation subpage.

Usage

{{Documentation subpage}}
or
{{Documentation subpage|Page where the documentation is transcluded}}

Text customization

The parameters |text1= and/or |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:

With |text1= and |text2=: {{Documentation subpage|text1=text1 appears here|text2=text2 appears here}}

Light bulb.png }}
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.


With |text2= only: {{Documentation subpage|text2=text2 appears here}}

Light bulb.png }}
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.


With |text1= only: {{Documentation subpage|text1=text1 appears here}}

Light bulb.png }}
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

|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

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 {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Automatic categorization

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".