Template:Dochead/doc: Difference between revisions

(36 intermediate revisions by 3 users not shown)

Line 1:

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

{{ {{ROOTPAGENAME}} }}

This template automatically ~~inserts~~ the ~~default~~ documentation ~~header~~:

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

~~: {| style~~=~~"margin: 15px 0px 15px 0px; width: 98%;"~~

=== Usage ===

| <hr><~~small~~>~~Documentation transcluded from [[Template:Docheadwiki~~/~~doc|~~/doc]]</~~small~~>

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:

~~on templates and modules, while also providing a link to~~ the ~~documentation subpage. It is wrapped in a <code><span></code> element with a switchable~~ <~~code~~>~~display~~</~~code~~> ~~so that it is visible on the base page but not on the documentation page~~.

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

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

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

~~=== Usage ===~~

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.

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

=== See also ===

* [[Template:~~Docheadwiki~~]] ~~– Similar~~ template, used mainly for templates ~~which are more or less copied over~~ from Wikipedia.

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

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

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

@@ Line 1: / Line 1: @@
-<includeonly><hr><small>Documentation transcluded from [[/doc]]</small></includeonly>
+{{ {{ROOTPAGENAME}} }}
-This template automatically inserts the default documentation header:
+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]]).
-: {| style="margin: 15px 0px 15px 0px; width: 98%;"
+=== Usage ===
-| <hr><small>Documentation transcluded from [[Template:Docheadwiki/doc|/doc]]</small>
+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:
-on templates and modules, while also providing a link to the documentation subpage. It is wrapped in a <code>&lt;span&gt;</code> element with a switchable <code>display</code> so that it is visible on the base page but not on the documentation page.
+'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[mw:Help:Magic words#Page names|Template:<nowiki>{{ROOTPAGENAME}}</nowiki>]].
-It also places items inside their respective categories, which eliminates the need to do this manually. Currently, it is configured to place templates inside [[:Category:Templates]] and modules inside [[:Category:Lua modules]].
+where <code>ROOTPAGENAME</code> is a [[mw:Help:Magic words|"magic word"]] that returns the name of the page without the namespace or subpages.
-=== Usage ===
+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.
-This template is invoked by placing <code>{{((}}dochead{{))}}</code> at the top of a module or template's <code>/doc</code> subpage.
 === See also ===
-* [[Template:Docheadwiki]] &ndash; Similar template, used mainly for templates which are more or less copied over from Wikipedia.
+* [[Template: Documentation]] – inserts a documentation section onto a template or module.
+* [[Template: Doc head Wikipedia]] – similar template, used mainly for templates borrowed from Wikipedia.
-<noinclude>[[Category:Template documentation]]</noinclude>