| Status: | effective |
| Progress: | 100% |
| Version: | 1.4.0+ |
Help:Timeline format
| Timeline format | |
|---|---|
| Displays query results in interactive timelines | |
| Further Information | |
| Provided by: | Semantic Result Formats |
| Added: | 1.4.0 |
| Removed: | still supported |
| Requirements: | none |
| Format name: | timeline |
| Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. | yes |
| Authors: | Markus Krötzsch |
| Categories: | time |
| Keywords | |
| Table of Contents | |
The result format timeline is used to display query results in interactive timelines. This format was part of Semantic MediaWiki until Semantic MediaWiki 1.3.0Released on an unknown date unknown versions of MediaWiki and is now part of extension "Semantic Result Formats"No description was provided.. Obviously, only results that include dates can be displayed in this way. This format only works when JavaScript is enabled. It is very similar to the eventline format.
Usage
The timeline format uses printout statements in queries for properties of datatype "Date"Holds particular points in time. If the timeline remains empty even though there are results, this is usually because no printouts for dates were specified. Timeline will normally use the first and optionally second date and display every result as a single point (one date given) or interval (two dates given). All other printout statements are shown in the tooltips that appear when clicking on items.
Parameters
| ⧼validator-describe-header-parameter⧽ | ⧼validator-describe-header-type⧽ | ⧼validator-describe-header-default⧽ | ⧼validator-describe-header-description⧽ |
|---|---|---|---|
| timelinesize | ⧼validator-type-string⧽ | 300px | The height of the timeline |
| timelineposition | ⧼validator-type-string⧽ | middle | Defines where the timeline initially focuses at. |
| timelinestart | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | A property name used to define a first time point |
| timelineend | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | A property name used to define a second time point |
| timelinebands | ⧼validator-type-string-list⧽ | MONTH, YEAR | Defines which bands are displayed in the result. |
| template | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The name of a template with which to display the printouts |
| named args | ⧼validator-type-boolean⧽ | no | Name the arguments passed to the template |
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.
Example
{{#ask:
[[News date::+]]
[[Language code::en]]
|?News date
|sort=News date
|order=descending
|format=timeline
|timelinebands=MONTH,YEAR,DECADE
|timelineposition=end
|limit=150
}}
This produces the following output:
Remarks
Page load times can be slowed down by timelines, especially if a large number of events is displayed. It is useful to use a smaller limit to keep the timeline 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.
