Module:Shortcut/doc: Difference between revisions

Revision as of 11:38, 17 December 2014

Latest revision as of 23:16, 4 December 2024

(23 intermediate revisions by 19 users not shown)

Line 1:

{{Module rating|protected}}

{{High-use|demo=Module:{{ROOTPAGENAME}}}}

{{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}}

{{Uses TemplateStyles|Module:Shortcut/styles.css}}

{{Lua sidebar}}

This module makes a box showing the shortcut links to a page.

Line 11 ⟶ 16:

To use this module from Lua, first load it.

<sourcesyntaxhighlight lang="lua">

local mShortcut = require('Module:Shortcut')

</syntaxhighlight>

</source>

Then you can create shortcut boxes with the following syntax:

<sourcesyntaxhighlight lang="lua">

mShortcut._main(shortcuts, options, frame, cfg)

</syntaxhighlight>

</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.

** <code>nocatcategory</code> - if set to truefalse (or a value regarded as truefalse by [[Module:Yesno]], such as "no"), categories are suppressed.

* <var>frame</var> is a frame object. This is optional, and only intended to be used internally.

* <var>cfg</var> is a table of config values. This is optional, and is only intended for testing.

== Technical details ==