Help:Eventline format

From semantic-mediawiki.org
(Redirected from Eventline)
Jump to: navigation, search
Eventline format
Has description::Displays query results in interactive eventlines
Available languages
Expression error: Unrecognized punctuation character "{".
Further Information
Provided by: Semantic Result Formats
Added: Has minimum version::1.4.0
Removed: Has maximum version::still supported
Requirements: Has further requirements::none
Format name: Has format name::eventline
Enabled by default: {{#info:Indicates whether the result format is enabled by default upon installation of the respective extension.}} Is enabled by default::No
Authors: {{#set:Has author=Markus Krötzsch}}Markus Krötzsch, {{#set:Has author=Jeroen De Dauw}}Jeroen De Dauw
Categories: {{#ask: Has category::time Docinfo status::effective[[Docinfo language::{{#show:Help:Eventline format|?Docinfo language|link=none|format=list}}]] ?Has description format=broadtable headers=show link=all class=sortable wikitable smwtable offset= searchlabel=time limit=0

}}

Group:
Table of Contents

↓ INFO ↓


{{#set: |docinfo status=effective }}{{#set: |worn by =Template:Docinfo |warning =Master page updated }}{{#set:

|worn by =Template:Docinfo
|warning =No description
}}{{#set:

|revision id=43625 |namespace=Help |docinfo progress =100 |docinfo priority =3 }}{{#set:docinfo master page=Help:Eventline format }}{{#set:docinfo master rev =43625 }}{{#set:docinfo category=-}}{{#set:docinfo author=User:Yaron Koren}}{{#set:docinfo editor=User:Nicolas NALLET}}{{#set:docinfo support=User:Yaron Koren}}{{#set:docinfo language=en}}

This documentation page applies to all SMW versions from 1.4.0 to the most current version.
Other versions: {{#ask: Docinfo master page::Help:Eventline format Docinfo language::en from version::!1.4.0|
   ?from version = |
   ?to version = |
   sort = from version|
   order = desc|
   link=none|
   format=list|
   sep=, |
   template=versionlink|
   limit = 3|
   searchlabel = […]
  }}       Other languages: {{#ask: Docinfo master page::Help:Eventline format from version::1.4.0 Docinfo language::!en|
  ?Docinfo language =|
  link=none|
  format=list|
  sep=, |
  template=languagelink|
  sort = Docinfo language|
  order = asc|
  limit = 10|
  searchlabel = […]
}}

Docinfo master page::Help:Eventline format Docinfo language::en from version::1.4.0

{{#set:Release status=current}}

{{#set:Is master page=true}}
Note: this result format is in need of a maintainer. Contact Jeroen De Dauw for more info.

The result format eventline are used to display query results in interactive eventlines. This format was part of SMW until SMW 1.3 and is now part of the Semantic Result Formats extension. Obviously, only results that include dates can be displayed in this way. This format only works when JavaScript is enabled. It is similar to the timeline format.

Usage

The eventline format uses printout statements in queries for properties of datatype Date. If the eventline remains empty even though there are resutls, this is usually because no printouts for dates were specified. Eventline will display all dates in the printout as separate points. So a query with five data printouts would create five points on the eventline for each result. Different colors are used to maintain some visual hint of which points belong to which result. Again the tooltip shows all details. All other printout statements are shown in the tooltips that appear when clicking on items.

Parameters

{{#smwdoc:timeline}}

Available values for parameters:

  • timelinebands: Available bands are DECADE, YEAR, MONTH, WEEK, DAY, HOUR and MINUTE. Bands should be given from finer to coarser, and be separated by commas as in the example below.
  • timelineposition: Possible values are start (earliest entry), middle (middle entry), end (latest entry), today.
NoteNote: The eventline format is derived from the timeline format. This is why the parameter names are identical to the ones used in the timeline format.

Example

{{#ask: [[News date::+]] [[language code::en]]
| ?news date
| sort=news date
| order=descending
| format=eventline
| timelinebands=WEEK,MONTH,YEAR
| timelineposition=end
| limit=150
}}

This produces the following output: {{#ask: News date::+ language code::en | ?news date | sort=news date | order=descending | format=eventline | timelinebands=WEEK,MONTH,YEAR | timelineposition=end | limit=150 }}

Remarks

Page load times can be slowed down by eventlines, especially if a large number of events is displayed. It is useful to use a smaller limit to keep the eventline more manageable for browsers.

Sorting results has no impact on the display of the timeline, since it always displays events chronologically. However, sorting can be very useful to select, e.g., the ten latest events instead of ten arbitrary events for display.