Module:Shortcut/doc: Difference between revisions
From Kenshi Wiki
More actions
Created page with "{{Module rating|protected}} {{High-use|demo=Module:{{ROOTPAGENAME}}}} {{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} {{Uses TemplateStyles|Module:Shortcut/styles.css}} {{Lua sidebar}} This module makes a box showing the shortcut links to a page. == Usage == === From wikitext === From wikitext, this module should be called from a template, usually {{tl|shortcut}}. Please see the template page for documentation. However, it can also be called u..." |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{doc sub}} | ||
{{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} | {{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} | ||
{{Uses TemplateStyles|Module:Shortcut/styles.css}} | {{Uses TemplateStyles|Module:Shortcut/styles.css}} | ||
| Line 39: | Line 38: | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- Categories go here and interwikis go in Wikidata. --> | <!-- Categories go here and interwikis go in Wikidata. --> | ||
[[Category:Modules]] | |||
}}</includeonly> | }}</includeonly><noinclude> | ||
[[Category:Module documents]] | |||
</noinclude> | |||
Latest revision as of 01:19, 10 March 2025
 | This is a documentation subpage for Module:Shortcut. It may contain usage information, categories and other content that is not part of the original module page. |
 | Uses Lua: |
 | This module uses TemplateStyles: |
| Related pages |
|---|
This module makes a box showing the shortcut links to a page.
Usage
From wikitext
From wikitext, this module should be called from a template, usually {{shortcut}}. Please see the template page for documentation. However, it can also be called using the syntax {{#invoke:shortcut|main|arguments}}.
From Lua
To use this module from Lua, first load it.
local mShortcut = require('Module:Shortcut')Then you can create shortcut boxes with the following syntax:
mShortcut._main(shortcuts, options, frame, cfg)- shortcuts is an array of shortcut page names. (required)
- options is a table of options. The following keys are supported:
msg- a message to leave after the list of shortcuts.category- if set to false (or a value regarded as false by Module:Yesno, such as "no"), categories are suppressed.
- frame is a frame object. This is optional, and only intended to be used internally.
- cfg is a table of config values. This is optional, and is only intended for testing.
Technical details
This module has a configuration file at Module:Shortcut/config. It can be used to translate this module into different languages or to change details like category names.