https://www.fallenchungus.wiki/index.php?action=history&feed=atom&title=Template%3ADocumentation_subpage%2FdocTemplate:Documentation subpage/doc - Revision history2026-04-18T17:03:21ZRevision history for this page on the wikiMediaWiki 1.44.3https://www.fallenchungus.wiki/index.php?title=Template:Documentation_subpage/doc&diff=1905&oldid=prevCapybaraKiller: 1 revision imported: To get boxes working.2025-05-25T16:47:55Z<p>1 revision imported: To get boxes working.</p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<tr class="diff-title" lang="en">
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 09:47, 25 May 2025</td>
</tr><tr><td colspan="2" class="diff-notice" lang="en"><div class="mw-diff-empty">(No difference)</div>
</td></tr></table>CapybaraKillerhttps://www.fallenchungus.wiki/index.php?title=Template:Documentation_subpage/doc&diff=1904&oldid=prevwikipedia>Musiconeologist: /* top */Further tweak to read more naturally in the search results2025-03-15T09:19:50Z<p><span class="autocomment">top: </span>Further tweak to read more naturally in the search results</p>
<p><b>New page</b></p><div>{{Short description|For use on the subpage itself}}<br />
{{tsh|doc sub}}<br />
{{Documentation subpage}}<br />
{{Distinguish|Template:Documentation}}<br />
This template displays a message that the current page is a documentation subpage.<br />
<br />
== Usage ==<br />
: {{Template link expanded|Documentation subpage}}<br />
: or<br />
: {{Template link expanded|Documentation subpage |&#91;&#91;{{var|Page where the documentation is [[Help:Transclusion|transcluded]]}}&#93;&#93;}}<br />
<br />
===Userbox documentation===<br />
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:<br />
: {{Template link expanded|Userbox documentation subpage}}<br />
: or<br />
: {{Template link expanded|Userbox documentation subpage |&#91;&#91;{{var|userbox page}}&#93;&#93;}}<br />
<br />
===Text customization===<br />
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'':<br />
{{Hidden begin |showhide=left |title=With ''text1'' and ''text2''}}<br />
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}</nowiki></code><br />
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}<br />
{{Hidden end}}<br />
{{Hidden begin |showhide=left |title=With ''text2'' only}}<br />
<code><nowiki>{{Documentation subpage |text2='''''text2 appears here'''''}}</nowiki></code><br />
{{Documentation subpage |[''page''] |text2='''''text2 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}<br />
{{Hidden end}}<br />
{{Hidden begin |showhide=left |title=With ''text1'' only}}<br />
<code><nowiki>{{Documentation subpage |text1='''''text1 appears here'''''}}</nowiki></code><br />
{{Documentation subpage |[''page''] |text1='''''text1 appears here''''' |override={{lc:{{SUBPAGENAME}}<!-- Hack to allow example to appear, even when viewed from [[Template:Documentation subpage]] -->}}}}<br />
{{Hidden end}}<br />
<br />
===Other parameters===<br />
{{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.)<br />
<br />
== Display ==<br />
This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:<br />
* On a /doc page, it displays a box explaining template documentation and links to the template page.<br />
** 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)<br />
* On other pages&nbsp;– i.e. pages transcluding the /doc page&nbsp;– 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.<br />
<br />
== Module documentation ==<br />
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.<br />
<br />
== Automatic categorization ==<br />
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".<br />
<br />
== See also ==<br />
<includeonly>{{#switch:{{FULLPAGENAME}}<br />
|Template:Userbox documentation subpage=<br />
*{{Template link|Userbox/categories}}<br />
*{{Template link|Userbox/citydoc}}}}</includeonly><br />
*{{Template link|Documentation/see also}}<br />
*{{Template link|Documentation subpage}}<br />
*{{Template link|Userspace disclaimers}}<br />
*{{Template link|Userbox documentation subpage}}<br />
<br />
<includeonly>{{Sandbox other||<!-- Make sure only the template page is categorised. No subpages, and not after transclusion. This /doc page is reused, btw.<br />
-->{{#switch:{{FULLPAGENAME}}<br />
|Template:Documentation subpage = [[Category:Documentation templates| ]]<br />
|Template:Userbox documentation subpage = [[Category:Documentation templates| ]][[Category:Userboxes|Δ]]<br />
}}<br />
[[Category:Documentation header templates]]<br />
}}</includeonly></div>wikipedia>Musiconeologist