Template:Documentation subpage/doc - Revision history

Matt at 14:07, 19 April 2025

2025-04-19T14:07:00Z

← Older revision		Revision as of 10:07, 19 April 2025
Line 7:		Line 7:
	: {{Template link expanded\|Documentation subpage}}		: {{Template link expanded\|Documentation subpage}}
	: or		: or
	: {{Template link expanded\|Documentation subpage \|[[{{var\|Page where the documentation is ~~[[Help:Transclusion\|~~transcluded]]}}]]}}		: {{Template link expanded\|Documentation subpage \|[[{{var\|Page where the documentation is transcluded}}]]}}

	===Userbox documentation===		===Userbox documentation===
Line 31:		Line 31:

	===Other parameters===		===Other parameters===
	{{para\|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.)		{{para\|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 ==		== Display ==
Line 37:		Line 37:
	* 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.
	** As a workaround if the documentation page's name doesn't end with '/doc', use {{para\|override}} to specify the doc subpage's name. For example, if the documentation were at "Template:Example/Documentation", use {{para\|override\|documentation}} (must be lower-case to work)		** As a workaround if the documentation page's name doesn't end with '/doc', use {{para\|override}} to specify the doc subpage's name. For example, if the documentation were at "Template:Example/Documentation", use {{para\|override\|documentation}} (must be lower-case to work)
	* On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains <code>{{Template link\|Documentation}}</code>) will automatically note that the documentation is ~~[[Help: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 <code>{{Template link\|Documentation}}</code>) will automatically note that the documentation is transcluded from a subpage.

	== Module documentation ==		== 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]]. This ~~[[MediaWiki talk:Scribunto-doc-page-header#Category:Module documentation pages\|~~fails to add the doc page]] to [[:Category:Module documentation pages]] so some module doc pages transclude the template manually or add the category directly to fix this.		This template is automatically shown on /doc subpages in the module namespace. This is done automatically via MediaWiki:Scribunto-doc-page-header] This fails to add the doc page to :Category:Module documentation pages so some module doc pages transclude the template manually or add the category directly to fix this.

	== Automatic categorization ==		== 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 ~~[[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 sort key]to the page name without namespace: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

	~~== See also ==~~
	~~<includeonly>{{#switch:{{FULLPAGENAME}}~~
	~~\|Template:Userbox documentation subpage=~~
	*{{Template link\|Userbox/categories}}
	*{{Template link\|Userbox/citydoc}}}}</includeonly>
	*{{Template link\|Documentation/see also}}
	*{{Template link\|Documentation subpage}}
	*{{Template link\|Userspace disclaimers}}
	*{{Template link\|Userbox documentation subpage}}

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

Matt at 08:06, 9 April 2025

2025-04-09T08:06:35Z

← Older revision		Revision as of 04:06, 9 April 2025
Line 2:		Line 2:
	{{tsh\|doc sub}}		{{tsh\|doc sub}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{Distinguish\|Template:Documentation}}~~
	This template displays a message that the current page is a documentation subpage.		This template displays a message that the current page is a documentation subpage.

Matt at 21:10, 5 March 2025

2025-03-05T21:10:39Z

← Older revision		Revision as of 17:10, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{tsh\|doc sub}}		{{tsh\|doc sub}}
	{{Documentation subpage}}		{{Documentation subpage}}

Matt: Protected "Template:Documentation subpage/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T19:57:07Z

Protected "Template:Documentation subpage/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 15:57, 5 March 2025
(No difference)

Matt: Created page with "{{tsh|doc sub}} {{Documentation subpage}} {{Distinguish|Template:Documentation}} This template displays a message that the current page is a documentation subpage. == Usage == : {{Template link expanded|Documentation subpage}} : or : {{Template link expanded|Documentation subpage |[[{{var|Page where the documentation is transcluded}}]]}} ===Userbox documentation=== To set this template to use "userbox" and "userbox page" rather tha..."

2025-03-05T18:46:55Z

Created page with "{{tsh|doc sub}} {{Documentation subpage}} {{Distinguish|Template:Documentation}} This template displays a message that the current page is a documentation subpage. == Usage == : {{Template link expanded|Documentation subpage}} : or : {{Template link expanded|Documentation subpage |[[{{var|Page where the documentation is [[Help:Transclusion|transcluded]]}}]]}} ===Userbox documentation=== To set this template to use "userbox" and "userbox page" rather tha..."

New page

{{tsh|doc sub}}
{{Documentation subpage}}
{{Distinguish|Template:Documentation}}
This template displays a message that the current page is a documentation subpage.

== Usage ==
: {{Template link expanded|Documentation subpage}}
: or
: {{Template link expanded|Documentation subpage |[[{{var|Page where the documentation is [[Help:Transclusion|transcluded]]}}]]}}

===Userbox documentation===
To set this template to use "userbox" and "userbox page" rather than "{{lc:{{ns:Template}}}}" and "{{lc:{{ns:Template}}}} page" or "{{lc:{{ns:User}}}} template" and "{{lc:{{ns:User}}}} template page", use:
: {{Template link expanded|Userbox documentation subpage}}
: or
: {{Template link expanded|Userbox documentation subpage |[[{{var|userbox page}}]]}}

===Text customization===
The parameters {{para|text1}} and {{para|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'':
{{Hidden begin |showhide=left |title=With ''text1'' and ''text2''}}
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code>
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}}}}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=With ''text2'' only}}
<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code>
{{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}}}}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=With ''text1'' only}}
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code>
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}}}}}
{{Hidden end}}

===Other parameters===
{{para|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.
** As a workaround if the documentation page's name doesn't end with '/doc', use {{para|override}} to specify the doc subpage's name. For example, if the documentation were at "Template:Example/Documentation", use {{para|override|documentation}} (must be lower-case to work)
* On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself (which contains <code>{{Template link|Documentation}}</code>) will automatically note that the documentation is [[Help: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]]. This [[MediaWiki talk:Scribunto-doc-page-header#Category:Module documentation pages|fails to add the doc page]] to [[:Category:Module documentation pages]] so some module doc pages transclude the template manually or add the category directly to fix this.

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

== See also ==
<includeonly>{{#switch:{{FULLPAGENAME}}
|Template:Userbox documentation subpage=
*{{Template link|Userbox/categories}}
*{{Template link|Userbox/citydoc}}}}</includeonly>
*{{Template link|Documentation/see also}}
*{{Template link|Documentation subpage}}
*{{Template link|Userspace disclaimers}}
*{{Template link|Userbox documentation subpage}}

<includeonly>{{Sandbox other||{{#switch:{{FULLPAGENAME}}
|Template:Documentation subpage = [[Category:Documentation templates| ]]
|Template:Userbox documentation subpage = [[Category:Documentation templates| ]][[Category:Userboxes|Δ]]
}}
[[Category:Documentation header templates]]
}}</includeonly>