Module:Documentation/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>OmegaK2
(Created page with "{{wikipedia template|namespace=Module:}}")
 
No edit summary
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wikipedia template|namespace=Module:}}
{{Documentation subpage}}
{{Lua|Module:Documentation/config|Module:Arguments}}
 
This module displays a section containing documentation for [[Help:Templates|templates]], [[Help:Modules|modules]], or other pages. It implements the {{tl|documentation}} template.
 
==Usage==
In most cases, you should use the {{tl|documentation}} template. Refer to the template's documentation for usage instructions and parameters.
 
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>
 
{{Adapted from Wikipedia|Module:Documentation}}
 
{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Documentation modules]]
}}

Latest revision as of 02:35, 15 June 2023

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

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

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'}
This module was adapted from Module:Documentation on Wikipedia.
Adaptation is noted for reference and attribution only. This module may differ from the original in function or in usage.