Help:Outline format

Outline format
Lists pages in a hierarchical outline, based on property values
Further Information
Provided by:	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
template · outline · result format

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 File:Octocat.png "README" file with further documentation an more examples concerning this result format.

Parameters

Format specific

⧼validator-describe-header-parameter⧽	⧼validator-describe-header-type⧽	⧼validator-describe-header-default⧽	⧼validator-describe-header-description⧽
outlineproperties	⧼validator-type-string-list⧽	⧼validator-describe-empty⧽	The list of properties to be displayed as outline headers, separated by commas
template	⧼validator-type-string⧽	⧼validator-describe-empty⧽	The name of a template with which to display the printouts
introtemplate	⧼validator-type-string⧽	⧼validator-describe-empty⧽	The name of a template to display before the query results, if there are any
outrotemplate	⧼validator-type-string⧽	⧼validator-describe-empty⧽	The name of a template to display after the query results, if there are any
userparam	⧼validator-type-string⧽	⧼validator-describe-empty⧽	A value passed into each template call, if a template is used
named args	⧼validator-type-boolean⧽	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

Syntax

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

Result

Further example

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