Module:Shortcut/doc

From RimWorld Wiki
< Module:Shortcut
Revision as of 20:09, 15 July 2024 by Arcangelus (talk | contribs) (Created page with "Taken from: https://en.wikipedia.org/w/index.php?title=Module%3AShortcut%2Fdoc&action=edit {{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} This modu...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is the documentation page for Module:Shortcut

Taken from: https://en.wikipedia.org/w/index.php?title=Module%3AShortcut%2Fdoc&action=edit


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 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.