helialprofile.png
Welcome to IOPWiki, Commander. You can contribute to this wiki without an account. Learn how to contribute and join our Discord server.

Module:Documentation/doc

Welcome to IOP Wiki. This website is maintained by the Girls' Frontline community and is free to edit by anyone.
< Module:Documentation
Revision as of 06:12, 21 December 2016 by Pianoforte (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is the documentation page for Module:Documentation

This module displays a blue box containing documentation for templates, Lua modules, or other pages. The {{Documentation}} template invokes it.

Normal usage[edit]

For most uses, you should use the {{Documentation}} template; please see that template's page for its usage instructions and parameters.

Use in other modules[edit]

To use this module from another Lua module, first load it with require:

local documentation = require('Module:Documentation').main

Then you can simply call it using a table of arguments.

documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}

Please refer to the template documentation for usage instructions and a list of parameters.

Porting to other wikis[edit]

The module has a configuration file at Module:Documentation/config which is intended to allow easy translation and porting to other wikis. Please see the code comments in the config page for instructions. If you have any questions, or you need a feature which is not currently implemented, please leave a message at Template talk:Documentation to get the attention of a developer.