Module:Shortcut/doc: Difference between revisions
FaeriMagic (talk | contribs) mNo edit summary |
FaeriMagic (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
<includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly> | <includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly> | ||
{{Documentations subpages|Module documentation subpages}} | |||
{{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 36: | Line 37: | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- | <!-- MODULE CATEGORIES --> | ||
[[Category:Modules]] [[Category:Modules imported from Wikipedia]] | |||
}}</includeonly> | |||
<noinclude> | |||
<!-- MODULE DOCUMENTATION SUBPAGE CATEGORY --> | |||
[[Category:Module documentation subpages imported from Wikipedia]] | |||
</noinclude> | |||
Revision as of 19:48, 31 July 2025
Template:Documentations subpages Lua error in package.lua at line 80: module 'Module:Message box/configuration' not found. Lua error in package.lua at line 80: module 'Module:TNT' not found. Lua error in package.lua at line 80: module 'Module:Sidebar/configuration' not found. 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.
<syntaxhighlight lang="lua"> local mShortcut = require('Module:Shortcut') </syntaxhighlight>
Then you can create shortcut boxes with the following syntax:
<syntaxhighlight lang="lua"> mShortcut._main(shortcuts, options, frame, cfg) </syntaxhighlight>
- 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.