Module:Navbox/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
you're meant to use either the navbox template OR the _navbox function
ArrowHead294 (talk | contribs)
mNo edit summary
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{dochead|header=none}}
{{documentation|
{{todo|inline=1| Documentation}}
{{dochead|header='''Note:''' While this module should not be invoked directly, the use of its corresponding template ([[Template:Navbox]]) is not absolutely necessary.}}{{lua|Arguments|Navbar|Yesno}}
 
On other templates that use or generate navigation boxes, you can call <code>_navbox</code> (note the underscore in front). The <code>navbox</code> function (without the underscore) is used by [[Template:Navbox]] as a wrapper.
 
On other modules, you can include <syntaxhighlight inline lang="lua">local navbox = require("Module:Navbox")._navbox</syntaxhighlight> at or near the top.
 
This template allows a {{w|wp:navigational template|navigation box}} to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. The default styling for our navigation boxes is modelled off of [http://runescape.wiki/ RuneScape Wiki's] navigation box, instead of {{w|Template:Navbox|Wikipedia's}}.
 
=== See also ===
* [[Module:Navbar]]
}}

Latest revision as of 13:45, 19 May 2025

On other templates that use or generate navigation boxes, you can call _navbox (note the underscore in front). The navbox function (without the underscore) is used by Template:Navbox as a wrapper.

On other modules, you can include local navbox = require("Module:Navbox")._navbox at or near the top.

This template allows a navigation box to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. The default styling for our navigation boxes is modelled off of RuneScape Wiki's navigation box, instead of Wikipedia's.

See also