Difference between revisions of "Module:Shortcut/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>MrOllie
m (Reverted 1 edit by Tigenploy (talk) to last revision by WOSlinker (TW))
Line 9: Line 9:
  
 
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 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 ==
 
== Technical details ==

Revision as of 13:59, 23 September 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}}.

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.