View source for Help:Ol format

{{Result format
 |format name=ol
 |authors=Markus Krötzsch
 |minimum version=0.7
 |maximum version=still supported
 |further reqs=none
 |component=Semantic MediaWiki
 |categories=misc
 |keyword=list; template
 |description=Outputs results as a numbered list, with additional outputs shown in parentheses. 
}}
The [[Help:Result formats|result format]] '''ol''' is used to format query results as numbered lists. It is very similar to {{ResultFormat|Plainlist}}, {{ResultFormat|List}} and {{ResultFormat|Ul}}.

== Parameters ==
; Format specific
{{#smwdoc:ol|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>columns</code>" parameter was removed. Use the "<code>class</code>" parameter and CSS instead.
* 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}} (formerly {{ResultFormat|Template}}) in case a template is used for formatting the query output.
 |info
}}

== Examples ==
=== Standard output ===
; Query
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |?Population
 |?Area#km²=Size in km²
 |format=ol
}}
</pre>

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

=== Multi-column output ===
{{Callout
 |Starting with {{Release|3.0.0}} the "<code>columns</code>" parameter is no longer available.[[CiteRef::gh:smw:3130]] Instead the "<code>class</code>" parameter and CSS have to be used to generate two or more columns. CSS in turn allows for even more formatting options.[[CiteRef::www.w3schools.com:css3:mc]] The examples shown below provide examples for a two column layout.
}}
==== Semantic MediaWiki ≥ 3.0.0 ====
; Query / individually (preferred)
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |format=ol
 |class=exampleclass
}}
</pre>
; CSS / individually (preferred)
<syntaxhighlight lang="css">
ol.smw-format.ol-format.exampleclass {
    column-count: 2;
}
</syntaxhighlight>
; Result
{{#ask:
 [[Category:City]]
 [[located in::Germany]] 
 |format=ol
 |class=exampleclass
}}
{{Callout
 |It is preferred to use the "<code>class</code>" parameter to allow for a fine-grained control of the columns appearance for individual queries.
 |info
}}

; Query / globally
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |format=ol
}}
</pre>
; CSS / globally
<syntaxhighlight lang="css">
ol.smw-format.ol-format {
    column-count: 2;
}
</syntaxhighlight>
; Result
{{#ask:
 [[Category:City]]
 [[located in::Germany]] 
 |format=ol
 |class=exampleclass 
}}
{{Callout
 |This is discouraged since it does not allow for fine-grained control of the appearance of individual queries using this result format. All queries would be affected by the CSS.
 |info
}}

==== Semantic MediaWiki < 3.0.0 ====
; Query
<pre>
{{#ask:
 [[Category:City]]
 [[Located in::Germany]] 
 |format=ol
 |columns=2
}}
</pre>

; Result
{{#ask:
 [[Category:City]]
 [[located in::Germany]] 
 |format=ol
 |class=exampleclass
}}
{{Interlanguage}}
<div style="display: none">
{{DEFAULTSORTKEY:Ol}}
{{#scite:www.w3schools.com:css3:mc
 |type=reference
 |citation text=[https://www.w3schools.com/css/css3_multiple_columns.asp CSS Multiple Columns]
}}
{{doc.info
 |master page=Help:Ol_format
 |status=effective
 |progress=100
 |priority=2
 |minversion=3.0.0
}}
</div>