Module:Shortcut/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Documentation subpage}} {{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} {{Uses TemplateStyles|Module:Shortcut/styles.css}} __NOTOC__ 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|m...") |
mNo edit summary |
||
| Line 9: | Line 9: | ||
=== From wikitext === | === 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 | 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>{{((}}#invoke:shortcut|main|''arguments''{{))}}</code>. | ||
=== From Lua === | === From Lua === | ||
Revision as of 02:41, 12 June 2023
|
It contains usage information, categories and other content that is not part of the original module page.
|
|---|
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
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.