Template:Bulleted list/doc: Difference between revisions

Line 1:

== Usage ~~& preview~~ ==

<~~pre~~>

{{~~Bulleted~~ list

{{Template shortcuts|clear=right|blist|bulleted|ulist|unordered list}}

|~~1 =~~

|2 =

This template may be used to generate a [[bulleted list]] in similar vein to [[HTML]]'s [[HTML element|{{tag|ul}} list]]. A typical application is within captions, where the equivalent [[wiki markup]] (asterisks at the starts of new lines) may be awkward or impossible to use.

|3 =

}}

== Usage ==

:<code><nowiki>{{bulleted list |item1 |item2 |...}}</nowiki></code>

== Parameters ==

* Positional parameters (<code>1</code>, <code>2</code>, <code>3</code>...) - these are the list items. If no list items are present, the module will output nothing.

* <code>class</code> - a custom class for the {{tag|div}} tags surrounding the list, e.g. <code>plainlinks</code>.

* <code>style</code> - a custom css style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>.

* <code>list_style</code> - a custom css style for the list itself. The format is the same as for the {{para|style}} parameter.

* <code>item_style</code> - a custom css style for all of the list items (the {{tag|li}} tags). The format is the same as for the {{para|style}} parameter.

* <code>item1_style</code>, <code>item2_style</code>, <code>item3_style</code>... - custom css styles for each of the list items. The format is the same as for the {{para|style}} parameter.

== Example ==

[[File:Example.png|thumb|100px|{{bulleted list |one |two |three}}]]

[[File:Example.png|thumb|100px|{{bulleted list |one |two |three}}]]

</pre>

== See also ==

* {{tl|unbulleted list}}{{\}}{{tl|plainlist}}, templates producing vertical lists without prefixes (e.g. without bullets, other shapes, numbering).

* {{tl|ordered list}}, a template producing a vertical list whose items are prefixed by incremental numbers or letters.

* {{tl|hlist}}{{\}}{{tl|flatlist}}, templates producing horizontal lists (strings of items separated by [[interpunct]]s).

~~to see this:~~

~~{{Bulleted list~~

~~|1 = Bugs Bunny~~

[[Category:List formatting and function templates]]

~~|2 = Daffy Duck~~

</includeonly>

~~|3 = Tweety Bird~~

}}

@@ Line 1: / Line 1: @@
-== Usage & preview ==
+{{Documentation subpage}}
-<pre>
+{{Lua|Module:List}}
-{{Bulleted list
+{{Template shortcuts|clear=right|blist|bulleted|ulist|unordered list}}
-|1 =
+<!-----Categories at the bottom of this page, please; interwikis to Wikidata----->
-|2 =
+This template may be used to generate a [[bulleted list]] in similar vein to [[HTML]]'s [[HTML element|{{tag|ul}} list]]. A typical application is within captions, where the equivalent [[wiki markup]] (asterisks at the starts of new lines) may be awkward or impossible to use.
-|3 =
-}}
+{{TOC right}}
+== Usage ==
+:<code><nowiki>{{bulleted list |item1 |item2 |...}}</nowiki></code>
+== Parameters ==
+* Positional parameters (<code>1</code>, <code>2</code>, <code>3</code>...) - these are the list items. If no list items are present, the module will output nothing.
+* <code>class</code> - a custom class for the {{tag|div}} tags surrounding the list, e.g. <code>plainlinks</code>.
+* <code>style</code> - a custom css style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>.
+* <code>list_style</code> - a custom css style for the list itself. The format is the same as for the {{para|style}} parameter.
+* <code>item_style</code> - a custom css style for all of the list items (the {{tag|li}} tags). The format is the same as for the {{para|style}} parameter.
+* <code>item1_style</code>, <code>item2_style</code>, <code>item3_style</code>... - custom css styles for each of the list items. The format is the same as for the {{para|style}} parameter.
+== Example ==
+[[File:Example.png|thumb|100px|{{bulleted list |one |two |three}}]]
+<pre style="overflow:auto;">
+[[File:Example.png|thumb|100px|{{bulleted list |one |two |three}}]]
 </pre>
+{{clear right}}
+== See also ==
+* {{tl|unbulleted list}}{{\}}{{tl|plainlist}}, templates producing vertical lists without prefixes (e.g. without bullets, other shapes, numbering).
+* {{tl|ordered list}}, a template producing a vertical list whose items are prefixed by incremental numbers or letters.
+* {{tl|hlist}}{{\}}{{tl|flatlist}}, templates producing horizontal lists (strings of items separated by [[interpunct]]s).
-to see this:
+<includeonly>
-{{Bulleted list
+<!-- Categories go here, and interwikis go in Wikidata -->
-|1 = Bugs Bunny
+[[Category:List formatting and function templates]]
-|2 = Daffy Duck
+</includeonly>
-|3 = Tweety Bird
-}}