Template:Dochead/doc: Difference between revisions

(18 intermediate revisions by 3 users not shown)

Line 1:

~~<includeonly><hr />Documentation transcluded from [[/~~doc~~]]</includeonly>~~

~~This template~~ automatically ~~inserts the default documentation header onto~~ the ~~main pages for certain items (mostly templates and~~ modules), ~~while also providing a link~~ to ~~the documentation subpage~~.

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

~~It also places items inside their respective categories~~, which eliminates the need to do this manually. Currently, it is configured to place modules and their documentation inside their respective categories ([[:Category: Lua modules]] ~~and~~ [[:Category: Module documentation]]).

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:

* [[:Category:Templates]]

* [[:Category:Lua modules]]

* [[:Category:Template documentation]]

* [[:Category:Module documentation]]

=== Usage ===

This template is invoked by placing <code>{{<nowiki />dochead}}</code> at the top of a module or template's <code~~><nowiki~~>/doc~~</nowiki>~~</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:

~~On modules, unless~~ <code>~~header=none~~</code> is ~~passed, a header will appear~~ to ~~inform users that~~ modules ~~should~~ be ~~called via~~ templates ~~instead of being~~ invoked directly:

<code>metatemplate</code> (templates only)

: '''Note:''' This template is used to build other templates and should not be used standalone except for testing and simple usage.

<code>metamodule</code> (modules only)

: '''Note:''' This module primarily provides functionality for other Lua modules and cannot be invoked by templates.

<code>dualuse</code> (modules only)

: '''Note:''' This module may be invoked by templates by using its corresponding template, or used directly from other modules.

<code>noinvoke</code> (default for modules only)

: '''Note:''' This module should not be invoked directly; use its corresponding template instead.

~~'''Note:''' Do not invoke~~ this ~~module directly; use~~ the ~~corresponding~~ template ~~instead: [[mw:Help:Magic words#Page~~ names~~|Template:~~<~~nowiki~~>~~ROOTPAGENAME~~</~~nowiki~~>]].

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

~~where <code>ROOTPAGENAME</code> is a [[mw:Help:Magic words|"magic word"]] that returns the name of the page without the namespace or subpages.~~

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

~~This way, the link in the header will attempt to point to a template with the same name as the module, since this is mostly the~~ case~~. If the template which calls the module has a different name~~, ~~pass~~ in <code>~~temp~~=</code> ~~followed by the name of the template~~.

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

~~<noinclude>[[Category:Template documentation]]</noinclude>~~

@@ Line 1: / Line 1: @@
-<includeonly><hr /><span style="font-size: 0.75em;">Documentation transcluded from [[/doc]]</span></includeonly>
+{{dochead}}
-This template automatically inserts the default documentation header onto the main pages for certain items (mostly templates and modules), while also providing a link to the documentation subpage.
+{{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.
-It also places items inside their respective categories, which eliminates the need to do this manually. Currently, it is configured to place modules and their documentation inside their respective categories ([[:Category: Lua modules]] and [[:Category: Module documentation]]).
+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:
+* [[:Category:Templates]]
+* [[:Category:Lua modules]]
+* [[:Category:Template documentation]]
+* [[:Category:Module documentation]]
 === Usage ===
-This template is invoked by placing <code>{{<nowiki />dochead}}</code> at the top of a module or template's <code><nowiki>/doc</nowiki></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:
-On modules, unless <code>header=none</code> is passed, a header will appear to inform users that modules should be called via templates instead of being invoked directly:
+<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>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>
+<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>noinvoke</code> (default for modules only)
+: <span style{{=}}"margin-bottom: 0.5em;">'''Note:''' This module should not be invoked directly; use its corresponding template instead.</span>
-'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[mw:Help:Magic words#Page names|Template:<nowiki>ROOTPAGENAME</nowiki>]].
+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>.
-where <code>ROOTPAGENAME</code> is a [[mw:Help:Magic words|"magic word"]] that returns the name of the page without the namespace or subpages.
+In either case, passing in <code>header=none</code> results in no message being displayed. A custom message may also be passed in.
-This way, the link in the header will attempt to point to a template with the same name as the module, since this is mostly the case. If the template which calls the module has a different name, pass in <code>temp=</code> followed by the name of the template.
 === See also ===
-* [[Template: Documentation]] &ndash; inserts a documentation section onto a template or module.
+* [[Template: Documentation]] – inserts a documentation section onto a template or module.
-* [[Template: Doc head Wikipedia]] &ndash; similar template, used mainly for templates borrowed from Wikipedia.
+* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.
-<noinclude>[[Category:Template documentation]]</noinclude>