Module:Shortcut/doc - Revision history

FaeriMagic at 19:48, 31 July 2025

2025-07-31T19:48:50Z

← Older revision		Revision as of 19:48, 31 July 2025
Line 1:		Line 1:
	<includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly>		<includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly>
	{{~~Documentations~~ subpages\|Module documentation subpages}}		{{Documentation subpages\|Module documentation subpages}}
	{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}		{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}
	{{Uses TemplateStyles\|Module:Shortcut/styles.css}}		{{Uses TemplateStyles\|Module:Shortcut/styles.css}}

FaeriMagic at 19:48, 31 July 2025

2025-07-31T19:48:38Z

← Older revision		Revision as of 19:48, 31 July 2025
Line 1:		Line 1:
	<includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly>		<includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly>
			{{Documentations subpages\|Module documentation subpages}}
	{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}		{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}
	{{Uses TemplateStyles\|Module:Shortcut/styles.css}}		{{Uses TemplateStyles\|Module:Shortcut/styles.css}}
Line 36:		Line 37:

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	<!-- ~~Categories go here and interwikis go in Wikidata.~~ -->		<!-- MODULE CATEGORIES -->
			[[Category:Modules]] [[Category:Modules imported from Wikipedia]]
			}}</includeonly>

	}}</~~includeonly~~>		<noinclude>
			<!-- MODULE DOCUMENTATION SUBPAGE CATEGORY -->
			[[Category:Module documentation subpages imported from Wikipedia]]
			</noinclude>

FaeriMagic at 19:39, 31 July 2025

2025-07-31T19:39:29Z

← Older revision		Revision as of 19:39, 31 July 2025
Line 1:		Line 1:
	<includeonly style="text-align: right;">[[Module:Shortcut/doc]] →</includeonly>		<includeonly><div style="text-align: right;">[[Module:Shortcut/doc]] →</div></includeonly>
	{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}		{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}
	{{Uses TemplateStyles\|Module:Shortcut/styles.css}}		{{Uses TemplateStyles\|Module:Shortcut/styles.css}}

FaeriMagic at 19:38, 31 July 2025

2025-07-31T19:38:56Z

← Older revision		Revision as of 19:38, 31 July 2025
Line 1:		Line 1:
			<includeonly style="text-align: right;">[[Module:Shortcut/doc]] →</includeonly>
	{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}		{{Lua\|Module:Shortcut/config\|Module:List\|Module:Yesno\|Module:Arguments}}
	{{Uses TemplateStyles\|Module:Shortcut/styles.css}}		{{Uses TemplateStyles\|Module:Shortcut/styles.css}}
Line 5:		Line 6:

	== Usage ==		== Usage ==

	=== From wikitext ===		=== From wikitext ===

FaeriMagic: Created page with "{{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} {{Uses TemplateStyles|Module:Shortcut/styles.css}} {{Lua sidebar}} 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 `{{#invoke:shortcut|main|''argum..."`


2025-07-31T19:30:03Z
Created page with "{{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}} {{Uses TemplateStyles|Module:Shortcut/styles.css}} {{Lua sidebar}} 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|main|</nowiki>''argum..."
New page
{{Lua|Module:Shortcut/config|Module:List|Module:Yesno|Module:Arguments}}

{{Uses TemplateStyles|Module:Shortcut/styles.css}}

{{Lua sidebar}}

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|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> is a frame object. This is optional, and only intended to be used internally.

* <var>cfg</var> is 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.



<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

<!-- Categories go here and interwikis go in Wikidata. -->



}}</includeonly>