Template:Dochead/doc: Difference between revisions

Line 5:

=== Usage ===

This template is invoked by placing <code><nowiki>{{dochead}}~~</nowiki>~~</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}}</code> at the top of a module or template's <code><nowiki>/doc</nowiki></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 <code>ROOTPAGENAME</code> ~~refers to~~ the name of the page without the namespace or subpages.

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.

@@ Line 5: / Line 5: @@
 === Usage ===
-This template is invoked by placing <code><nowiki>{{dochead}}</nowiki></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}}</code> at the top of a module or template's <code><nowiki>/doc</nowiki></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 <code>ROOTPAGENAME</code> refers to the name of the page without the namespace or subpages.
+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.