Module:Documentation/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{wikipedia template|namespace=Module:}}
{{lua|Module:Arguments|Module:Message box|Module:Documentation/config}}
{{lua|Module:Arguments|Module:Message box|Module:Documentation/config}}
This module displays a section containing documentation for [[gphelp:Template|templates]], [[gphelp:Scribunto extension|modules]], or other pages. It implements the {{tl|documentation}} template.
==Usage from wikitext==
In most cases, you should use the {{tl|documentation}} template. Refer to the template's documentation for usage instructions and parameters.
==Usage from other modules==
To use this module from another module, first <code>require</code> it:
<syntaxhighlight lang="lua">
local documentation = require('Module:Documentation').main
</syntaxhighlight>
Then call the function with a table of arguments:
<syntaxhighlight lang="lua">
documentation{content = 'Some documentation', ['link box'] = 'My custom link box'}
</syntaxhighlight>
Refer to the {{tl|documentation}} template's documentation for usage instructions and parameters.

Revision as of 14:35, 29 July 2020

Lua logo

This module depends on the following other modules:

This module displays a section containing documentation for templates, modules, or other pages. It implements the {{documentation}} template.

Usage from wikitext

In most cases, you should use the {{documentation}} template. Refer to the template's documentation for usage instructions and parameters.

Usage from other modules

To use this module from another module, first require it:

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

Then call the function with a table of arguments:

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

Refer to the {{documentation}} template's documentation for usage instructions and parameters.