Template:Dochead/doc: Difference between revisions

(10 intermediate revisions by 2 users not shown)

Line 1:

~~<includeonly><hr /><span style="font-size: 0.75em;">Documentation transcluded from [[/doc]]</span></includeonly>~~

{{ {{ROOTPAGENAME}} }}

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

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

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

=== Usage ===

This template is invoked by placing <code>{{~~((}}~~dochead~~{{))~~}}</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.

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:ROOTPAGENAME]].

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

where "~~ROOTPAGENAME~~" ~~refers to~~ 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, ~~but~~ the template which calls the module ~~is named differently~~, pass in <code>temp=</code> followed by the name of the template.

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: 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>
+{{ {{ROOTPAGENAME}} }}
-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.
+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]]).
-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]]).
 === Usage ===
-This template is invoked by placing <code>{{((}}dochead{{))}}</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.
 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:ROOTPAGENAME]].
+'''Note:''' Do not invoke this module directly; use the corresponding template instead: [[mw:Help:Magic words#Page names|Template:<nowiki>{{ROOTPAGENAME}}</nowiki>]].
-where "ROOTPAGENAME" refers to 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, but the template which calls the module is named differently, pass in <code>temp=</code> followed by the name of the template.
+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]] &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>