Template:Dochead/doc - Revision history

Ganaram inukshuk at 09:28, 30 October 2025

2025-10-30T09:28:36Z

← Older revision		Revision as of 09:28, 30 October 2025
Line 2:		Line 2:
	{{template rating\|rating=ready\|details=Recently rewritten. When used on a template's doc page, it automatically finds and links to the Lua modules it uses.; If used on a module's /doc page, it links to its corresponding template, if applicable.		{{template rating\|rating=ready\|details=Recently rewritten. When used on a template's doc page, it automatically finds and links to the Lua modules it uses.; If used on a module's /doc page, it links to its corresponding template, if applicable.

	This template replaces [[Template:Lua]].}}		This template replaces [[Template:Lua]]'s use on template documentation.}}
	This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:		This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:

Ganaram inukshuk: ready

2025-10-30T09:27:23Z

ready

← Older revision		Revision as of 09:27, 30 October 2025
Line 1:		Line 1:
	{{dochead}}		{{dochead}}
			{{template rating\|rating=ready\|details=Recently rewritten. When used on a template's doc page, it automatically finds and links to the Lua modules it uses.; If used on a module's /doc page, it links to its corresponding template, if applicable.

			This template replaces [[Template:Lua]].}}
	This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:		This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:

Ganaram inukshuk: update dochead

2025-10-28T09:09:55Z

update dochead

← Older revision		Revision as of 09:09, 28 October 2025
Line 1:		Line 1:
	{{~~#invoke: Dochead \|~~ dochead }}		{{dochead}}
	This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:		This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:

Ganaram inukshuk: Undo revision 214998 by Ganaram inukshuk (talk)

2025-10-28T07:46:07Z

Undo revision 214998 by Ganaram inukshuk (talk)

← Older revision		Revision as of 07:46, 28 October 2025
Line 1:		Line 1:
	{{#invoke: Dochead \| dochead ~~}}{{Template introspection~~}}		{{#invoke: Dochead \| dochead }}
	This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:		This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:

Ganaram inukshuk at 07:45, 28 October 2025

2025-10-28T07:45:46Z

← Older revision		Revision as of 07:45, 28 October 2025
Line 1:		Line 1:
	{{#invoke: Dochead \| dochead }}		{{#invoke: Dochead \| dochead }}{{Template introspection}}
	This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:		This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:

Ganaram inukshuk at 07:44, 28 October 2025

2025-10-28T07:44:03Z

← Older revision		Revision as of 07:44, 28 October 2025
Line 1:		Line 1:
	{{ ~~{{ROOTPAGENAME}}~~ }}		{{#invoke: Dochead \| dochead }}
	This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:		This template automatically categorizes documentation by namespace, which eliminates the need to do this manually. Currently, it is configured to place templates, modules, and their documentation inside their respective categories:

Ganaram inukshuk at 11:25, 24 October 2025

2025-10-24T11:25:19Z

← Older revision		Revision as of 11:25, 24 October 2025
Line 8:		Line 8:

	=== Usage ===		=== Usage ===
	This template is invoked by placing <code><nowiki>{{dochead}}</nowiki></code> at the top of a module or template's <code>/doc</code> subpage.		This template is invoked by placing <code><nowiki>{{dochead}}</nowiki></code> at the top of a module or template's <code>/doc</code> subpage. Default messages can be displayed, depending on that module or template's use:

	~~For templates, header options are as follows:~~		<code>metatemplate</code> (templates only)
			: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This template is used to build other templates and should not be used standalone except for testing and simple usage.</span>
	* <code>metatemplate</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This template is used to build other templates and should not be used standalone except for testing and simple usage.</span>		<code>metamodule</code> (modules only)
			: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module primarily provides functionality for other Lua modules and cannot be invoked by templates.</span>
	~~For modules, header options are as follows:~~		<code>dualuse</code> (modules only)
			: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module may be invoked by templates by using its corresponding template, or used directly from other modules.</span>
	* <code>metamodule</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module primarily provides functionality for other Lua modules and cannot be invoked by templates.</span>		<code>noinvoke</code> (default for modules only)
	* <code>dualuse</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module may be invoked by templates by using its corresponding template, or used directly from other modules.</span>		: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module should not be invoked directly; use its corresponding template instead.</span>
	* <code>noinvoke</code> (default): <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module should not be invoked directly; use its corresponding template instead.</span>

	When used on modules, this template will attempt to link to its corresponding template of the same name. If the template and module names differ, it can be passed in using <code>temp=Template name goes here</code>.		When used on modules, this template will attempt to link to its corresponding template of the same name. If the template and module names differ, it can be passed in using <code>temp=Template name goes here</code>.

Ganaram inukshuk at 10:46, 24 October 2025

2025-10-24T10:46:04Z

← Older revision		Revision as of 10:46, 24 October 2025
Line 19:		Line 19:
	* <code>dualuse</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module may be invoked by templates by using its corresponding template, or used directly from other modules.</span>		* <code>dualuse</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module may be invoked by templates by using its corresponding template, or used directly from other modules.</span>
	* <code>noinvoke</code> (default): <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module should not be invoked directly; use its corresponding template instead.</span>		* <code>noinvoke</code> (default): <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module should not be invoked directly; use its corresponding template instead.</span>

			When used on modules, this template will attempt to link to its corresponding template of the same name. If the template and module names differ, it can be passed in using <code>temp=Template name goes here</code>.

	In either case, passing in <code>header=none</code> results in no message being displayed. A custom message may also be passed in.		In either case, passing in <code>header=none</code> results in no message being displayed. A custom message may also be passed in.

	The [[mw:Help:Magic words\|"magic word"]] <code>ROOTPAGENAME</code> returns the name of the page without the namespace or subpages. By default, Lua modules that implement templates provide a link to a template of the same name. If this name is different, it can be passed in using <code>temp=Template name goes here</code>.

	=== See also ===		=== See also ===
	* [[Template: Documentation]] – inserts a documentation section onto a template or module.		* [[Template: Documentation]] – inserts a documentation section onto a template or module.
	* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.		* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.

Ganaram inukshuk: update to reflect template changes

2025-10-24T10:40:05Z

update to reflect template changes

← Older revision		Revision as of 10:40, 24 October 2025
Line 12:		Line 12:
	For templates, header options are as follows:		For templates, header options are as follows:

	* <code>metatemplate</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This template is used to build other templates and should not be used standalone except for testing and simple usage.</span~~><br /~~>		* <code>metatemplate</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This template is used to build other templates and should not be used standalone except for testing and simple usage.</span>

	For modules, header options are as follows:		For modules, header options are as follows:

	* <code>metamodule</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module primarily provides functionality for other Lua modules and cannot be invoked by templates.</span~~><br /~~>		* <code>metamodule</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module primarily provides functionality for other Lua modules and cannot be invoked by templates.</span>
	* <code>dualuse</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module may be invoked by templates using ~~Template:<nowiki>{{ROOTPAGENAME}}</nowiki>~~, or used directly from other modules.</span~~><br /~~>		* <code>dualuse</code>: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module may be invoked by templates by using its corresponding template, or used directly from other modules.</span>
	* <code>noinvoke</code> (default): <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module ~~provides functionality to a template and~~ should not be invoked directly; use ~~the~~ corresponding template instead~~: Template:<nowiki>{{ROOTPAGENAME}}</nowiki>~~.</span~~><br /~~>		* <code>noinvoke</code> (default): <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module should not be invoked directly; use its corresponding template instead.</span>

	In either case, passing in <code>header=none</code> results in no message being displayed. A custom message may also be passed in.		In either case, passing in <code>header=none</code> results in no message being displayed. A custom message may also be passed in.

Ganaram inukshuk: remove todo, as task is, for the most part, accomplished

2025-10-23T23:05:48Z

remove todo, as task is, for the most part, accomplished

← Older revision		Revision as of 23:05, 23 October 2025
Line 27:		Line 27:
	* [[Template: Documentation]] – inserts a documentation section onto a template or module.		* [[Template: Documentation]] – inserts a documentation section onto a template or module.
	* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.		* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.

	{{todo\|update documentation\|inline=1\|text=Dochead should now be able support categories on both templates and modules. Now contains new default messages that came up a lot that the single "use this module's corresponding template" message cannot capture.}}