Template:Unbulleted list/doc: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 15:14, 19 July 2020

This is a documentation subpage for Template:Unbulleted list.
It contains usage information, categories and other content that is not part of the original template page.

Warning

This template is used on approximately 770,000 pages, or roughly 22965% of all pages
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

REDIRECT Template:Template shortcut

Template:R an

File:Lua-logo-nolabel.svg

This template uses Lua:

Module:List

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

Usage

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

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

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

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.

Wrapping this entire template with {{nowrap}} causes syntax errors. Use |class=nowrap instead.

Technical details

{{Unbulleted list}} works by constructing a div with the CSS class "plainlist" which has the following style (see MediaWiki:Common.css):

.plainlist ul {
    line-height: inherit;
    list-style: none none;
    margin: 0;
}
.plainlist ul li {
    margin-bottom: 0;
}

Wikitext

Expanded template

HTML

{{Unbulleted list
| Example 1
| Example 2
| Example 3
}}

<div class="plainlist"><ul><li>Example 1</li><li>Example 2</li><li>Example 3</li></ul></div>

<div class="plainlist">
<ul>
<li>Example 1</li>
<li>Example 2</li>
<li>Example 3</li>
</ul>
</div>

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
+<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+{{High-use| 635585 }}
+{{Template shortcuts|ubl|ubt|ublist|unbullet}}
+{{stack|{{Lua|Module:List}}}}
+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.
+== Usage ==
-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.
+'''Basic usage'''
-== Syntax ==
+{{pre2|<nowiki>{{</nowiki>unbulleted list<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>...<nowiki>}}</nowiki>}}
-;Simple
-:{{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}}
+'''All parameters'''
-{| class="wikitable"
+{{pre2|
-|+ Parameters' description
+<nowiki>{{</nowiki>unbulleted list
-|-
+<nowiki>|</nowiki>''first item''<nowiki>|</nowiki>''second item''<nowiki>|</nowiki>''third item''<nowiki>|</nowiki>...
-! Paramter !! Description
+<nowiki>|class     = </nowiki>''class''
-|-
+<nowiki>|style     = </nowiki>''style''
-| {{nowrap|entry1 ... entry50}}
+<nowiki>|list_style  = </nowiki>''style for ul tag''
-| 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>|item_style  = </nowiki>''style for all li tags''
-|-
+<nowiki>|item1_style = </nowiki>''style for first li tag''<nowiki> |item2_style = </nowiki>''style for second li tag''<nowiki> |</nowiki>...
-| {{nowrap|CSS1 ... CSS50}}
+<nowiki>}}</nowiki>
-| Standard [[Cascading Style Sheet]] (CSS) styles that change the look of each line. (User must know CSS syntax.)
+}}
-|-
-| CSS-all
-| Standard CSS styles that change the look of all entries. (User must know CSS syntax.) When present, ''CSS1'' through ''CSS5'' are disregarded.
-|}
-== Example ==
+=== 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 ===
 {| class="wikitable"
-! Code !! Result
+! style="width: 80%;" | Code !! Result
 |-
-| <code><nowiki>{{Unbulleted list|entry1|entry2|entry3|entry4|entry5|entry6|entry7|entry8|entry9}}</nowiki></code>
+| <code><nowiki>{{Unbulleted list|entry1|entry2|entry3|entry4|entry5</nowiki>{{wbr}}<nowiki>|entry6|entry7|entry8|entry9}}</nowiki></code>
 | {{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;}}
 |}
+=== Controlling line-breaking ===
-== Redirects ==
+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.
-* {{Tl|ubl}}
+Wrapping this entire template with {{tlx|nowrap}} causes syntax errors. Use {{para|class|nowrap}} instead.
+==Technical details==
+{{tl|Unbulleted list}} works by constructing a [[span and div|div]] with the [[Cascading Style Sheets|CSS]] class "plainlist" which has the following style (see [[MediaWiki:Common.css]]):
+<syntaxhighlight lang="css">
+.plainlist ul {
+    line-height: inherit;
+    list-style: none none;
+    margin: 0;
+}
+.plainlist ul li {
+    margin-bottom: 0;
+}
+</syntaxhighlight>
+{| class="wikitable"
+! Wikitext
+! Expanded template
+! HTML
+|- style="vertical-align:top;"
+| class="nowrap | <pre>
+{{Unbulleted list
+| Example 1
+| Example 2
+| Example 3
+}}
+</pre>
+| <syntaxhighlight lang="html">
+<div class="plainlist"><ul><li>Example 1</li><li>Example 2</li><li>Example 3</li></ul></div>
+</syntaxhighlight>
+| class="nowrap | <syntaxhighlight lang="html">
+<div class="plainlist">
+<ul>
+<li>Example 1</li>
+<li>Example 2</li>
+<li>Example 3</li>
+</ul>
+</div>
+</syntaxhighlight>
+|}
 == See also ==
+* {{tl|plainlist}} – essentially the same but uses <code><nowiki>|* ... * ... * ...</nowiki></code> instead of <code><nowiki>| ... | ... | ...</nowiki></code>
-* {{tl|nowrap begin}}/{{tl|nowrap end}}
+* {{tl|flatlist}} and {{tl|hlist}} (replacements for comma- or dash-separated lists)
-* {{tl|plainlist}}
-* {{tl|multi-column numbered list}}
+* {{tl|bulleted list}}
-* {{tl|pagelist}}
+* {{tl|ordered list}}
+{{Navbox lists}}
-<includeonly>
+<includeonly>{{Sandbox other||
-<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
-[[Category:Wikipedia list formatting templates]]
+[[Category:List formatting and function templates]]
+[[Category:Semantic markup templates]]
+}}</includeonly>
-[[ar:قالب:Unbulleted list]]
-[[es:Plantilla:Lista sin viñetas]]
-[[mk:Шаблон:Список без потточки]]
-[[ja:Template:Unbulleted list]]
-[[ru:Шаблон:Unbulleted list]]
-[[sl:Predloga:Unbulleted list]]
-[[ur:Template:Unbulleted list]]
-</includeonly>

Navigation menu

Personal tools

Search

Video Credit Archive

Navigation

Tools

Namespaces

Views