Module:Shortcut/doc
From Wikipedia, the free encyclopedia
icon This is a documentation subpage for Module:Shortcut.
It may contain usage information, categories and other content that is not part of the original module page.
It may contain usage information, categories and other content that is not part of the original module page.
This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
Warning This Lua module is used on approximately 27,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:
| Related pages |
|---|
This module makes a box showing the shortcut links to a page.
Usage
[edit ]From wikitext
[edit ]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
[edit ]To use this module from Lua, first load it.
localmShortcut=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
[edit ]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.