Module:Shortcut/doc

This is the documentation page for Module:Shortcut

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This Lua module is used on approximately 28,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Tɛmpileti:Uses TemplateStyles

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 {{[[Template:shortcut |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 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.