Template:Documentation

Template documentation
Note: portions of the template sample may not be visible without values provided.
View or edit this documentation. (About template documentation) This template uses Module:Documentation, a script written in Lua. Please see wikipedia:wp:Lua and mw:Extension:Scribunto to learn more. For templates, insert <noinclude>{{subst:doc}}</noinclude> at the end of the template, then save the page, this will place {{documentation}} and a comment advising editors where to place categories and interwiki links. For other types of pages, the documentation template should already be there. Click "create" at the top of the page and the documentation page will be opened with some pre-formatting. Documentation pages will automatically be added to Category:Documentation templates. Optional parameters This parameters can either be added to the {{subst:doc}} template when creating the page, or added to the {{documentation}} template afterwards. type Sets the "type" of documentation this is, e.g. template, module, message, etc. This will be used as part of some messages the template might display, as well as categorisation. The type is automatic based on the title, so it shouldn't generally need to be set. nodoc If a template has no documentation and you don't know how to use it, add nodoc=1 to the documentation template on the documentation page. The documentation's background will become red to make it more noticeable, and the page will be added to Category:Page with no documentation, if it's a template. This is automatically set if the documentation page doesn't exist, so this generally isn't necessary to set.|Documentation]]