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

From Ava Zinn Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
(Redirects)
 
(22 intermediate revisions by 13 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{High-risk|220,000+}}
 +
{{Template shortcuts|ubl|ubt|ublist|unbullet}}
 +
{{stack|{{Lua|Module:List}}}}
 +
<!------PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE------>
 +
This template creates [[WP:UBLIST|unbulleted lists]]. Each item in the list may have [[CSS]] styles added to it individually, by appending a numbered parameter.
  
This template creates [[WP:UBLIST|unbulleted lists]]. Up to 50 entries are supported. Each item in the list may have [[CSS]] styles added to it individually, by appending a numbered parameter. The parameter <tt>li_style1</tt> formats the first item, <tt>li_style2</tt> the second, and so on.
+
== Usage ==
  
== Syntax ==
+
; Basic usage
;Simple
+
{{pre2|<nowiki>{{</nowiki>unbulleted list<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>...<nowiki>}}</nowiki>}}
:{{tld|Unbulleted list |''entry1'' |''entry2'' ... |''entry50''|allowlinebreak=yes}}
 
;With CSS style
 
:{{tld|Unbulleted list |''entry1'' |''entry2'' ... |''entry50'' |li_style{{=}}''CSS-all''|allowlinebreak=yes}}
 
;With separate CSS styles for each item
 
:{{tld|Unbulleted list |''entry1'' |''entry2'' ... |''entry50'' |li_style1{{=}}''CSS1'' |li_style2{{=}}''CSS2'' ... |li_style50{{=}}''CSS50''|allowlinebreak=yes}}
 
  
{| class="wikitable"
+
; All parameters
|+ Parameters' description
+
{{pre2|
|-
+
<nowiki>{{</nowiki>unbulleted list
! Paramter !! Description
+
<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>...
|-
+
<nowiki>|class     = </nowiki>''class''
| {{nowrap|entry1 ... entry50}}
+
<nowiki>|style    = </nowiki>''style''
| These unnamed parameters are individual list items that appear as separate lines. They can be words or full sentences. However, all instance of equal sign (=) must be replaced with "<nowiki>{{=}}</nowiki>"; otherwise, the affected line will not appear.
+
<nowiki>|list_style  = </nowiki>''style for ul tag''
|-
+
<nowiki>|item_style  = </nowiki>''style for all li tags''
| {{nowrap|CSS1 ... CSS50}}
+
<nowiki>|item1_style = </nowiki>''style for first li tag''<nowiki> |item2_style = </nowiki>''style for second li tag''<nowiki> |</nowiki>...
| Standard [[Cascading Style Sheet]] (CSS) styles that change the look of each line. (User must know CSS syntax.)
+
<nowiki>}}</nowiki>
|-
+
}}
| CSS-all
+
 
| Standard CSS styles that change the look of all entries. (User must know CSS syntax.) When present, ''CSS1'' through ''CSS5'' are disregarded.
+
=== 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 {{tag|ul}} tags around the list. 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 ==
+
=== Example ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code !! Result
 
! Code !! Result
Line 34: Line 39:
 
| {{Unbulleted list|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
 
| {{Unbulleted list|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}
 
|-
 
|-
| <code><nowiki>{{Unbulleted list|Winner|Runner-up|Third place|li_style=color:blue;}}</nowiki></code>
+
| <code><nowiki>{{Unbulleted list|Winner|Runner-up|Third place|item_style=color:blue;}}</nowiki></code>
| {{Unbulleted list|Winner|Runner-up|Third place|li_style=color:blue;}}
+
| {{Unbulleted list|Winner|Runner-up|Third place|item_style=color:blue;}}
 
|-
 
|-
| <code><nowiki>{{Unbulleted list|Winner|Runner-up|Third place|li_style1=background-color:yellow;|li_style2=background-color:silver;}}</nowiki></code>
+
| <code><nowiki>{{Unbulleted list|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}}</nowiki></code>
| {{Unbulleted list|Winner|Runner-up|Third place|li_style1=background-color:yellow;|li_style2=background-color:silver;}}
+
| {{Unbulleted list|Winner|Runner-up|Third place|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
 
|}
 
|}
  
== Redirects ==
+
=== Controlling line-breaking ===
The following redirect here:
+
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.
* {{Tlc|Col}}
 
* {{Tlc|Ubl}}
 
* {{Tlc|Ubt}}
 
* {{Tlc|Unbullet}}
 
* {{Tlc|Vlist}}
 
  
 
== See also ==
 
== See also ==
* {{tl|nowrap begin}}/{{tl|nowrap end}}
 
 
* {{tl|plainlist}}
 
* {{tl|plainlist}}
* {{tl|multi-column numbered list}}
+
* {{tl|flatlist}} and {{tl|hlist}}
 +
* {{tl|ordered list}} and {{tl|unordered list}}
 +
* {{tl|nowrap}}
 
* {{tl|pagelist}}
 
* {{tl|pagelist}}
  
 
<includeonly>
 
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
{{#ifeq:{{PAGENAME}}|{{BASEPAGENAME}} |
[[Category:Wikipedia list formatting templates]]
+
<!------CATEGORIES BELOW THIS LINE, PLEASE:-------->
 
+
[[Category:List formatting and function templates]]
[[ar:قالب:Unbulleted list]]
+
[[Category:Semantic markup templates]]
[[bn:টেমপ্লেট:Unbulleted list]]
+
}}
[[bs:Šablon:Unbulleted list]]
 
[[es:Plantilla:Lista sin viñetas]]
 
[[mk:Шаблон:Список без потточки]]
 
[[ja:Template:Unbulleted list]]
 
[[ru:Шаблон:Unbulleted list]]
 
[[sl:Predloga:Unbulleted list]]
 
[[fi:Malline:Unbulleted list]]
 
[[ur:Template:Unbulleted list]]
 
[[uk:Шаблон:Unbulleted list]]
 
 
</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]