Module:Shortcut/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 17:24, 28 March 2023

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:

Module:Shortcut/styles.css (sandbox)

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.

@@ Line 1: / Line 1: @@
+{{Module rating|protected}}
-@ตราแผ่นดินประเทศอังกฤษกรุงลอนดอนหายไป+การปฏวัติอุตสาหกรรมครั้งที่๑£{สกุลเงินอัตราแลกเปลี่ยนทางการค้า+น้ำมัOPEC(โอเป็ค)+สงครามโลกครั้งที่๑(หนึ่งจำนวนนับลำดับที่)+{{Module rating|protected}}
 {{High-use|demo=Module:{{ROOTPAGENAME}}}}
 {{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}}