Archive:Timeline format 0.6

From semantic-mediawiki.org
(Redirected from Archive:Timeline format 0.6)

The result formats timeline and eventline are used to display query results in interactive timelines. These formats are part of SMW until Semantic MediaWiki 1.3.0. Obviously, only results that include dates can be displayed in this way. This format only works when JavaScript is enabled.

Example[edit]

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

This produces the following output:


Usage and parameters[edit]

The timeline formats use printout statements in queries for properties of datatype Date. If the timeline remains empty even though there are resutls, 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.

Eventline is similar, but displays all dates in the printout as separate points. So a query with five data printouts would create five points on the timeline 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.

The timeline and eventline formats introduce the following additional parameters:

  • timelinebands: defines which bands are displayed in the result. Available bands are DECADE, YEAR, MONTH, WEEK, and DAY. Bands should be given from finer to coarser, and be separated by commas as in the above example.
  • timelineposition: defines where the timeline initially focusses at. Possible values are start (earliest entry), middle (middle entry), end (latest entry).
  • timelinestart: can be used to define a specific printout (property) name to use as a first timepoint in timeline.
  • timelineend: can be used to define a specific printout (property) name to use as a second timepoint in timeline.
  • timelinesize: can be used to give the height of the timeline. The default value is 300px.

Remarks[edit]

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.




This page contains outdated information and is thus OBSOLETE!
This documentation page applies to all SMW versions from 0.6 to 1.3.