Help:Eventline format

From semantic-mediawiki.org
Jump to: navigation, search
Eventline format
Displays query results in interactive eventlines
Available languages
de, en, en, zh-hans, zh-hans
Further Information
Provided by: Semantic Result Formats
Added: 1.4.0
Removed: still supported
Requirements: none
Format name: timeline
Enabled by default: Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Markus Krötzsch, Jeroen De Dauw
Categories: time
Group:
Table of Contents

INFO

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

Parameter Type Default Description
timelinesize text 300px The height of the timeline
timelineposition text middle Defines where the timeline initially focuses at.
timelinestart text empty A property name used to define a first time point
timelineend text empty A property name used to define a second time point
timelinebands list of texts MONTH, YEAR Defines which bands are displayed in the result.

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.
Note: 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:

You need to have JavaScript enabled to view the interactive timeline. Further results for this query.

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.



This documentation page applies to all SMW versions from 1.4.0 to the most current version.
      Other languages: de, zh-hans

Help:Eventline format en 1.4.0


Retrieved from "http://www.semantic-mediawiki.org/w/index.php?title=Help:Eventline_format&oldid=20671"