Module:Shortcut/doc: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
(add technical details section) |
(update category suppression code) |
||
| Line 24: | Line 24: | ||
* <var>options</var> is a table of options. The following keys are supported: |
* <var>options</var> is a table of options. The following keys are supported: |
||
** <code>msg</code> - a message to leave after the list of shortcuts. |
** <code>msg</code> - a message to leave after the list of shortcuts. |
||
** <code> |
** <code>category</code> - if set to false (or a value regarded as false by [[Module:Yesno]], such as "no"), categories are suppressed. |
||
* <var>frame</var> a frame object. This is optional, and only intended to be used internally. |
* <var>frame</var> a frame object. This is optional, and only intended to be used internally. |
||
* <var>cfg</var> a table of config values. This is optional, and is only intended for testing. |
* <var>cfg</var> a table of config values. This is optional, and is only intended for testing. |
||
Revision as of 12:20, December 17, 2014
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: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.
