Module:Documentation/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
No edit summary
(Need to put {{Documentation subpage}} here after all: Explanation.)
Line 1: Line 1:
{{lua|Module:Arguments|Module:Message box|Module:Documentation/config}}
{{Documentation subpage}}
 
{{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.
This module displays a section containing documentation for [[gphelp:Template|templates]], [[gphelp:Scribunto extension|modules]], or other pages. It implements the {{tl|documentation}} template.
Line 19: Line 21:


Refer to the {{tl|documentation}} template's documentation for usage instructions and parameters.
Refer to the {{tl|documentation}} template's documentation for usage instructions and parameters.
{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Modules]]
}}

Revision as of 07:23, 6 December 2020

This subpage provides documentation for Module:Documentation.

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.