Template:Documentation/doc - Revision history

FHODSArchive: Blanked the page

2026-06-15T21:37:41Z

Blanked the page

FHODSArchive: /* Testing */

2026-06-15T21:36:51Z

Testing

← Older revision		Revision as of 21:36, 15 June 2026
Line 59:		Line 59:

	To hide the link box, simply set {{para\|link box}} to <code>off</code>.		To hide the link box, simply set {{para\|link box}} to <code>off</code>.

	~~=== Testing ===~~
	You can simulate the output for a given page by using the {{para\|page}} parameter. For example, if you use the code {{para\|page\|Template:Edit protected}}, the template will behave exactly as if it were on the page [[Template:Edit protected]], including showing the documentation from [[Template:Edit protected/doc]], linking to [[Template:Edit protected/sandbox]], etc. This parameter is useful for testing and is used extensively on the [[Module:Documentation/testcases\|module testcases page]].

	== Placement and tags ==		== Placement and tags ==

FHODSArchive: /* General syntax */

2026-06-15T21:35:52Z

General syntax

← Older revision		Revision as of 21:35, 15 June 2026
Line 6:		Line 6:

	== General syntax ==		== General syntax ==
	Normally, the template is used without parameters and is placed inside {{tag\|noinclude}} at the bottom of the template page ~~(see {{section link\|#Placement and tags}} for more information)~~:		Normally, the template is used without parameters and is placed inside {{tag\|noinclude}} at the bottom of the template page:

	<syntaxhighlight lang="wikitext">		<syntaxhighlight lang="wikitext">

FHODSArchive at 21:35, 15 June 2026

2026-06-15T21:35:27Z

← Older revision		Revision as of 21:35, 15 June 2026
Line 1:		Line 1:
	The ~~{{tlx\|~~documentation}} template is used to contain the documented information and instructions of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.		The documentation template is used to contain the documented information and instructions of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.

	This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the <code>[view][edit][history][purge]</code> links), and the smaller "link box" that shows metadata about the documentation alongside the [[Wikipedia:Template sandbox and test cases\|sandbox and testcases]] links.		This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the <code>[view][edit][history][purge]</code> links), and the smaller "link box" that shows metadata about the documentation alongside the [[Wikipedia:Template sandbox and test cases\|sandbox and testcases]] links.

FHODSArchive at 17:13, 19 May 2026

2026-05-19T17:13:34Z

← Older revision		Revision as of 17:13, 19 May 2026
Line 165:		Line 165:
	</syntaxhighlight>		</syntaxhighlight>

	~~Example:{{Template link expanded\|Periodic table templates overview}}~~

FHODSArchive: /* See also */

2026-05-19T16:31:25Z

FHODSArchive: /* Placement and tags */

2025-07-02T19:37:55Z

Placement and tags

← Older revision		Revision as of 19:37, 2 July 2025
Line 64:		Line 64:

	== Placement and tags ==		== Placement and tags ==
	~~{{Further information\|Wikipedia:Template documentation#Where to place it}}~~
	This code should be added at the bottom of the template code page, with no space before {{Tag\|noinclude\|o}} (which causes extra whitespace to show on pages where the template is transcluded):		This code should be added at the bottom of the template code page, with no space before {{Tag\|noinclude\|o}} (which causes extra whitespace to show on pages where the template is transcluded):

Line 71:		Line 70:
	<!-- Add categories to the /doc subpage -->		<!-- Add categories to the /doc subpage -->
	</noinclude></syntaxhighlight>		</noinclude></syntaxhighlight>

	~~To automatically insert the above text, you can also use the [[Wikipedia:Substitution\|substitution]] code shortcut {{tlxs\|doc-code}}.~~

	~~=== Categories and interwikis ===~~
	Depending on where to the documentation is placed, it may be tricky to handle the categories and interwikis. See {{section link\|Wikipedia:Template documentation#Categories and interwiki links}} for information about adding these.

	== Technical details ==		== Technical details ==

FHODSArchive at 19:37, 2 July 2025

2025-07-02T19:37:05Z

← Older revision		Revision as of 19:37, 2 July 2025
Line 156:		Line 156:
	\| Main background \|\| So saturation in A is a bit off		\| Main background \|\| So saturation in A is a bit off
	\|}		\|}
	~~{{collapse top\|title=Colors for documentation navbox}}~~
	As a suggestion, here are colors for a navbox intended for documentation pages only.		As a suggestion, here are colors for a navbox intended for documentation pages only.
	They follow the shading of regular blue navbox colors:		They follow the shading of regular blue navbox colors:
Line 172:		Line 172:

	Example:{{Template link expanded\|Periodic table templates overview}}		Example:{{Template link expanded\|Periodic table templates overview}}
	~~{{collapse bottom}}~~

	== Full syntax ==		== Full syntax ==

FHODSArchive at 22:08, 19 March 2025

2025-03-19T22:08:11Z

← Older revision		Revision as of 22:08, 19 March 2025
Line 108:		Line 108:

	=== Subject namespaces vs. talk namespaces ===		=== Subject namespaces vs. talk namespaces ===
	This template is usually placed in the ~~[[WP:NS#Subject namespaces\|~~subject namespace]]. But in some cases this template needs to be on the ~~[[WP:TALKSPACE\|Talk~~ namespace]]:		This template is usually placed in the subject namespace. But in some cases this template needs to be on the namespace:

	* In the MediaWiki namespace, since {{tag\|noinclude\|o}} often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.		* In the MediaWiki namespace, since {{tag\|noinclude\|o}} often does not work in system messages, and since the MediaWiki namespace needs to be kept clean for performance reasons.
Line 114:		Line 114:
	When placed on talk pages, this template usually is placed near the top of the page and without {{tag\|noinclude}} tags.		When placed on talk pages, this template usually is placed near the top of the page and without {{tag\|noinclude}} tags.

	The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki ~~[[meta:Help:Link#Subpage feature\|~~subpage feature]] enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.		The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki subpage feature enabled: Main, File, and MediaWiki. (Categories can have subpages, but documentation is created in the Category talk namespace to prevent creating empty categories. There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.

	This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.		This template automatically points its [create] links for the /doc, /sandbox and /testcases to the right namespace.

FHODSArchive at 22:07, 19 March 2025

2025-03-19T22:07:17Z

← Older revision		Revision as of 22:07, 19 March 2025
Line 1:		Line 1:
	The {{tlx\|documentation}} template is used to contain the ~~[[WP:TDOC\|~~documented information and instructions]] of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.		The {{tlx\|documentation}} template is used to contain the documented information and instructions of a certain template, usually from a /doc subpage. It can also be configured to load the content from other pages or be directly fed by text.

	~~For detailed instructions on how and when to use this template, see [[Wikipedia:Template documentation]] (shortcut: [[WP:TDOC]])~~.

	This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the <code>[view][edit][history][purge]</code> links), and the smaller "link box" that shows metadata about the documentation alongside the [[Wikipedia:Template sandbox and test cases\|sandbox and testcases]] links.		This template has two parts: the big "documentation box" with the documentation inside alongside a toolbar (the <code>[view][edit][history][purge]</code> links), and the smaller "link box" that shows metadata about the documentation alongside the [[Wikipedia:Template sandbox and test cases\|sandbox and testcases]] links.

	Use of this template allows templates to be ~~[[Wikipedia:Protection policy\|~~protected]], where necessary, while allowing anyone to edit the documentation and categories.		Use of this template allows templates to be protected, where necessary, while allowing anyone to edit the documentation and categories.

	== General syntax ==		== General syntax ==

← Older revision		Revision as of 16:31, 19 May 2026
Line 205:		Line 205:
	==See also==		==See also==
	* {{tl\|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.		* {{tl\|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents.
	* {{tl\|Barnstar documentation}}, a variant of {{tl\|Documentation}} for use with [[Wikipedia:Barnstars\|barnstar]] templates.
	* {{tl\|Navbox documentation}}, a variant of {{tl\|Documentation}} for use with [[Wikipedia:Navigation template\|navigation templates]].		* {{tl\|Navbox documentation}}, a variant of {{tl\|Documentation}} for use with [[Wikipedia:Navigation template\|navigation templates]].
	* [[Wikipedia:Template documentation]] is a how-to guide to template documentation.		* [[Wikipedia:Template documentation]] is a how-to guide to template documentation.