Help:List format

The [[Help:Inline queries|result formats]] '''list''', '''ol''' and '''ul''' are used to format query results as lists, bulleted lists, or numbered lists. The format <tt>list</tt> is the default way of formatting query results for all queries that have no additional [[Help:Displaying information|printout statements]].

== Examples ==

=== Examples for plain lists ===

 <nowiki>{{#ask: [[Category:Vampire]] [[Clan::Daeva]] }}</nowiki>

'''Result:''' {{#ask: [[Category:Vampire]] [[Clan::Daeva]] }}

If more printouts are given, then the format must be requested explicitly:

<pre><nowiki>{{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant
| ?Status
| format=list
}}</nowiki></pre>

'''Result:''' {{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant
| ?Status
| format=list
}}

The headers can be hidden by giving them empty labels:

<pre><nowiki>{{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant =
| ?Status = 
| format=list
}}</nowiki></pre>

'''Result:''' {{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant =
| ?Status =
| format=list
}}

The same effect is achieved by <tt>headers=hide</tt>. Another separator than «,» and the final «and» can be used if specified by <tt>sep</tt>:

 <nowiki>{{#ask: [[Category:Vampire]] [[Clan::Daeva]] | sep =  _and_ }}</nowiki>

'''Result:''' {{#ask: [[Category:Vampire]] [[Clan::Daeva]] | sep =  _and_ }}

The underscores here are used to create spaces that are not removed by [[MediaWiki]] when reading the parameter.

=== Examples for bulleted and numbered lists ===

Ordered lists are created with <tt>ol</tt>:

<pre><nowiki>{{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant
| ?area#km² = Size in km²
| format=ol
}}</nowiki></pre>

'''Result:''' 

{{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant
| ?area#km² = Size in km²
| format=ol
}}

Unordered lists are created with <tt>ul</tt>:

<pre><nowiki>{{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant
| ?area#km² = Size in km²
| format=ul
}}</nowiki></pre>

'''Result:''' 

{{#ask: [[Category:Vampire]] [[Clan::Daeva]] 
| ?Covenant
| ?area#km² = Size in km²
| format=ul
}}


== Parameters ==

The list formats introduce the following additional parameters:
* <tt>columns</tt>: the number of columns into which to split up results (default is 1)
* <tt>sep</tt>: the text to be used to separate items
* <tt>template</tt>: the name of a template for template-based formatting

The use of templates for formatting is explained in [[Help:Inline queries]].

== Remarks ==

Using the format <tt>list</tt> with templates has the advantage of having the right amount of separators (e.g. «,») between results. For example, one can have a tempalte that formats email lists that can be copied and pasted into an email client, where each entry has the form
 
 Name of person <email@example.com>

It makes sense to set <tt>sep=,_</tt> to have a list that uses commas for all separators instead of having the last one being an «and».