Template:Documentation/doc: Difference between revisions

(4 intermediate revisions by 2 users not shown)

Line 1:

The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. ~~The actual information~~ is ~~located in~~ the <code>/doc</code> subpage.

The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.

__NOTOC__

=== Usage ===

This template automatically extracts contents from the <code>/doc</code> subpage of any page. You can optionally add an unnamed argument, which will be displayed in place.

~~Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.~~

==== Templates ====

~~__NOTOC__~~

=== Templates ===

On templates, place <code><nowiki>{{documentation}}</nowiki></code> on the page itself, place the relevant categories afterwards, and enclose them in <code><nowiki><noinclude></nowiki></code> tags:

Line 16:

Line 17:

</pre>

=== Modules ===

==== Modules ====

On pages consisting of exclusively code (modules, CSS, JS, etc.), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead}}, in as the first unnamed parameter:

Line 41:

Line 42:

}}

</pre>

~~Wikipedia has {{w|Module: Documentation}} which takes care of things automatically, but here, these are used as workarounds to avoid the need for modules.~~

=== See also ===

* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.

@@ Line 1: / Line 1: @@
-{{Dochead}}{{wikipedia}}
+{{Dochead}}{{substitute|no}}{{wikipedia}}{{templatestyles}}
-The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. The actual information is located in the <code>/doc</code> subpage.
+The <code><nowiki>{{documentation}}</nowiki></code> template is used to contain information and instructions for templates and modules. Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.
+__NOTOC__
+=== Usage ===
+This template automatically extracts contents from the <code>/doc</code> subpage of any page. You can optionally add an unnamed argument, which will be displayed in place.
-Wikipedia's documentation template has modules that help render the dialog boxes, but here the box is hard-coded to simplify things.
+==== Templates ====
-__NOTOC__
-=== Templates ===
 On templates, place <code><nowiki>{{documentation}}</nowiki></code> on the page itself, place the relevant categories afterwards, and enclose them in <code><nowiki><noinclude></nowiki></code> tags:
@@ Line 16: / Line 17: @@
 </pre>
-=== Modules ===
+==== Modules ====
 On pages consisting of exclusively code (modules, CSS, JS, etc.), place this template on the <code>/doc</code> subpage and pass the notes, along with {{tlx|dochead}}, in as the first unnamed parameter:
@@ Line 41: / Line 42: @@
 }}
 </pre>
-Wikipedia has {{w|Module: Documentation}} which takes care of things automatically, but here, these are used as workarounds to avoid the need for modules.
 === See also ===
 * [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.