Module:Navbox/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
mNo edit summary
Ganaram inukshuk (talk | contribs)
mNo edit summary
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{dochead|header='''Note:''' While this module should not be invoked directly, the use of its corresponding template ([[Template:Navbox]]) is not absolutely necessary.
{{documentation|{{dochead|header=metatemplate}}
<p>'''Module:Navbox''' is a {{w|wp:lua|module}} that implements the {{tlx|Navbox}} template. Navbox templates can be made by using the template or by calling the <code>_navbox</code> function from another module.</p>


On templates that use or generate navigation boxes, you can call the <code>_navbox</code> (note the underscore in front) helper function. The wrapper function (<code>navbar</code> without the underscore in front) is used by the template.
On templates, you can create a navbox by using <code><nowiki>{{Navbox}}</nowiki></code>, which calls this module's wrapper function.


On modules, you can include <syntaxhighlight inline lang="lua">local navbox = require("Module:Navbox")._navbox</syntaxhighlight> at or near the top.}}
On modules, you can include <syntaxhighlight inline lang="lua">local navbox = require("Module:Navbox")._navbox</syntaxhighlight> to create a navbox.{{clear}}
{{todo|inline=1| Documentation}}


=== See also ===
{{module introspection}}
* [[:Module:Navbar]]
}}

Latest revision as of 22:48, 30 October 2025

This module implements a metatemplate, and may be invoked by templates using its corresponding template Template:Navbox, or used directly from other modules.

Module:Navbox is a module that implements the {{Navbox}} template. Navbox templates can be made by using the template or by calling the _navbox function from another module.

On templates, you can create a navbox by using {{Navbox}}, which calls this module's wrapper function.

On modules, you can include local navbox = require("Module:Navbox")._navbox to create a navbox.

To see introspection summary, see this module's main page.