View source for Module:Shortcut/doc

{{Module rating|protected}}
{{Uses TemplateStyles|Template:Shortcut/styles.css}}
{{Lua sidebar}}
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.

<syntaxhighlight lang="lua">
local mShortcut = require('Module:Shortcut')
</syntaxhighlight>

Then you can create shortcut boxes with the following syntax:

<syntaxhighlight lang="lua">
mShortcut._main(shortcuts, options, frame, cfg)
</syntaxhighlight>

* <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.
** <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>cfg</var> 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.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>