Module:Wp/wal/Shortcut/doc

This is the documentation page for Module:Wp/wal/Shortcut

Error: {{Wp/wal/Module rating}} must be placed in the Module namespace.

TemplateStyles' src attribute must not be empty.

This Lua module is used on many 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.

Lua error in package.lua at line 80: module 'Module:List' not found.

TemplateStyles' src attribute must not be empty.

This module uses TemplateStyles:

Module:Wp/wal/Shortcut/styles.css

Template:Wp/wal/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 {{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:Wp/wal/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:Wp/wal/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:Wp/wal/Shortcut/config. It can be used to translate this module into different languages or to change details like category names.