Module:Shortcut/doc: Difference between revisions
From Guild of Archivists
m (1 revision imported) |
mNo edit summary |
||
Line 1: | Line 1: | ||
This module makes a box showing the shortcut links to a page. | This module makes a box showing the shortcut links to a page. | ||
Line 12: | Line 11: | ||
To use this module from Lua, first load it. | To use this module from Lua, first load it. | ||
< | <code> | ||
local mShortcut = require('Module:Shortcut') | local mShortcut = require('Module:Shortcut') | ||
</ | </code> | ||
Then you can create shortcut boxes with the following syntax: | Then you can create shortcut boxes with the following syntax: | ||
< | <code> | ||
mShortcut._main(shortcuts, options, frame, cfg) | mShortcut._main(shortcuts, options, frame, cfg) | ||
</ | </code> | ||
* <var>shortcuts</var> is an array of shortcut page names. (required) | * <var>shortcuts</var> is an array of shortcut page names. (required) |
Latest revision as of 06:14, 20 January 2018
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.
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[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.