Template:Simple Horizontal timeline/doc

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

{{#invoke:Lua banner|main}} 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
  • |wdth= Width of the timeline plot. Defaults to <syntaxhighlight lang="text" enclose="none">100%</syntaxhighlight>, can be in <syntaxhighlight lang="text" enclose="none">px</syntaxhighlight> or <syntaxhighlight lang="text" enclose="none">em</syntaxhighlight> too
  • |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:

  • <syntaxhighlight lang="text" enclose="none">scale</syntaxhighlight>: Specifies where the axis is drawn. (how it is drawn can be found in the Scale Row section below).
  • <syntaxhighlight lang="text" enclose="none">timeline</syntaxhighlight>: Specifies where and how the bars are drawn.
  • <syntaxhighlight lang="text" enclose="none">note</syntaxhighlight>: Row that contains arrow marked notes to give explanations to the graph.

Generic Parameters

  • |height= Applies height of <syntaxhighlight lang="text" enclose="none">timeline</syntaxhighlight> and <syntaxhighlight lang="text" enclose="none">note</syntaxhighlight> rows.

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.
  • |axis-nudge= Amount of nudge to be applied to the axis label, defaults to <syntaxhighlight lang="text" enclose="none">-1.8em</syntaxhighlight>.

Example Usage

Example without |axis-nudge=
Markup Renders as
{{Simple Horizontal timeline
|from=-2000
|to=2000
|inc=500
|row1=scale
}}
{{#invoke:Horizontal timeline | showTimeLine | from=-2000 |to=2000 }}
Example with |axis-nudge= and label formating
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
}}
{{#invoke:Horizontal timeline | showTimeLine | from=-2000 |to=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: <syntaxhighlight lang="text" enclose="none">colour</syntaxhighlight> or <syntaxhighlight lang="text" enclose="none">color</syntaxhighlight> both are acceptable variations for the whole module.
  • |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 the <syntaxhighlight lang="text" enclose="none">attribute</syntaxhighlight> value for ith bar on the nth row.
  • Here subscript <syntaxhighlight lang="text" enclose="none">n</syntaxhighlight> is a positive number used to group rows and their attributed. They may not be continious. But are displayed in ascending order.
  • Subscript <syntaxhighlight lang="text" enclose="none">i</syntaxhighlight> is same as <syntaxhighlight lang="text" enclose="none">n</syntaxhighlight> but is used to group bar on a specific row.

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 than <syntaxhighlight lang="text" enclose="none">row</syntaxhighlight>. 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

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 to <syntaxhighlight lang="text" enclose="none">0em</syntaxhighlight>
  • |rown-i-arrow= Specifies the arrow Character. Defaults to <syntaxhighlight lang="text" enclose="none">↓</syntaxhighlight>

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

}}
{{#invoke:Horizontal timeline | showTimeLine | from=-600 |to=0 }}

Note: |row1-5-lift= is missing. Same as n, i does not have to be continious.

Usage Tips

Examples

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 mordern 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.

See also