Help:Incoming format
| Incoming format | |
|---|---|
| Displays incoming properties to a page or property/value pair | |
| Collection | |
| Loading... | |
| Further Information | |
| Provided by: | Semantic Result Formats |
| Added: | 1.8.0 |
| Removed: | still supported |
| Requirements: | none |
| Format name: | incoming |
| Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. |
no |
| Authors: | James Hong Kong |
| Categories: | misc |
| Table of Contents | |
Contents | |
The result format incoming shows all incoming properties to a page or property/value pair. Incoming properties can be displayed either as a simple list (separated using the [sep] parameter) or in a custom format by using a [template]. Use of a template allows flexibility to implement a semi-drilldown capacity (facilitating #queryformlink or #drilldownlink) for assigned incoming properties.
This result format supersedes the #iask parser function that was formerly provided by the Semantic Incoming Properties extension. In addition, it provides extended integration such as template functionality and display of counted elements per assigned property.
Note: This result format is not enabled be default. To enable it, see the instructions on Extension "Semantic Result Formats".Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| sep | text | , | The separator for values |
| exclude | text | empty | Exclude property from result set |
| min | text | empty | Minimum or threshold value |
| template | text | empty | The name of a template with which to display the printouts |
| userparam | text | empty | A value passed into each template call, if a template is used |
| count | yes/no | empty | Sets whether the number of incoming properties should be counted |
Usage
The count parameter works only in connection with a template. When using a template and [count] is set to true, the parameter {{{count}}} is reserved for displaying the count value.
Selection can be done by either using a single page, for instance [[{{PAGENAME}}]], or a [[property::value]] pair.
Performance
The format can influence performance during execution due to potential large number of incoming properties assigned to each selected entity.
You can counter those concerns by setting an appropriate limit parameter and if necessary use the exclude parameter to eliminate specific properties from processing.
Example
{{#ask:
[[ ... ]]
|format=incoming
|headers=none
|template=Incoming properties
|link=all
|userparam=...
|count=true
|sep=;
|min=1
|offset=
|limit=
}}
