Template:Documentation/doc: Difference between revisions

{{Dochead}}{{substitute|no}}{{wikipedia}}{{templatestyles}}

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.

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:

{{Documentation}}

[[Category: …]]

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

{{Documentation|

{{Dochead}}

 

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:

{{Documentation|

{{Dochead}}{{lua|…|…|}}

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