Module:Shortcut/doc: Difference between revisions
Content deleted Content added
No edit summary Tags: Reverted Mobile edit Mobile web edit |
Reverting edit(s) by 51.252.179.149 (talk) to rev. 1238706582 by Dragoniez: non-constructive (RW 16.1) |
||
| Line 5: | Line 5: | ||
{{Lua sidebar}} |
{{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. |
||
== 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> 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 == |
== Technical details == |
||
Latest revision as of 23:16, 4 December 2024
 | This Lua module is used on approximately 26,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
| Related pages |
|---|
This module makes a box showing the shortcut links to a page.
Usage
[edit]From wikitext
[edit]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
[edit]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 is a frame object. This is optional, and only intended to be used internally.
- cfg is a table of config values. This is optional, and is only intended for testing.
Technical details
[edit]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.