Oreynia:Timeline Guidelines
The timeline is one of many ways to navigating the Oreynia universe while also giving a visual clue of what happened when.
Showing the timeline on a page
Showing the timeline of Oreynia is incredibly easy. Simply add the snippet {{#widget:Timeline}} into the page's source code and you'll see it appear right after it's done loading the data.
Parameters
Parameters can be passed on to the timeline, which controls what it shows. Parameters are simply added by putting |parameter=value into the snippet. By default the timeline shows everything, but by by adding a start- and end-time, we can control how zoomed in the timeline is initially: {{#widget:Timeline|start=100|end=500}} . This sets the timeline to be zoomed in between year 100 and 500 when loaded. If times are past the interest of events and periods of Oreynia, it will simply be capped to the master timeline's limits.
A list of parameters that can be added to the timeline can be seen here:
| Parameter | Value | What does it do |
|---|---|---|
| start | year (any number) | Sets the timeline to start at a certain year |
| end | year (any number) | Sets the timeline to end at a certain year |
| focus (still to be implemented) | event title (any string, any string, ...) | Sets focus on a specific timeline events, zooming the timeline to fit only them. This will ensure the event is seen, completely bypassing the [start] or [end] parameter |
| category (still to be implemented) | category name (any string, any string, ...) | Setting this parameter turns off all other categories, than the ones specified here |
Focus
Parameters are one way to add focus to a timeline. Anywhere in the page's source code, you can put these to add focus to an element
Usage (Invisible Marker): {{Focus|EventTitle}}
Usage (Wrapping a Word): {{Focus|EventTitle|ShownText}}
Timeline showcase
Here is a timeline with the following variables set: |start=1920 , |end=2040 . Notice how the timeline has 2 focuses, which bypasses the variables. They come from this and TestEvent1:
Notes:
- Parameters are just the initial value. The user can still drag the timeline around and toggle things back on again using the
button.
Editing the timeline
The timeline is loaded from a Google Sheets document:
There's 3 tabs: Events, Periods and Categories. Here you can add or edit the existing data. Data contains things as time, text, link etc.
Notes:
- As a contributor, admins can give you access to the Google Sheets.
- The Categories-tab requires admin control, as it requires code changes to the timeline, like including svg sprites.
- Admins may sort the order of Events/Categories once in a while to help the timeline's internal sorting algorithms.
- Formats are important for the functionality of the timeline. Dates are DD-MM-YYYY format, and Title/Names cant have special characters