Module:List

Module documentation[view] [edit] [history] [purge]

This module outputs various kinds of lists. At present, it supports bulleted lists, unbulleted lists, horizontal lists, ordered lists (numbered or alphabetical), and horizontal ordered lists. It allows for easy css styling of the list or of the individual list items.

Usage

Quick usage

{{#invoke:list|function|first item|second item|third item|...}}

All parameters

{{#invoke:list|function
|first item|second item|third item|...
|start =start number for ordered lists
|type =type of numbering for ordered lists
|list_style_type =type of marker for ordered lists (uses CSS)
|class =class
|style =style
|list_style =style for the list
|item_style =style for all list items
|item1_style =style for the first list item|item2_style =style for the second list item|...
|item1_value =value for the first list item|item2_value =value for the second list item|...
|indent =indent for horizontal lists
}}

Arguments passed from parent template

{{#invoke:list|function}}

Functions

Function name	Produces	Example output	Template using the function
bulleted	Bulleted lists	First item Second item Third item	{{bulleted list}}
unbulleted	Unbulleted lists	First item Second item Third item	{{unbulleted list}}
horizontal	Horizontal bulleted lists	First item Second item Third item	{{hlist}}
ordered	Ordered lists (numbered lists and alphabetical lists)	First item Second item Third item	{{ordered list}}
horizontal_ordered	Horizontal ordered lists	First item Second item Third item	{{horizontal ordered list}}

Parameters

• Positional parameters (1,2,3...) - these are the list items. If no list items are present, the module will output nothing.
• start- sets the start item for ordered lists. This can be a start number for numbered lists, or a start letter for alphabetical lists. Horizontal ordered lists only support numbers.
• type- the type of marker used in ordered lists. Possible values are "1" for numbers (the default), "A" for uppercase letters, "a" for lowercase letters, "I" for uppercaseRoman numerals,and "i" for lowercase Roman numerals. Not supported in horizontal ordered lists. See also thelist_style_typeparameter.
• list_style_type- the type of marker used in ordered lists. This uses CSS styling, and has more types available than thetypeparameter, which uses anhtml attribute.Possible values are listed atMDN's list-style-type page.Support may vary by browser.list-style-typeis an alias for this parameter.
• 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 list itself. 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.
• item1_value,item2_value,item3_value... - custom value for the given list item. List items following the one given will increment from the specified value. The value should be a positive integer. (Note that this option only has an effect on ordered lists.)
• indent- this parameter indents the list, for horizontal and horizontal ordered lists only. The value must be a number, e.g.2.The indent is calculated inem,and is 1.6 times the value specified. If no indent is specified, the default is zero.

Examples

Bulleted lists

Code	Result
{{#invoke:list|bulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}}	First item Second item Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	First item Second item Third item

Unbulleted lists

Code	Result
{{#invoke:list|unbulleted|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}	First item Second item Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	First item Second item Third item

Horizontal lists

Code	Result
{{#invoke:list|horizontal|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}	First item Second item Third item

Ordered lists

Code	Result
{{#invoke:list|ordered|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|ordered|First item|Second item|Third item|start=3}}	First item Second item Third item
LowercaseRoman numerals:{{#invoke:list|ordered|First item|Second item|Third item|type=i}}	First item Second item Third item
LowercaseGreek alphabet:{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}	First item Second item Third item

Horizontal ordered lists

Code	Result
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}	First item Second item Third item
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}}	First item Second item Third item
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}	First item Second item Third item

Tracking/maintenance category

• Category:List templates with deprecated parameters(0)

See also

• Module:Separated entries

The abovedocumentationistranscludedfromModule:List/doc.(edit|history)
Editors can experiment in this module'ssandbox(edit|diff)andtestcases(edit|run)pages.
Subpages of this module.

locallibUtil=require('libraryUtil')
localcheckType=libUtil.checkType
localmTableTools=require('Module:TableTools')

localp={}

locallistTypes={
['bulleted']=true,
['unbulleted']=true,
['horizontal']=true,
['ordered']=true,
['horizontal_ordered']=true
}

functionp.makeListData(listType,args)
-- Constructs a data table to be passed to p.renderList.
localdata={}

-- Classes and TemplateStyles
data.classes={}
data.templatestyles=''
iflistType=='horizontal'orlistType=='horizontal_ordered'then
table.insert(data.classes,'hlist')
data.templatestyles=mw.getCurrentFrame():extensionTag{
name='templatestyles',args={src='Hlist/styles.css'}
}
elseiflistType=='unbulleted'then
table.insert(data.classes,'plainlist')
data.templatestyles=mw.getCurrentFrame():extensionTag{
name='templatestyles',args={src='Plainlist/styles.css'}
}
end
table.insert(data.classes,args.class)

-- Main div style
data.style=args.style

-- Indent for horizontal lists
iflistType=='horizontal'orlistType=='horizontal_ordered'then
localindent=tonumber(args.indent)
indent=indentandindent*1.6or0
ifindent>0then
data.marginLeft=indent..'em'
end
end

-- List style types for ordered lists
-- This could be "1, 2, 3", "a, b, c", or a number of others. The list style
-- type is either set by the "type" attribute or the "list-style-type" CSS
-- property.
iflistType=='ordered'orlistType=='horizontal_ordered'then
data.listStyleType=args.list_style_typeorargs['list-style-type']
data.type=args['type']

-- Detect invalid type attributes and attempt to convert them to
-- list-style-type CSS properties.
ifdata.type
andnotdata.listStyleType
andnottostring(data.type):find('^%s*[1AaIi]%s*$')
then
data.listStyleType=data.type
data.type=nil
end
end

-- List tag type
iflistType=='ordered'orlistType=='horizontal_ordered'then
data.listTag='ol'
else
data.listTag='ul'
end

-- Start number for ordered lists
data.start=args.start
iflistType=='horizontal_ordered'then
-- Apply fix to get start numbers working with horizontal ordered lists.
localstartNum=tonumber(data.start)
ifstartNumthen
data.counterReset='listitem '..tostring(startNum-1)
end
end

-- List style
-- ul_style and ol_style are included for backwards compatibility. No
-- distinction is made for ordered or unordered lists.
data.listStyle=args.list_style

-- List items
-- li_style is included for backwards compatibility. item_style was included
-- to be easier to understand for non-coders.
data.itemStyle=args.item_styleorargs.li_style
data.items={}
for_,numinipairs(mTableTools.numKeys(args))do
localitem={}
item.content=args[num]
item.style=args['item'..tostring(num)..'_style']
orargs['item_style'..tostring(num)]
item.value=args['item'..tostring(num)..'_value']
orargs['item_value'..tostring(num)]
table.insert(data.items,item)
end

returndata
end

functionp.renderList(data)
-- Renders the list HTML.

-- Return the blank string if there are no list items.
iftype(data.items)~='table'or#data.items<1then
return''
end

-- Render the main div tag.
localroot=mw.html.create('div')
for_,classinipairs(data.classesor{})do
root:addClass(class)
end
root:css{['margin-left']=data.marginLeft}
ifdata.stylethen
root:cssText(data.style)
end

-- Render the list tag.
locallist=root:tag(data.listTagor'ul')
list
:attr{start=data.start,type=data.type}
:css{
['counter-reset']=data.counterReset,
['list-style-type']=data.listStyleType
}
ifdata.listStylethen
list:cssText(data.listStyle)
end

-- Render the list items
for_,tinipairs(data.itemsor{})do
localitem=list:tag('li')
ifdata.itemStylethen
item:cssText(data.itemStyle)
end
ift.stylethen
item:cssText(t.style)
end
item
:attr{value=t.value}
:wikitext(t.content)
end

returndata.templatestyles..tostring(root)
end

functionp.renderTrackingCategories(args)
localisDeprecated=false-- Tracks deprecated parameters.
fork,vinpairs(args)do
k=tostring(k)
ifk:find('^item_style%d+$')ork:find('^item_value%d+$')then
isDeprecated=true
break
end
end
localret=''
ifisDeprecatedthen
ret=ret..'[[Category:List templates with deprecated parameters]]'
end
returnret
end

functionp.makeList(listType,args)
ifnotlistTypeornotlistTypes[listType]then
error(string.format(
"bad argument #1 to 'makeList' ('%s' is not a valid list type)",
tostring(listType)
),2)
end
checkType('makeList',2,args,'table')
localdata=p.makeListData(listType,args)
locallist=p.renderList(data)
localtrackingCategories=p.renderTrackingCategories(args)
returnlist..trackingCategories
end

forlistTypeinpairs(listTypes)do
p[listType]=function(frame)
localmArguments=require('Module:Arguments')
localorigArgs=mArguments.getArgs(frame,{
frameOnly=((frameandframe.argsandframe.args.frameonlyor'')~=''),
valueFunc=function(key,value)
ifnotvalueornotmw.ustring.find(value,'%S')thenreturnnilend
ifmw.ustring.find(value,'^%s*[%*#;:]')then
returnvalue
else
returnvalue:match('^%s*(.-)%s*$')
end
returnnil
end
})
-- Copy all the arguments to a new table, for faster indexing.
localargs={}
fork,vinpairs(origArgs)do
args[k]=v
end
returnp.makeList(listType,args)
end
end

returnp