Module:Navbox/doc: Difference between revisions

(7 intermediate revisions by the same user not shown)

Line 1:

{{documentation|

{{documentation|{{dochead|header=metatemplate}}

{{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~~}}

<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 ~~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 templates, you can create a navbox by using <code><nowiki>{{Navbox}}</nowiki></code>, which calls this module's wrapper function.

On ~~other~~ 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}}

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

~~=== See also ===~~

* [[Module:Navbar]]

}}

@@ Line 1: / Line 1: @@
-{{documentation|
+{{documentation|{{dochead|header=metatemplate}}
-{{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}}
+<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 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 templates, you can create a navbox by using <code><nowiki>{{Navbox}}</nowiki></code>, which calls this module's wrapper function.
-On other 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}}
-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.
+{{module introspection}}
-=== See also ===
-* [[Module:Navbar]]
 }}