Help:Plainlist format

From semantic-mediawiki.org
Plainlist format
Outputs results in a comma separates list, with additional outputs shown in parentheses. The output does not provide class attributes to HTML elements (default for queries without printout statements).
Further Information
Provided by: Semantic MediaWiki
Added: 3.0.0
Removed: still supported
Requirements: none
Format name: plainlist
Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Stephan Gambke
Categories: misc
Table of Contents

The result format plainlist is used to format query results format query results as comma separated lists. It was introduced in Semantic MediaWiki 3.0.0Released on 11 October 2018 and compatible with MW 1.27.0 - 1.31.x. 1 and is the default result format for all queries without additional printout statements. It replaces result format "Template"Uses a specified template to format and display the results which is now deprecated. Similar formats are result format "List"Outputs results in a comma separates list, with additional outputs shown in parentheses. The output induces class attributes to HTML elements to facilitate easy individual styling., 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 include class attributes to HTML elements then result format "List"Outputs results in a comma separates list, with additional outputs shown in parentheses. The output induces class attributes to HTML elements to facilitate easy individual styling. needs to be used.

Parameters[edit]

Format specific
Parameter 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 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
The use of templates for formatting is explained on help page for result format "Template"Uses a specified template to format and display the results.

Examples[edit]

Standard output[edit]

Query
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
}}
Result

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

Extended output[edit]

If more printouts are requested, then the format must be requested explicitly. 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=plainlist
}}
Result

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

Hidden headers[edit]

The headers can be hidden by giving them empty labels:

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

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

The same effect is achieved by using headers=hide:

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

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

Changed separator[edit]

Between results[edit]

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[edit]

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=plainlist
 |propsep=; 
}}
Result

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

Between property values[edit]

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=plainlist
 |valuesep= and 
}}
Result

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

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.

To be even more flexible (e.g. avoiding the brackets for the results), you can use the template parameter. Usage of templates is described in the (now deprecated) result format "Template"Uses a specified template to format and display the results.


References

  1. ^  Semantic MediaWiki: GitHub issue gh:smw:2488