Difference between revisions of "Module:Shortcut/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (add placeholder documentation) |
blackwiki>Mr. Stradivarius (expand) |
||
| Line 1: | Line 1: | ||
| − | This module | + | 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 {{tl|shortcut}}. Please see the template page for documentation. However, it can also be called using the syntax <code><nowiki>{{#invoke:shortcut|main|</nowiki>''arguments''<nowiki>}}</nowiki></code>. | ||
| + | |||
| + | === From Lua === | ||
| + | |||
| + | To use this module from Lua, first load it. | ||
| + | |||
| + | <source lang="lua"> | ||
| + | local mShortcut = require('Module:Shortcut') | ||
| + | </source> | ||
| + | |||
| + | Then you can create shortcut boxes with the following syntax: | ||
| + | |||
| + | <source lang="lua"> | ||
| + | mShortcut._main(shortcuts, options, frame, cfg) | ||
| + | </source> | ||
| + | |||
| + | * <var>shortcuts</var> is an array of shortcut page names. (required) | ||
| + | * <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. | ||
| + | * <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. | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
Revision as of 13:09, 15 December 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.
- 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.