View source for Help:List format

{{Result format
 |format name=list
 |authors=Markus Krötzsch, Stephan Gambke
 |minimum version=0.7
 |maximum version=still supported
 |further reqs=none
 |component=Semantic MediaWiki
 |categories=misc
 |keyword=list; template
 |description=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. 
}}
The [[Help:Result formats|result format]] '''list''' is used to format query results as comma separated lists. The output induces class attributes to HTML elements like <code><nowiki><span class="smw-format list-format"></nowiki></code> since {{Release|3.0.0}} to facilitate easy individual styling. It is very similar to {{ResultFormat|Plainlist}}, {{ResultFormat|Ol}} and {{ResultFormat|Ul}}.

If the output should not include class attributes to HTML elements then {{ResultFormat|Plainlist}} 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 {{Release|3.0.0}} and are relying on it not to provide HTML elements should migrate the respective queries to {{ResultFormat|Plainlist}}. See also {{Config|$smwgPlainList}}.

== Parameters ==
; Format specific
{{#smwdoc:list|parameters=specific}}

{{Callout
 |Starting with {{Release|3.0.0}} this result format was overhauled and the following changes were made to the parameters provided:[[CiteRef::gh:smw:3130]]
* The "<code>class</code>" parameter was introduced to allow setting an additional CSS class for the output. 
* The "<code>template arguments</code>" parameter was removed. It served no longer any purpose since the "<code>?</code>" prefix for arguments was removed, too.
* The "<code>propsep</code>" and the "<code>valuesep</code>" parameter were introduced to supplement the "<code>sep</code>" parameter.
}}

{{Callout
 |See the help page on {{ResultFormat|Plainlist}} in case a template is used for formatting the query output.
 |info
}}

== Examples ==
=== Standard output ===
The format must be requested explicitly. Otherwise {{ResultFormat|Plainlist}} would be used.
; Query
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |format=list
}}
</pre>

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

=== Extended output ===
If more printouts are requested the format must be requested explicitly, too. Otherwise {{ResultFormat|Table}} would be used.
; Syntax
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population
 |?Area#km²=Area
 |format=list
}}
</pre>

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

=== Hidden headers ===
The headers can be hidden by giving them empty labels:
; Syntax
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population=
 |?Area#km²= 
 |format=list
}}
</pre>

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

The same effect is achieved by using <code>headers=hide</code>:
; Syntax
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population
 |?Area#km²
 |format=list
 |headers=hide
}}
</pre>

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

=== Changed separator ===
==== Between results ====
Another separator between results than "," e.g. "and" can be used if specified by the <code>sep</code> parameter:
; Syntax
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |sep=&amp;thinsp;and&amp;thinsp;
}}
</pre>

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

==== Between properties ====
Another separator between results than "," e.g. ";" can be used if specified by the <code>propsep</code> parameter:
; Syntax
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |?Population
 |?Area#km²=Area
 |format=list
 |propsep=;&amp;thinsp;
}}
</pre>

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

==== Between property values ====
Another separator between results than "," e.g. "and" can be used if specified by the <code>valuesep</code> parameter:
; Syntax
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]]
 |?Population
 |?Area#km²=Area
 |?Has zoo=Zoo
 |format=list
 |valuesep=&amp;thinsp;and&amp;thinsp;
}}
</pre>

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

{{Callout
 |The HTML character entities <code>&amp;thinsp;</code>, <code>&amp;ensp;</code> and <code>&amp;emsp;</code> 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 <code>&amp;nbsp;</code> (non-breaking space) is used.
 |info
}}
<div style="display: none">
{{DEFAULTSORTKEY:List}}
{{doc.info
 |master page=Help:List_format
 |status=effective
 |progress=100
 |priority=2
 |minversion=3.1.2
}}
{{Interlanguage}}
</div>