Template:Dochead/doc: Difference between revisions

(39 intermediate revisions by 3 users not shown)

Line 1:

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

{{ {{ROOTPAGENAME}} }}

This template automatically categorizes documentation by namespace, 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 ~~inserts~~ the ~~default~~ header ~~into documentation pages and categorizes documentation by namespace~~.

=== Usage ===

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

This template is invoked by placing <code><nowiki>{{dochead}}</nowiki></code> at the top of a module or template's <code>/doc</code> subpage.

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:

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

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

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: 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>
+{{ {{ROOTPAGENAME}} }}
+This template automatically categorizes documentation by namespace, 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 inserts the default header into documentation pages and categorizes documentation by namespace.
+=== Usage ===
-<noinclude>[[Category:Template documentation]]</noinclude>
+This template is invoked by placing <code><nowiki>{{dochead}}</nowiki></code> at the top of a module or template's <code>/doc</code> subpage.
+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:
+'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[mw:Help:Magic words#Page names|Template:<nowiki>{{ROOTPAGENAME}}</nowiki>]].
+where <code>ROOTPAGENAME</code> is a [[mw:Help:Magic words|"magic word"]] that returns the name of the page without the namespace or subpages.
+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: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.