Difference between revisions of "Module:Shortcut/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (add technical details section) |
m (17 revisions imported) |
||
| (13 intermediate revisions by 12 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Module rating|protected}} | ||
| + | {{Uses TemplateStyles|Template:Shortcut/styles.css}} | ||
| + | {{Lua sidebar}} | ||
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 11: | Line 14: | ||
To use this module from Lua, first load it. | To use this module from Lua, first load it. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local mShortcut = require('Module:Shortcut') | local mShortcut = require('Module:Shortcut') | ||
| − | </ | + | </syntaxhighlight> |
Then you can create shortcut boxes with the following syntax: | Then you can create shortcut boxes with the following syntax: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mShortcut._main(shortcuts, options, frame, cfg) | mShortcut._main(shortcuts, options, frame, cfg) | ||
| − | </ | + | </syntaxhighlight> |
* <var>shortcuts</var> is an array of shortcut page names. (required) | * <var>shortcuts</var> is an array of shortcut page names. (required) | ||
* <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. | ||
Latest revision as of 07:17, 28 September 2020
| 40x40px | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
Script error: No such module "Uses TemplateStyles".
| Related pages |
|---|
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.