Difference between revisions of "Module:Shortcut/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>TheTVExpert
blackwiki>WOSlinker
m (change source to syntaxhighlight)
Line 14: Line 14:
 
To use this module from Lua, first load it.
 
To use this module from Lua, first load it.
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local mShortcut = require('Module:Shortcut')
 
local mShortcut = require('Module:Shortcut')
</source>
+
</syntaxhighlight>
  
 
Then you can create shortcut boxes with the following syntax:
 
Then you can create shortcut boxes with the following syntax:
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
mShortcut._main(shortcuts, options, frame, cfg)
 
mShortcut._main(shortcuts, options, frame, cfg)
</source>
+
</syntaxhighlight>
  
 
* <var>shortcuts</var> is an array of shortcut page names. (required)
 
* <var>shortcuts</var> is an array of shortcut page names. (required)

Revision as of 13:20, 7 July 2020

Script error: No such 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.