Template:Documentation
Jump to navigation
Jump to search
 |
"Greetings to you, friend! Are you lost?" —Nembadeth Miscellaneous Stub This article or section is marked for missing content. You can help expand it by clicking Edit above Pages linking here may have clues as to what the page should contain, or perhaps the discussion tab page. |
This template is missing a nocat parameter. E.g. Template:Infobox Titles is obsolete but cannot be hidden from Category:Template Documentation.
This is the template documentation for {{Documentation}}. It is transcluded from Template:Documentation/doc and may be directly edited there.
Description
This template simplifies the documentation of templates on Lotro-Wiki. It facilitates links to the template's page, the /doc page, and a direct link to editing the documentation, all dressed up in a recognizable green box similar to Wikipedia. Categorization in Category:Template Documentation is also handled automatically.
Usage
{{Documentation|
== Usage ==
Describe the purpose and function of the template, when to use it, when a different template might be indicated, and any considerations/gotchas to be aware of.
(preformatted template syntax box here - one liner for short templates/positional parameters, big box for the larger ones)
<pre>{{Template | <positional parameter> | [positional parameter=]<with optional keyword> | keyword=parameter }}<\pre>
=== Parameters ===
Definition-list itemization of all parameters, identifying each as optional or required and describing the range and effects each has.
== Examples ==
Minimal working example code for most-common uses for the template, followed by output if applicable.
|[[Template Categorization]]}}
Parameters
- {{{1}}}
- Required: The full text of the template's documentation, following the guidelines set forth here (not yet).
- {{{2}}}
- Optional, but recommended: Categories for the template being documented (the documentation page itself will automatically be included in Category:Template Documentation).