Module:Navbox/doc: Difference between revisions

(10 intermediate revisions by 2 users not shown)

Line 1:

{{dochead|header='''Note:''' ~~This~~ module ~~is mainly used by~~ [[Template:Navbox]]~~, but its use~~ is not absolutely necessary.

{{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 templates you can call ~~the~~ <code>_navbox</code> (note the underscore in front) ~~helper~~ function.

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 modules you can include <syntaxhighlight inline lang="lua">local navbox = require("Module:Navbox")._navbox</syntaxhighlight>

at or near the top.}}

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

* [[Module:Navbar]]

}}

@@ Line 1: / Line 1: @@
-{{dochead|header='''Note:''' This module is mainly used by [[Template:Navbox]], but its use is not absolutely necessary.
+{{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 templates you can call the <code>_navbox</code> (note the underscore in front) helper function.
+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 modules you can include <syntaxhighlight inline lang="lua">local navbox = require("Module:Navbox")._navbox</syntaxhighlight>
-at or near the top.}}
+On other modules, you can include <syntaxhighlight inline lang="lua">local navbox = require("Module:Navbox")._navbox</syntaxhighlight> at or near the top.
-{{todo|inline=1| Documentation}}
+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]]
+* [[Module:Navbar]]
+}}