Module:Shortcut/doc

This is the documentation page for Module:Shortcut

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.

<source lang="lua"> local mShortcut = require('Module:Shortcut') </source>

Then you can create shortcut boxes with the following syntax:

<source lang="lua"> mShortcut._main(shortcuts, options, frame, cfg) </source>

• 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 a frame object. This is optional, and only intended to be used internally.
• cfg 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.