Template:Simple horizontal timeline/doc

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 to

  100%
  

  , can be in

  px
  

  or

  em
  

  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 row_n parameter

|rown= specifies how horizontal rows are drawn. You can have as many rows as you want. Subscript are positive integers. 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 of

  timeline
  

  and

  note
  

  rows.

Each of these types of rows have their own attributes specified with an hyphen. For example, the style of a row_n 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

Example without |axis-nudge=

Markup	Renders as
{{Simple Horizontal timeline |from=-2000 |to=2000 |inc=500 |row1=scale }}	│ −2000 │ −1500 │ −1000 │ −500 │ 0 │ 500 │ 1000 │ 1500 │ 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 }}	│ 2000 BC │ 1500 BC │ 1000 BC │ 500 BC │ 0 AD │ 500 AD │ 1000 AD │ 1500 AD │ 2000 AD

Example with |axis-value= and |axis-marker-value=

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:

colour

or

color

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 i^th bar.
• |rown-i-colour= bar colour.
• |rown-i-border= bar border (See Known Issues).

Note on Subscripts:

• |rown-i-<attribute>= denotes the

  attribute
  

  value for i^th bar on the n^th row.
• Here subscript

  n
  

  is 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

  i
  

  is also a positive number which 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

  row
  

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