Help:EasyTimeline syntax: Difference between revisions

Revision as of 14:23, 10 June 2017

Latest revision as of 20:35, 17 March 2025

(34 intermediate revisions by 15 users not shown)

Line 1:

{{Accessibility dispute|reason=Text is way too small and distorted to be legible at default size}}{{Wikipedia how-to|H:ET}}

The [[Wikipedia:EasyTimeline|EasyTimeline]] feature produces an embedded [[Help:Images and other uploaded files|image]] from wikitext. The image can be a one-dimensional diagram (horizontally or vertically), or a two-dimensional one. The name "EasyTimeline" refers to the possibility to apply the feature with a time scale horizontally or vertically, possibly with another parameter in the other direction, but there are also various other possibilities.

Line 95:

'''Data blocks:''' some commands, like [[#BarData|BarData]], [[#PlotData|PlotData]], [[#TextData|TextData]], [[#Colors|Colors]] expect a ''data block'' consisting of one or more ''data lines''. Data lines should start with one or more spaces. A data block is considered complete when a line

starting with a non-space is encountered, (exception:unless emptythat linesnon-space areis the comment character #.

Since empty lines are ignored, they may be used to group related data lines within a block).

Attributes in a data block can conceptually be divided into ''parameters'' and ''data items''. Data blocks can contain parameters and data items intermingled.

Line 141:

----

== Command Referencereference ==

For each command the valid attributes are listed. Some commands and/or

attributes are optional (O).

Line 301:

</td>

</tr></table>

----

Line 330:

;bar : defines the bar id. Other commands (notably [[#PlotData|PlotData]]) will expect this id for reference. This will also be the label to be shown along the axis, unless attribute ''text'' is present. The bar id should not contain any spaces: use underscores instead, these will be converted to spaces, as with article titles.

;text (O) : When specified this specifies the text to be presented along the axis, instead of the bar id. See also rules for [[#Text Inputinput|text input]]. The text may include one embedded link (see '''Note 1''').

;link (O) : Specify a web link (see '''Note 1''') (URL). The label along the axis will be shown as a blue clickable link.

Line 364:

;* rgb (red,green,blue): specify 3 numbers between 0 (minimal) and 1 (maximal)

;* gray (value): specify a number between 0 (black) and 1 (white)

;legend (O) : Specifies the text that should be displayed in the legend for this color. If this attribute is omitted no entry will appear in the legend at all. See [[#Text Inputinput|Text Inputinput]] for rules.

<small>Example:</small>

Line 478:

You can draw lines in any direction. The following options are available:

*'''Perpendicular to the time axis''' with arbitrary start and stop points: <code>'''at''':''date'' '''frompos''':''position'' '''tillpos''':''position''</code>

*'''Parallel to the time axis''' with arbitrary start and stop points <code>'''from''':''date'' '''till''':''date'' '''atpos''':''position''</code>

*'''In any direction''' with arbitrary start and stop points: <code>'''points''':(x1,y1)(x2,y2)</code>

Attributes '''at''', '''from''' and '''till''' expect a date or year, in compliance with the specified [[#DateFormat|DateFormat]].<br />

Line 516:

points:(100,20)(170,105) color:blue width:3

</timeline>

<syntaxhighlight lang="unixconfig" line style="font-size:90%">

<pre>

LineData =

layer:front # all lines in front of bars unless stated otherwise

Line 524:

from:5 till:8 atpos:50 color:red # parallel to time axis

points:(100,20)(170,105) color:blue width:3 # from one arbitrary absolute position to another, extra thick

</syntaxhighlight>

</pre>

::: <small>''Note that in the above example those "absolute positions" are plotted in the context of'' <code>ImageSize = width:200 height:120</code> ''and'' <code>PlotArea = left:20 right:10 top:10 bottom:20</code>.</small>

Line 590:

<small>Examples:</small>

<pre>

DateFormat = dd/mm/yyyy

Period = from:01/01/1939 till:02/09/1945

PlotData=

width:15

bar:Japan from:start till:19/02/1945 color:JT

bar:Japan from:1901/0209/19451939 till:1427/0309/19451940 color:AIgreen

bar:Japan from:0227/09/19451940 till:end 19/02/1945 color:AOyellow

bar:Japan from:19/02/1945 till:14/03/1945 color:blue

bar:Japan from:02/09/1945 till:end color:red

at:07/12/1941 shift:(0,-152) text:"<-- WW2Attack reacheson AsiaPearl Harbor"

</pre>

<timeline>

ImageSize = width:500 height:50

PlotArea = left:20 right:10 top:10 bottom:20

TimeAxis = orientation:horizontal

AlignBars = justify

DateFormat = dd/mm/yyyy

Period = from:01/01/1939 till:02/09/1945

ScaleMajor = grid:red unit:year increment:1 start:01/01/1939

ScaleMinor = grid:blue unit:month increment:1 start:01/01/1939

PlotData=

width:15

bar:Japan from:01/09/1939 till:27/09/1940 color:green

bar:Japan from:27/09/1940 till:19/02/1945 color:yellow

bar:Japan from:19/02/1945 till:14/03/1945 color:blue

bar:Japan from:02/09/1945 till:end color:red

at:07/12/1941 shift:(0,-2) text:"<-- Attack on Pearl Harbor"

</timeline>

==== Bar related attributes ====

Line 602 ⟶ 626:

:When command [[#BarData|BarData]] has not been used, bars will be drawn in the order in which they occur in any [[#PlotData|PlotData]] data block. The id specified here will also be the text presented along the axis, next to the bar.

:When command BarData has been used, bars will presented in the order specified there, also the bar id specified here will be validated against that list. Also the text presented along the axis will depend on the definition in [[#BarData|BarData]].

;barset : Restarts the bar display "from the top", allowing multiple bars on the same line. Syntax: <ttsamp>barset:name</ttsamp><br />Blank lines may be added to skip over lines that you do not wish to add to with declarations such as <ttsamp>at:1234</ttsamp> with no further attributes.

;color : Specifies the color is which the bar should be drawn.

:The color id specified should be defined first with command [[#Colors|Colors]].

Line 633 ⟶ 657:

==== Text attributes ====

;text : Defines a text that should be plotted on or near a bar. The anchor position can be defined either explicitly with attribute "<code>at</code>", or implicitly with attributes "<code>from</code>" and "<code>till</code>".

:In the latter case the text will be positioned in the middle of the defined bar segment. See also [[#Text Inputinput|Text Input]] for rules

:The text may include embedded links (see '''Notes 1 & 2''') for use in clickable maps.

;textcolor (O) : Defines the color of the text. The color id specified should be defined first with command [[#Colors|Colors]]. When not specified color black will be assumed.

;fontsize (O) : Specify a point size between 6 and 30, or (preferably) one of tags XS, S (default), M, L or XL. See [[#Font Supportsupport|Font Supportsupport]] for more details.

;align (O) : Specify center (default), left or right.

;link (O) : Specify a web link (see '''Note 1''') (URL) for use in clickable maps. The text will be shown as a blue clickable link.

Line 724 ⟶ 748:

=== TextData ===

Used to define a text block that can be positioned anywhere on the chart.

;text : The actual text. See also [[#Text Inputinput|Text Input]] for rules. The text may include embedded links (see '''Notes 1 & 2''').

;pos : Defines the top-left corner of the text block in absolute or relative [[#Measurements|measurements]]. Define as ''pos:(x,y)''.

;link (O) : Specify a web link (see '''Note 1''') (URL) for use in clickable maps. The label along the axis will be shown as a blue clickable link.

;textcolor (O) : Defines the color of the text. The color id specified should be defined first using [[#Colors|Colors]]. When not specified, the color is black.

;fontsize (O) : Specify a point size between 6 and 30, or (preferably) one of tags '''XS''', '''S''' (default), '''M''', '''L''' or '''XL''' (see [[#Font Supportsupport|Font Supportsupport]] for more details).

;tabs (O) : Defines position and alignment for tab character: '''^''' (caret). Specify multiple tab settings as tabs: (''x¹-a¹,x²-a²,x³-a³'', etc..) where

:*''xⁿ'' is the horizontal displacement in absolute measurements from the left side of the text

Line 738 ⟶ 762:

<small>Example:</small>

<sourcesyntaxhighlight lang="moin">

TextData =

pos:(20,67) textcolor:black fontsize:S

tabs:(10-right,14-left,50-left,90-left,230-left)

text:^1^1940^27/9^Germany,Italy and Japan sign [[Tripartite Pact]]

text:^10^1944^1-22/7^Bretton Woods 44 nations establish

text:^^^^^IMF and World Bank

</syntaxhighlight>

</source>

will be shown as:

<timeline font="unifont">

ImageSize = width:400 height:70

PlotArea = width:400 height:70 left:0 bottom:0

Line 758 ⟶ 782:

pos:(20,67) textcolor:black fontsize:S

tabs:(10-right,14-left,50-left,90-left,230-left)

text:^1^1940^27/9^Germany,Italy and Japan sign [[Tripartite Pact]]

text:^10^1944^1-22/7^Bretton Woods 44 nations establish

text:^^^^^IMF and World Bank

Line 770 ⟶ 794:

:Currently only format yyyy (default) is supported. More formats may follow.

;orientation (O) : Specify hor[izontal] (default) or ver[tical].

;order (O) : specify ''reverse'' as the option to reverse the time flow

<small>Example:</small>

<pre>

Line 828 ⟶ 851:

</pre>

=== Text Inputinput ===

Text input is subject to a few rules:

:1). Only a subset of unicode[[Unicode]] is allowed for font rendering, but unicodeUnicode in links should work for all characters. See also [[#Font Supportsupport|fontFont support]].

:2). When text should contain spaces, either specify these by using underscores or place the text between double quotes.

:Exception: when the text attribute is the last attribute on a line, spaces are allowed (no confusion will arise where the text stops and the next attribute starts, that is—to be precise—when no colons occur in the text).

Line 849 ⟶ 872:

</pre>

:3). In data lines following command [[#TextData|TextData]] one character has special meaning:

:'''^''' (caret) means ''tab''

<small>Example showing tabs:</small>

<syntaxhighlight lang="moin">

<pre>

TextData =

tabs:(4-right,12-right,14-left,34-left)

Line 865 ⟶ 888:

# 10 1-22/7 Bretton Woods 44 nations establish

# IMF and World Bank

</syntaxhighlight>

</pre>

----

Line 891 ⟶ 914:

</pre>

will be shown as:

<timeline font="unifont">

ImageSize = width:380 height:25

PlotArea = width:380 height:25 left:0 bottom:0

Line 906 ⟶ 929:

</pre>

will be shown as:

<timeline font="unifont">

ImageSize = width:380 height:25

PlotArea = width:380 height:25 left:0 bottom:0

Line 922 ⟶ 945:

</pre>

will be shown as:

<timeline font="unifont">

ImageSize = width:380 height:25

PlotArea = width:380 height:25 left:0 bottom:0

Line 940 ⟶ 963:

</pre>

and similar with nl: and m: give:

<timeline font="unifont">

ImageSize = width:380 height:25

PlotArea = width:380 height:25 left:0 bottom:0

Line 952 ⟶ 975:

</timeline>

<timeline font="unifont">

ImageSize = width:380 height:25

PlotArea = width:380 height:25 left:0 bottom:0

Line 964 ⟶ 987:

</timeline>

<timeline font="unifont">

ImageSize = width:380 height:25

PlotArea = width:380 height:25 left:0 bottom:0

Line 996 ⟶ 1,019:

----

== Font Supportsupport ==

Timeline has somewhat limited unicodeUnicode support. It uses FreeSans.ttf font, which supports a subset of all the possible glyphs (it supports [[Cyrillic alphabet]], east-Europe diactrics and kana for instance, but lacks [[kanji]]). NoYou othercan fontsalso arespecify available{{para|font|freesanswmf}} or {{para|font|unifont}} to specify a different font, or do the rendering in a completely different atway thiswith time{{para|method|svg2png}}.

<small>Example:</small>

<sourcesyntaxhighlight lang="texttf">

ImageSize = width:180 height:90

PlotArea = width:180 height:90 left:0 bottom:0

Line 1,012 ⟶ 1,035:

pos:(10,70) fontsize:L text:"Zażółć gęślą jaźń"

pos:(10,50) fontsize:L text:"ウィキペディア"

</syntaxhighlight>

</source>

will be shown as:

<timeline>

Line 1,050 ⟶ 1,073:

This documentation is originally a wikified version of the [http://infodisiac.com/Wikipedia/EasyTimeline/Syntax.htm original EasyTimeline documentation].

== EasyTimeline code with a template parameter is not allowed parameters==

To render template parameters you must use <code><nowiki>{{#tag:</nowiki></code> syntax. As an example:

{{Template talk:Etl}}

<pre>

{{#tag:timeline|

ImageSize = width:280 height:25

PlotArea = width:280 height:25 left:0 bottom:0

TimeAxis = orientation:vertical # dummy, required

Period = from:0 till:1 # dummy, required

Colors =

id:canvas value:rgb(1,1,0.85)

BackgroundColors = canvas:canvas

TextData =

pos:(10,10) fontsize:XL text:"a"

}}

</pre>

renders as

{{#tag:timeline|

Bug fixed by Brion Vibber on 2008-12-10. <small>Note that some editors were finding timelines are not rendering properly on Wikipedia, (See http://www.mediawiki.org/wiki/Extension_talk:EasyTimeline#possible_bug) and bug: [[bugzilla:16085]] has been reported. -[[User:84user|84user]] ([[User talk:84user|talk]]) 01:20, 4 November 2008 (UTC)<small>

ImageSize = width:280 height:25

PlotArea = width:280 height:25 left:0 bottom:0

TimeAxis = orientation:vertical # dummy, required

Period = from:0 till:1 # dummy, required

Colors =

id:canvas value:rgb(1,1,0.85)

BackgroundColors = canvas:canvas

TextData =

pos:(10,10) fontsize:XL text:"a"

}}

Example a political timeline

<pre>

{{#tag:timeline|

ImageSize = width:1010 height:auto barincrement:25

PlotArea = top:30 bottom:90 right:130 left:3

AlignBars = late

Define $today = {{#time:d/m/Y}}

DateFormat = dd/mm/yyyy

Period = from:01/01/1865 till:31/12/{{#time:Y|+1 year}}

TimeAxis = orientation:horizontal

Colors =

id:Liberal value:rgb(0.92,0.43,0.42) legend: Liberal_Party_of_Canada

id:OldConservative value:rgb(0.6,0.6,1) legend: Conservative_Party_→_Progressive_Conservative_Party

id:Conservative value:rgb(0.39,0.58,0.93) legend: Conservative_Party_of_Canada

id:gray1 value:gray(0.8)

id:gray2 value:gray(0.9)

id:grid value:gray(0.5)

ScaleMajor = gridcolor:gray1 unit:year increment:10 start:1870

ScaleMinor = gridcolor:gray2 unit:year increment:2 start:1868

Legend = columns:1 left:150 top:60 columnwidth:230

TextData =

pos:(20,65) textcolor:black fontsize:M

text:"Political parties:"

BarData =

bar:Macdonald

bar:Mackenzie

bar:Abbott

bar:JSDT

bar:Bowell

bar:Tupper

bar:Laurier

bar:Borden

bar:Meighen

bar:WLMK

bar:Bennett

bar:St.Laurent

bar:Diefenbaker

bar:Pearson

bar:PTrudeau

bar:Clark

bar:Turner

bar:Mulroney

bar:Campbell

bar:Chretien

bar:Martin

bar:Harper

bar:JTrudeau

bar:Carney

PlotData=

width:7 align:left fontsize:S shift:(5,-4) anchor:till

bar:Macdonald

from: 01/07/1867 till: 05/11/1873 color:OldConservative

from: 17/10/1878 till: 06/06/1891 color:OldConservative text:"[[John A. Macdonald]]" fontsize:10

bar:Mackenzie

from: 07/11/1873 till: 08/10/1878 color:Liberal text:"[[Alexander Mackenzie (politician)|Alexander Mackenzie]]" fontsize:10

bar:Abbott

from: 16/06/1891 till: 24/11/1892 color:OldConservative text:"[[John Abbott]]" fontsize:10

bar:JSDT

from: 05/12/1892 till: 12/12/1894 color:OldConservative text:"[[John Sparrow David Thompson]]" fontsize:10

bar:Bowell

from: 21/12/1894 till: 27/04/1896 color:OldConservative text:"[[Mackenzie Bowell]]" fontsize:10

bar:Tupper

from: 01/05/1896 till: 08/07/1896 color:OldConservative text:"[[Charles Tupper]]" fontsize:10

bar:Laurier

from: 11/07/1896 till: 06/10/1911 color:Liberal text:"[[Wilfrid Laurier]]" fontsize:10

bar:Borden

from: 10/10/1911 till: 10/07/1920 color:OldConservative text:"[[Robert Borden]]" fontsize:10

bar:Meighen

from: 10/07/1920 till: 29/12/1921 color:OldConservative

from: 28/06/1926 till: 29/06/1926 color:OldConservative text:"[[Arthur Meighen]]" fontsize:10

bar:WLMK

from: 29/12/1921 till: 28/06/1926 color:Liberal

from: 25/09/1926 till: 07/08/1930 color:Liberal

from: 23/10/1935 till: 15/11/1948 color:Liberal text:"[[William Lyon Mackenzie King]]" fontsize:10

bar:Bennett

from: 07/08/1930 till: 23/10/1935 color:OldConservative text:"[[R. B. Bennett]]" fontsize:10

bar:St.Laurent

from: 15/11/1948 till: 21/06/1957 color:Liberal text:"[[Louis St. Laurent]]" fontsize:10

bar:Diefenbaker

from: 21/06/1957 till: 22/04/1963 color:OldConservative text:"[[John Diefenbaker]]" fontsize:10

bar:Pearson

from: 22/04/1963 till: 20/04/1968 color:Liberal text:"[[Lester B. Pearson]]" fontsize:10

bar:PTrudeau

from: 20/04/1968 till: 04/06/1979 color:Liberal

from: 03/03/1980 till: 30/06/1984 color:Liberal text:"[[Pierre Trudeau]]" fontsize:10

bar:Clark

from: 04/06/1979 till: 03/03/1980 color:OldConservative text:"[[Joe Clark]]" fontsize:10

bar:Turner

from: 30/06/1984 till: 17/09/1984 color:Liberal text:"[[John Turner]]" fontsize:10

bar:Mulroney

from: 17/09/1984 till: 25/06/1993 color:OldConservative text:"[[Brian Mulroney]]" fontsize:10

bar:Campbell

from: 25/06/1993 till: 04/11/1993 color:OldConservative text:"[[Kim Campbell]]" fontsize:10

bar:Chretien

from: 04/11/1993 till: 12/12/2003 color:Liberal text:"[[Jean Chrétien]]" fontsize:10

bar:Martin

from: 12/12/2003 till: 06/02/2006 color:Liberal text:"[[Paul Martin]]" fontsize:10

bar:Harper

from: 06/02/2006 till: 04/11/2015 color:Conservative text:"[[Stephen Harper]]" fontsize:10

bar:JTrudeau

from: 04/11/2015 till: 14/03/2025 color:Liberal text:"[[Justin Trudeau]]" fontsize:10

bar:Carney

from: 14/03/2025 till: $today color:Liberal text:"[[Mark Carney]]" fontsize:10

}}

</pre>

renders as

{{#tag:timeline|

ImageSize = width:1010 height:auto barincrement:25

PlotArea = top:30 bottom:90 right:130 left:3

AlignBars = late

Define $today = {{#time:d/m/Y}}

DateFormat = dd/mm/yyyy

Period = from:01/01/1865 till:31/12/{{#time:Y|+1 year}}

TimeAxis = orientation:horizontal

Colors =

id:Liberal value:rgb(0.92,0.43,0.42) legend: Liberal_Party_of_Canada

id:OldConservative value:rgb(0.6,0.6,1) legend: Conservative_Party_→_Progressive_Conservative_Party

id:Conservative value:rgb(0.39,0.58,0.93) legend: Conservative_Party_of_Canada

id:gray1 value:gray(0.8)

id:gray2 value:gray(0.9)

id:grid value:gray(0.5)

ScaleMajor = gridcolor:gray1 unit:year increment:10 start:1870

ScaleMinor = gridcolor:gray2 unit:year increment:2 start:1868

Legend = columns:1 left:150 top:60 columnwidth:230

TextData =

pos:(20,65) textcolor:black fontsize:M

text:"Political parties:"

BarData =

bar:Macdonald

bar:Mackenzie

bar:Abbott

bar:JSDT

bar:Bowell

bar:Tupper

bar:Laurier

bar:Borden

bar:Meighen

bar:WLMK

bar:Bennett

bar:St.Laurent

bar:Diefenbaker

bar:Pearson

bar:PTrudeau

bar:Clark

bar:Turner

bar:Mulroney

bar:Campbell

bar:Chretien

bar:Martin

bar:Harper

bar:JTrudeau

bar:Carney

PlotData=

width:7 align:left fontsize:S shift:(5,-4) anchor:till

bar:Macdonald

from: 01/07/1867 till: 05/11/1873 color:OldConservative

from: 17/10/1878 till: 06/06/1891 color:OldConservative text:"[[John A. Macdonald]]" fontsize:10

bar:Mackenzie

from: 07/11/1873 till: 08/10/1878 color:Liberal text:"[[Alexander Mackenzie (politician)|Alexander Mackenzie]]" fontsize:10

bar:Abbott

from: 16/06/1891 till: 24/11/1892 color:OldConservative text:"[[John Abbott]]" fontsize:10

bar:JSDT

from: 05/12/1892 till: 12/12/1894 color:OldConservative text:"[[John Sparrow David Thompson]]" fontsize:10

bar:Bowell

from: 21/12/1894 till: 27/04/1896 color:OldConservative text:"[[Mackenzie Bowell]]" fontsize:10

bar:Tupper

from: 01/05/1896 till: 08/07/1896 color:OldConservative text:"[[Charles Tupper]]" fontsize:10

bar:Laurier

from: 11/07/1896 till: 06/10/1911 color:Liberal text:"[[Wilfrid Laurier]]" fontsize:10

bar:Borden

from: 10/10/1911 till: 10/07/1920 color:OldConservative text:"[[Robert Borden]]" fontsize:10

bar:Meighen

from: 10/07/1920 till: 29/12/1921 color:OldConservative

from: 28/06/1926 till: 29/06/1926 color:OldConservative text:"[[Arthur Meighen]]" fontsize:10

bar:WLMK

from: 29/12/1921 till: 28/06/1926 color:Liberal

from: 25/09/1926 till: 07/08/1930 color:Liberal

from: 23/10/1935 till: 15/11/1948 color:Liberal text:"[[William Lyon Mackenzie King]]" fontsize:10

bar:Bennett

from: 07/08/1930 till: 23/10/1935 color:OldConservative text:"[[R. B. Bennett]]" fontsize:10

bar:St.Laurent

from: 15/11/1948 till: 21/06/1957 color:Liberal text:"[[Louis St. Laurent]]" fontsize:10

bar:Diefenbaker

from: 21/06/1957 till: 22/04/1963 color:OldConservative text:"[[John Diefenbaker]]" fontsize:10

bar:Pearson

from: 22/04/1963 till: 20/04/1968 color:Liberal text:"[[Lester B. Pearson]]" fontsize:10

bar:PTrudeau

from: 20/04/1968 till: 04/06/1979 color:Liberal

from: 03/03/1980 till: 30/06/1984 color:Liberal text:"[[Pierre Trudeau]]" fontsize:10

bar:Clark

from: 04/06/1979 till: 03/03/1980 color:OldConservative text:"[[Joe Clark]]" fontsize:10

bar:Turner

from: 30/06/1984 till: 17/09/1984 color:Liberal text:"[[John Turner]]" fontsize:10

bar:Mulroney

from: 17/09/1984 till: 25/06/1993 color:OldConservative text:"[[Brian Mulroney]]" fontsize:10

bar:Campbell

from: 25/06/1993 till: 04/11/1993 color:OldConservative text:"[[Kim Campbell]]" fontsize:10

bar:Chretien

from: 04/11/1993 till: 12/12/2003 color:Liberal text:"[[Jean Chrétien]]" fontsize:10

bar:Martin

from: 12/12/2003 till: 06/02/2006 color:Liberal text:"[[Paul Martin]]" fontsize:10

bar:Harper

from: 06/02/2006 till: 04/11/2015 color:Conservative text:"[[Stephen Harper]]" fontsize:10

bar:JTrudeau

from: 04/11/2015 till: 14/03/2025 color:Liberal text:"[[Justin Trudeau]]" fontsize:10

bar:Carney

from: 14/03/2025 till: $today color:Liberal text:"[[Mark Carney]]" fontsize:10

}}

{{Wikipedia technical help|collapsed}}