Template:Documentation/doc: Difference between revisions

(7 intermediate revisions by 2 users not shown)

Line 1:

The <code>{{<nowiki />documentation}}</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__~~

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:

=== Templates ===

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

<pre>

[[Category: ~~...~~]]

[[Category: …]]

~~...~~

…

</noinclude>

</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:

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:

~~{{escape notice}}~~

<pre>

{{~~documentation~~|

{{Documentation|

~~...~~

…

}}

</pre>

Additionally, when {{tlx|lua}} is used on a module documentation page to indicate dependencies, the first ~~paragraph~~ paragraph of text after the Lua banner may need to be encased in its own paragraph (<code>~~<~~p~~>)~~</code> element:

Additionally, when {{tlx|lua}} is used on a module documentation page to indicate dependencies, the first paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><nowiki><p></nowiki></code>) element since otherwise the MediaWiki parser may fail to render the paragraphs correctly:

<pre>

{{~~documentation~~|

{{Documentation|

<p>Paragraph 1</p>

Line 38:

Line 39:

Paragraph 3

~~...~~

…

}}

</pre>

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

=== See also ===

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

* [[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}}</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__
+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:
-=== Templates ===
-On templates, place <code>{{<nowiki />documentation}}</code> on the page itself, place the relevant categories afterwards, and enclose them in <code><<nowiki />noinclude></code> tags:
 <pre>
 <noinclude>
-{{documentation}}
+{{Documentation}}
-[[Category: ...]]
+[[Category: …]]
-...
+…
 </noinclude>
 </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:
+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:
-{{escape notice}}
 <pre>
-{{documentation|
+{{Documentation|
-{{dochead}}
+{{Dochead}}
-...
+…
 }}
 </pre>
-Additionally, when {{tlx|lua}} is used on a module documentation page to indicate dependencies, the first paragraph paragraph of text after the Lua banner may need to be encased in its own paragraph (<code>&lt;p&gt;)</code> element:
+{{Escape notice}}
+Additionally, when {{tlx|lua}} is used on a module documentation page to indicate dependencies, the first paragraph of text after the Lua banner may need to be encased in its own paragraph (<code><nowiki><p></nowiki></code>) element since otherwise the MediaWiki parser may fail to render the paragraphs correctly:
 <pre>
-{{documentation|
+{{Documentation|
-{{dochead}}{{lua|...|...|}}
+{{Dochead}}{{lua|…|…|}}
 <p>Paragraph 1</p>
@@ Line 38: / Line 39: @@
 Paragraph 3
-...
+…
 }}
 </pre>
-Wikipedia has {{w|Module:Documentation}} which takes care of things automatically, but here, this is used as a workaround to avoid the need for modules.
 === See also ===
-* [[Template:Dochead]] – used to categorise and add appropriate headers onto documentation pages.
+* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.