Template:Dochead/doc: Difference between revisions

(53 intermediate revisions by 3 users not shown)

Line 1:

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

This template ~~inserts~~ the ~~default header into documentation pages~~ and ~~categorizes documentation by namespace~~.

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

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

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}}</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:

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

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.

=== See also ===

* [[Template: Documentation]] – inserts a documentation section onto a template or module.

* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.

@@ Line 1: / Line 1: @@
-<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
+{{dochead}}
-This template inserts the default header into documentation pages and categorizes documentation by namespace.
+{{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.
-<noinclude>[[Category:Template documentation]]</noinclude>
+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}}</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:
+<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>
+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.
+=== See also ===
+* [[Template: Documentation]] – inserts a documentation section onto a template or module.
+* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.