Difference between revisions of "Template:Unbulleted list/doc"

From Ava Zinn Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
(Parameters: hyphens → en dash; caps: css → CSS)
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{High-risk|220,000+}}
 
{{Template shortcuts|ubl|ubt|ublist|unbullet}}
 
{{Template shortcuts|ubl|ubt|ublist|unbullet}}
 
{{stack|{{Lua|Module:List}}}}
 
{{stack|{{Lua|Module:List}}}}
Line 22: Line 23:
 
}}
 
}}
  
== Parameters ==
+
=== 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.
 
* 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.
Line 31: Line 32:
 
* <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.
 
* <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 ==
+
=== Example ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code !! Result
 
! Code !! Result
Line 44: Line 45:
 
| {{Unbulleted list|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
 
| {{Unbulleted list|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
 
|}
 
|}
 +
 +
=== Controlling line-breaking ===
 +
Template {{tlx|nbsp}} may be used with {{tlx|wbr}} and {{tlx|nowrap}} to control line-breaking in bulletless lists, to prevent wrapped long entries from being confused with multiple entries. See [[Template:Wbr/doc#Controlling line-breaking in infoboxes]] for details.
  
 
== See also ==
 
== See also ==
Line 55: Line 59:
 
{{#ifeq:{{PAGENAME}}|{{BASEPAGENAME}} |
 
{{#ifeq:{{PAGENAME}}|{{BASEPAGENAME}} |
 
<!------CATEGORIES BELOW THIS LINE, PLEASE:-------->
 
<!------CATEGORIES BELOW THIS LINE, PLEASE:-------->
[[Category:Wikipedia list formatting templates]]
+
[[Category:List formatting and function templates]]
 +
[[Category:Semantic markup templates]]
 
}}
 
}}
 
</includeonly>
 
</includeonly>

Latest revision as of 06:25, 15 March 2016

Gnome-utilities-terminal.svg This template uses (or will be using) Lua programming language.

Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates.

This template creates unbulleted lists. Each item in the list may have CSS styles added to it individually, by appending a numbered parameter.

Usage[edit]

Basic usage
{{unbulleted list|first item|second item|third item|...}}
All parameters
{{unbulleted list
|first item|second item|third item|...
|class     = class
|style     = style
|list_style  = style for ul tag
|item_style  = style for all li tags
|item1_style = style for first li tag |item2_style = style for second li tag |...
}}

Parameters[edit]

  • Positional parameters (1, 2, 3...) – these are the list items. If no list items are present, the module will output nothing.
  • class – a custom class for the <div>...</div> tags surrounding the list, e.g. plainlinks.
  • style – a custom CSS style for the <div>...</div> tags surrounding the list, e.g. font-size: 90%;.
  • list_style – a custom CSS style for the <ul>...</ul> tags around the list. The format is the same as for the |style= parameter.
  • item_style – a custom CSS style for all of the list items (the <li>...</li> tags). The format is the same as for the |style= parameter.
  • item1_style, item2_style, item3_style... – custom CSS styles for each of the list items. The format is the same as for the |style= parameter.

Example[edit]

Code Result
{{Unbulleted list|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
  • entry1
  • entry2
  • entry3
  • entry4
  • entry5
  • entry6
  • entry7
  • entry8
  • entry9
{{Unbulleted list|Winner|Runner-up|Third place|item_style=color:blue;}}
  • Winner
  • Runner-up
  • Third place
{{Unbulleted list|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • Winner
  • Runner-up
  • Third place

Controlling line-breaking[edit]

Template {{nbsp}} may be used with {{wbr}} and {{nowrap}} to control line-breaking in bulletless lists, to prevent wrapped long entries from being confused with multiple entries. See Template:Wbr/doc#Controlling line-breaking in infoboxes for details.

See also[edit]