Help:List format

List format
Outputs results in a comma separated list, with additional outputs shown in parentheses. The output introduces class attributes to HTML elements to facilitate easy individual styling.
Further Information
Provided by:	Semantic MediaWiki
Added:	0.7
Removed:	still supported
Requirements:	none
Format name:	list
Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension.	yes
Authors:	Markus Krötzsch , Stephan Gambke
Categories:	misc
Keywords
list · template
Table of Contents

The result format list is used to format query results as comma separated lists. The output induces class attributes to HTML elements like <span class="smw-format list-format"> since Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x. to facilitate easy individual styling. It is very similar to result format "Plainlist"Outputs results in a comma separated list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements)., result format "Ol"Outputs results as a numbered list, with additional outputs shown in parentheses. and result format "Ul"Outputs results as a bulleted list, with additional outputs shown in parentheses..

If the output should not include class attributes to HTML elements then result format "Plainlist"Outputs results in a comma separated list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements). needs to be used which is also the default result format of Semantic MediaWiki if no result format was specified.

Wikis that were using this result format prior to Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x. and are relying on it not to provide HTML elements should migrate the respective queries to result format "Plainlist"Outputs results in a comma separated list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements).. See also configuration parameter $smwgPlainListSets whether the list format should provide class attributes to HTML elements.

Parameters

Format specific

Parameter	Aliases	Type	Default	Description
propsep	-	text	,	The separator between the properties of a result entry
valuesep	-	text	,	The separator between the values for a property of a result
template	-	text	empty	The name of a template with which to display the printouts
named args	namedargs	yes/no	no	Name the arguments passed to the template
userparam	-	text	empty	A value passed into each template call, if a template is used
class	-	text	empty	An additional CSS class to set for the list
introtemplate	-	text	empty	The name of a template to display before the query results, if there are any
outrotemplate	-	text	empty	The name of a template to display after the query results, if there are any
sep	-	text	,	The separator between results

Starting with Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x. this result format was overhauled and the following changes were made to the parameters provided:1

• The "class" parameter was introduced to allow setting an additional CSS class for the output.
• The "template arguments" parameter was removed. It served no longer any purpose since the "?" prefix for arguments was removed, too.
• The "propsep" and the "valuesep" parameter were introduced to supplement the "sep" parameter.

See the help page on result format "Plainlist"Outputs results in a comma separated list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements). in case a template is used for formatting the query output.

Examples

Standard output

The format must be requested explicitly. Otherwise result format "Plainlist"Outputs results in a comma separated list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements). would be used.

Query

{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |format=list
}}

Result

Berlin, Cologne, Frankfurt, Munich, Stuttgart, Würzburg

Extended output

If more printouts are requested the format must be requested explicitly, too. Otherwise result format "Table"Outputs the results in a table (default for queries with printout statements). would be used.

Syntax

{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population
 |?Area#km²=Area
 |format=list
}}

Result

Berlin (PopulationThe number of inhabitants of some geographical place.: 3,520,061, Area: 891.85 km²344.34 sqmi <br />), Cologne (PopulationThe number of inhabitants of some geographical place.: 1,080,394, Area: 405.02 km²156.38 sqmi <br />), Frankfurt (PopulationThe number of inhabitants of some geographical place.: 679,664, Area: 248.31 km²95.87 sqmi <br />), Munich (PopulationThe number of inhabitants of some geographical place.: 1,353,186, Area: 310.43 km²119.86 sqmi <br />), Stuttgart (PopulationThe number of inhabitants of some geographical place.: 606,588, Area: 207.35 km²80.06 sqmi <br />), Würzburg (PopulationThe number of inhabitants of some geographical place.: 126,635, Area: 87.63 km²33.83 sqmi <br />)

Hidden headers

The headers can be hidden by giving them empty labels:

Syntax

{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population=
 |?Area#km²= 
 |format=list
}}

Result

Berlin (3,520,061, 891.85 km²344.34 sqmi <br />), Cologne (1,080,394, 405.02 km²156.38 sqmi <br />), Frankfurt (679,664, 248.31 km²95.87 sqmi <br />), Munich (1,353,186, 310.43 km²119.86 sqmi <br />), Stuttgart (606,588, 207.35 km²80.06 sqmi <br />), Würzburg (126,635, 87.63 km²33.83 sqmi <br />)

The same effect is achieved by using headers=hide:

Syntax

{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population
 |?Area#km²
 |format=list
 |headers=hide
}}

Result

Berlin (3,520,061, 891.85 km²344.34 sqmi <br />), Cologne (1,080,394, 405.02 km²156.38 sqmi <br />), Frankfurt (679,664, 248.31 km²95.87 sqmi <br />), Munich (1,353,186, 310.43 km²119.86 sqmi <br />), Stuttgart (606,588, 207.35 km²80.06 sqmi <br />), Würzburg (126,635, 87.63 km²33.83 sqmi <br />)

Changed separator

Between results

Another separator between results than "," e.g. "and" can be used if specified by the sep parameter:

Syntax

{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |sep= and 
}}

Result

Berlin and Cologne and Frankfurt and Munich and Stuttgart and Würzburg

Between properties

Another separator between results than "," e.g. ";" can be used if specified by the propsep parameter:

Syntax

{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |?Population
 |?Area#km²=Area
 |format=list
 |propsep=; 
}}

Result

Berlin (PopulationThe number of inhabitants of some geographical place.: 3,520,061; Area: 891.85 km²344.34 sqmi <br />), Cologne (PopulationThe number of inhabitants of some geographical place.: 1,080,394; Area: 405.02 km²156.38 sqmi <br />), Frankfurt (PopulationThe number of inhabitants of some geographical place.: 679,664; Area: 248.31 km²95.87 sqmi <br />), Munich (PopulationThe number of inhabitants of some geographical place.: 1,353,186; Area: 310.43 km²119.86 sqmi <br />), Stuttgart (PopulationThe number of inhabitants of some geographical place.: 606,588; Area: 207.35 km²80.06 sqmi <br />), Würzburg (PopulationThe number of inhabitants of some geographical place.: 126,635; Area: 87.63 km²33.83 sqmi <br />)

Between property values

Another separator between results than "," e.g. "and" can be used if specified by the valuesep parameter:

Syntax

{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |?Population
 |?Area#km²=Area
 |?Has zoo=Zoo
 |format=list
 |valuesep= and 
}}

Result

Berlin (PopulationThe number of inhabitants of some geographical place.: 3,520,061, Area: 891.85 km²344.34 sqmi <br />, Zoo: Tierpark Berlin and Zoologischer Garten Berlin), Cologne (PopulationThe number of inhabitants of some geographical place.: 1,080,394, Area: 405.02 km²156.38 sqmi <br />), Frankfurt (PopulationThe number of inhabitants of some geographical place.: 679,664, Area: 248.31 km²95.87 sqmi <br />, Zoo: Zoo Frankfurt), Munich (PopulationThe number of inhabitants of some geographical place.: 1,353,186, Area: 310.43 km²119.86 sqmi <br />, Zoo: Tierpark Hellabrunn), Stuttgart (PopulationThe number of inhabitants of some geographical place.: 606,588, Area: 207.35 km²80.06 sqmi <br />, Zoo: Wilhelma), Würzburg (PopulationThe number of inhabitants of some geographical place.: 126,635, Area: 87.63 km²33.83 sqmi <br />)

The HTML character entities  ,   and   denote a thin space, an en space and an em space respectively, where a thin space is a quarter of the point size, an en space is half the point size and an em space is equal to the point size of the current font. If the output should not be broken at spaces   (non-breaking space) is used.