Модуль:Documentation/doc — различия между версиями

Текущая версия на 16:18, 17 февраля 2015

This module displays a blue box containing documentation for templates, Lua modules, or other pages. It is usually run using the {{documentation}} template.

Normal usage[править]

For most uses, this module should be called from the {{documentation}} template. Please see the template page for usage instructions and a list of parameters.

Use in other modules[править]

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[править]

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.