Template:Simple Horizontal timeline/doc
From Guild of Archivists
 | Uses Lua: |
This is a Lua implementation of {{Horizontal timeline}}. It has all the functionality of the legacy one with few more features added to it.
Parameters
Basic Plot settings
|bordr=Border of the plot|bgCol=Background color of the plot|width=Width of the timeline plot. Defaults to100%, can be inpxoremtoo|caption=shows a centered text. Can be used to show legends. Intended to be used to label the axis|from=and|to=Necessary parameters which denotes the start and end of the timeline axis. The entire timeline (for the entire plot) including other type of rows are drawn to this scale.|to=may or may not be greater than|from=. (see|inc=for more on this) If any bars described using parameters shown below lie outside these values, they will be trimmed or eliminated depending on their position.|inc=Optional Increment to be added to|from=to reach|to=and be displayed along the axis. If not specified it will be automatically calculated. If|to=is greater than|from=then|inc=should be positive and vice versa. If not the outcome is undetermined.
The rown parameter
|rown= specifies how horizontal rows are drawn. You can have as many rows as you want. Subscript are positive intigers. They specify where the row is rendered on the plot. Lower subscript indicate higher on the plot. That is |row3= will be above |row4=
Three differenct types of rows are possible. They are:
scale: Specifies where the axis is drawn. (how it is drawn can be found in the Scale Row section below).timeline: Specifies where and how the bars are drawn.note: Row that contains arrow marked notes to give explanations to the graph.
Generic Parameters
|height=Applies height oftimelineandnoterows.
Each of these types of rows have their own attributes specified with an hyphen. For example, the style of a rown can be specified as |rown-style=. Full list of available attributes and their description can be found below.
Scale Row
|axis-negativeFmt=,|axis-positiveFmt=and|axis-zeroFmt=Formatting options for Axis scale. If you want more customization, (like completely hiding a single label on the axis) use the following:|axis-value=- Used to replace the value label on the axis (It will work if and only if the exact value appears on it).|axis-marker-value=- Used to replace the marker point for a label that appears on the axis. (It will work if and only if the exact value appears on it).
|axis-nudge=Amount of nudge to be applied to the axis label, defaults to-1.8em.
|axis-marker-1878= |axis-1878=
Example Usage
| Markup | Renders as |
|---|---|
{{Simple Horizontal timeline
|from=-2000
|to=2000
|inc=500
|row1=scale
}}
|
│ −2000 │ −1500 │ −1000 │ −500 │ 0 │ 500 │ 1000 │ 1500 │ 2000 |
| Markup | Renders as |
|---|---|
{{Simple Horizontal timeline
|from=-2000
|to=2000
|inc=500
|row1=scale
|axis-negativeFmt=%s BC
|axis-positiveFmt=%s AD
|axis-zeroFmt= %s AD
|axis-nudge=-0.8em
}}
|
│ 2000 BC │ 1500 BC │ 1000 BC │ 500 BC │ 0 AD │ 500 AD │ 1000 AD │ 1500 AD │ 2000 AD |
| Markup | Renders as |
|---|---|
{{Simple Horizontal timeline
|from=-2000
|to=2000
|inc=500
|row1=scale
|axis-nudge=-0.8em
|axis--2000=this is minus<br/>two thousand
|axis-marker-0=⇑
|axis-0=Changed<br/>axis marker
}}
|
│ −2000 │ −1500 │ −1000 │ −500 ⇑ Changed axis marker │ 500 │ 1000 │ 1500 │ 2000 |
Timeline Row
|rown-bordertop=and|rown-borderbottom=Specifies the top and bottom border for the row.|rown-texttop=specifies vertical nudge for the bar labels for the entire row.|rown-colour=or|rown-color=specifies the row's background color.
- Note:
colourorcolorboth are acceptable variations for the whole module.
- Note:
|rown-i-from=Starting point for the bar. This is optional, if not specified, will start from value specified in|from=.|rown-i-to=Ending point for the bar.|rown-i-text=Label for the bar.|rown-i-fontsize=Font size for the label.|rown-i-texttop=Vertical nudge for the label of ith bar.|rown-i-colour=bar colour.|rown-i-border=bar border (See Known Issues).
- Note on Subscripts:
|rown-i-<attribute>=denotes theattributevalue for ith bar on the nth row.- Here subscript
nis a positive number used to group rows and their attributed. They may not occur continuous in your script, but are displayed in ascending order. - Subscript
iis also a positive number which is used to group bar on a specific row.
- Note on Subscripts:
Style Parameter of the Timeline Row
|rown-style=and|rown-i-style=can be used to provide row specific or bar specific styles. Those styles which repeat for every bar or for every row may be grouped into styles and be applied globally. The style prefixes can be anything other thanrow. See example below on how|styleDefault=is used to apply style common to all rows and|stylePopes=/|styleAntiPopes=are used to specify bar specific styles.
Example Usage
| Markup |
|---|
|
| Renders as |
|---|
|
│ 1003 │ 1015 │ 1027 │ 1039 │ 1051 │ 1063 │ 1075 │ 1087 │ 1099 │ 1111 │ 1123 │ 1135 │ 1147 │ 1159 │ 1171 │ 1183 │ 1195 │ 1207 │ 1219 │ 1231 │ 1243 │ 1255 │ 1267 │ 1279 Popes and Antipopes of the Catholic Church from 1003 - 1254 |
Note Row
|rown-i-at=Necessary parameter. Specifies where the note is placed|rown-i-text=Specifies the content of the note|rown-i-shift=and|rown-i-lift=Specifies the nudge applied to the note. Defaults to0em|rown-i-arrow=Specifies the arrow Character. Defaults to↓. Nullify with
Example Usage
| Markup | Renders as |
|---|---|
{{Simple Horizontal timeline
|from=-600
|to=0
|row1=note
|row1-1-text='''Minor events'''
|row1-1-shift=-2.8em
|row1-1-arrow=
|row1-1-at=-590
|row1-2-at=-542
|row1-2-text=[[End-Ediacaran extinction|End-Ediacaran?]]
|row1-3-at=-420
|row1-3-text=[[Lau event]]
|row1-4-at=-183
|row1-4-text=[[Toarcian turnover]]
|row1-4-lift=-1em
|row1-4-shift=-4.8
|row1-6-at=-91.5
|row1-6-text=[[Cenomanian-Turonian boundary event|Cenomanian-Turonian]]
|row1-6-lift=-1.3em
|row1-6-shift=-5.1
|row2=scale
|axis-nudge=-0.8em
|caption=Millions of years before present
}}
|
│ −600 │ −480 │ −360 │ −240 │ −120 │ 0 Millions of years before present |
Note: |row1-5-lift= is missing. Same as n, i does not have to be continuous.
Usage Tips
- You can use timeline inside {{navbox}} for a collapsible frame. See {{Restoration Movement Timeline graphical timeline}} for a working example.
- If {{navbox}} spoils the line spacing, it is better to use {{hidden begin}} and {{hidden end}}. See {{Vietnam War graphical timeline}} for a working example.
- It is possible to render only a single row by directly calling the module as {{#invoke:Horizontal timeline | showOneRow | ...}}. See {{Geological eras}} or {{Geological periods}} for a working example.
- If you create a single row template, it can easily be embedded in a different template with different scale. The single row template will be automatically cropped to fit the parent template. See how {{Geological eras}} and {{Geological periods}} are embedded in {{Extinction events graphical timeline}}
- Different browsers have different ways of rendering. It's probably worth checking your finished timeline in at least IE, Firefox and Chrome if you are making a particularly complex timeline.
Examples
- {{Extinction events graphical timeline}}
- {{Prime Ministers of Spain - Democratic Spain graphical timeline}}
- {{Vietnam War graphical timeline}}
- {{Restoration Movement Timeline graphical timeline}}
- {{Cricket in the Great War timeline}}
- {{Portland Youth Philharmonic graphical timeline}}
- {{WikiProject Java/When graphical timeline}}
- {{Tremors Release Dates}}
Known Issues
- Left and bottom border for bars (not rows) will not render properly in old browsers which lacks support for CSS3 Box-sizing.(Refer here for full supported browser list) All modern browsers provides at-least minimal support for this. Also only in extereme circumstances you will need to set bar border. Most of the time row border will be sufficient. Hence this should not be a problem.
