Module:Infobox/doc: Difference between revisions

(14 intermediate revisions by 2 users not shown)

Line 1:

{{documentation|

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

~~{{lua|arguments|yesno}}~~{{dochead|header='''~~Note~~:''' ~~While this~~ module ~~should not~~ be ~~invoked directly,~~ the ~~use of its corresponding~~ template ~~([[Template:Infobox]]) is not absolutely necessary~~.

<p>'''Module:Infobox''' is a {{w|wp:lua|module}} that implements the {{tlx|Infobox}} template. Infobox templates can be made by using the template or by calling the <code>_sidebar</code> function from another module.</p>

On ~~other~~ templates ~~that use or generate infoboxes~~, you can ~~call~~ <code>~~_infobox~~<~~/code~~> ~~(note the underscore in front). The~~ <~~code~~>~~infobox~~</code> function ~~(without the underscore) is used by [[Template:Infobox]] as a wrapper~~.

On templates, you can create an infobox by using <code><nowiki>{{Infobox}}</nowiki></code>, which calls this module's wrapper function.

On ~~other~~ modules, you can include <syntaxhighlight inline lang{{=}}"lua">local infobox = require("Module:Infobox")._infobox</syntaxhighlight> ~~at or near the top~~.}}

On modules, you can include <syntaxhighlight inline lang="lua">local infobox= require("Module:Infobox")._infobox</syntaxhighlight> to create an infobox.{{clear}}

~~<p>'''Module:Infobox''' is a~~ {{~~w|wp:lua|~~module~~}} that implements the {{tlx|Infobox}} template. Please see the template page for usage instructions.</p>{{clear~~}}

}}

@@ Line 1: / Line 1: @@
-{{documentation|
+{{documentation|{{dochead|header=metatemplate}}
-{{lua|arguments|yesno}}{{dochead|header='''Note:''' While this module should not be invoked directly, the use of its corresponding template ([[Template:Infobox]]) is not absolutely necessary.
+<p>'''Module:Infobox''' is a {{w|wp:lua|module}} that implements the {{tlx|Infobox}} template. Infobox templates can be made by using the template or by calling the <code>_sidebar</code> function from another module.</p>
-On other templates that use or generate infoboxes, you can call <code>_infobox</code> (note the underscore in front). The <code>infobox</code> function (without the underscore) is used by [[Template:Infobox]] as a wrapper.
+On templates, you can create an infobox by using <code><nowiki>{{Infobox}}</nowiki></code>, which calls this module's wrapper function.
-On other modules, you can include <syntaxhighlight inline lang{{=}}"lua">local infobox = require("Module:Infobox")._infobox</syntaxhighlight> at or near the top.}}
+On modules, you can include <syntaxhighlight inline lang="lua">local infobox= require("Module:Infobox")._infobox</syntaxhighlight> to create an infobox.{{clear}}
-<p>'''Module:Infobox''' is a {{w|wp:lua|module}} that implements the {{tlx|Infobox}} template. Please see the template page for usage instructions.</p>{{clear}}
+{{module introspection}}
 }}