Help:Outline format

From semantic-mediawiki.org
(Redirected from Help:Outline format)
Outline format
Lists pages in a hierarchical outline, based on property values
Further Information
Provided by: Extension "Semantic Result Formats"
Added: 1.4.3
Removed: still supported
Requirements: none
Format name: outline
Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Yaron Koren
Categories: misc
Keywords

The result format outline is used to display pages in hierarchical outline form, using one or more of the pages' properties as outline headers.

See also the Octocat.png"README" file with further documentation an more examples concerning this result format.

Parameters[edit]

Format specific
Parameter Type Default Description
outlineproperties list of texts empty The list of properties to be displayed as outline headers, separated by commas
template text empty The name of a template with which to display the printouts
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
userparam text empty A value passed into each template call, if a template is used
named args yes/no yes Name the arguments passed to the template
Note

The outlineproperties parameter is optional. If it is absent, the set of resulting pages will be displayed as a simple bulleted list. Any property included in this parameter must also be included among the queried properties.

Example[edit]

Syntax
{{#ask:
 [[Category:City]]
 [[Located in::+]]
 |?Located in
 |format=outline
 |outlineproperties=Located in
}}
Result

Netherlands

Germany

France

Portugal


Further example

See the category holding an outline example on <sandbox.semantic-mediawiki.org>.