Module:Shortcut/doc
From Wikipedia, the free encyclopedia
Page Module:Message box/ombox.css has no content.
| icon | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original module page. |
- REDIRECT Template:Template rating
Template:Redirect category shell Script error: No such module "High-use".
Page Module:Message box/ombox.css has no content.
| File:Lua-Logo.svg | This module depends on the following other modules: |
Template:Uses TemplateStyles Template: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 Template:Tl. 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.
