Template:Documentation/doc: Difference between revisions

← Older edit

VisualWikitext

@@ Line 1: / Line 1: @@
-{{dochead}}
+{{Dochead}}{{substitute|no}}{{wikipedia}}{{templatestyles}}
-{{wikipedia}}
+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.
-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.{{clear}}
+__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.
+==== 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:
+<pre>
+<noinclude>
+{{Documentation}}
+[[Category: …]]
+…
+</noinclude>
+</pre>
+==== 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:
+<pre>
+{{Documentation|
+{{Dochead}}
+…
+}}
+</pre>
+{{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|
+{{Dochead}}{{lua|…|…|}}
+<p>Paragraph 1</p>
+Paragraph 2
+Paragraph 3
+…
+}}
+</pre>
 === See also ===
-* [[Template:Dochead]] &ndash; used to categorise and add appropriate headers onto documentation pages.
+* [[Template: Dochead]] – used to categorise and add appropriate headers onto documentation pages.