Difference between revisions of "Template:Graphical timeline/doc"

From blackwiki
Jump to navigation Jump to search
(→‎General parameters: Added instance-id parameter.)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS  
 
 
{{nutshell|
 
*Use {{tl|Include timeline}} in the main article for assisted generation.
 
*Type <code><nowiki>{{Graphical timeline|help=on}}</nowiki></code> into a page, then press preview for a ready-to-go template.
 
*Check that complicated timelines display as you expect in both [[internet explorer|IE]] and [[Firefox]]}}
 
 
 
==The easy way==
 
Type {{tlx|include timeline}} in your article, press preview, and follow the link generated. You'll be presented with a ready-to-go template; once this is finished, return to your article, and { {include timeline} } will display your timeline.
 
 
 
==Development==
 
Whilst I've tested this template as thoroughly as I can, I suspect it could be further improved. If you find any glitches or areas you wish you could customise, please let me know! ''[[User:Verisimilus|Verisimilus]]''&nbsp;'''<small>[[User talk:Verisimilus|T]]</small>''' 12:02, 12 June 2007 (UTC)
 
 
 
==Template function==
 
This template provides an intuitive, user-friendly and flexible way to insert timelines into articles.
 
It's designed to require the minimum number of variables, and to reside within a table - although a margin can be added.
 
 
 
==Why use this template?==
 
The alternative to this template is [[m:EasyTimeline]], using the <nowiki><template></nowiki> syntax. EasyTimeline has the following weaknesses:
 
 
 
* Pixelated image produced, which looks different and increases page load time
 
* Long set-up time - taking 30 minutes plus even when you know what you are doing
 
* Impenetrable code requiring precise syntax
 
* Difficult to place bars exactly where you want them
 
* Changing minimum dates and sizes requires modification in many places
 
* Everything must be specified - nothing is automatic
 
* It is not scalable - it does not enlarge with text size.
 
 
 
 
==Using the template==
 
==Using the template==
  
Line 120: Line 93:
  
 
===Bars===
 
===Bars===
{| class="wikitable sortable"
+
{| class="wikitable|bar9-to=-524
!Parameter
 
! Function
 
|-
 
|width
 
| width of the timeline
 
|-
 
|+ Bar parameters
 
|}
 
 
 
===Legend===
 
{| class="wikitable sortable"
 
!Parameter
 
! Function
 
|-
 
|width
 
| width of the timeline
 
|-
 
|+ Legend parameters
 
|}
 
 
 
===Notes===
 
{| class="wikitable sortable"
 
!Parameter
 
! Function
 
|-
 
|width
 
| width of the timeline
 
|-
 
|+ Note parameters
 
|}
 
 
 
==In use: an example==
 
The code on the left produces the timeline on the right, which is deliberately horrendous in order to demonstrate the limitations of the template. For a working example, I'd recommend looking at [[Ediacaran biota]].
 
 
 
{{Graphical timeline
 
 
 
|title=Example Timeline
 
|align=right
 
 
 
|plot-colour=#bbeebb
 
 
 
|from=-550
 
|to=-500
 
|scale-increment=10
 
 
 
|width=10
 
|height=250
 
|height-unit=px
 
 
 
|legend1=[[Phanerozoic]]
 
 
 
|bar1-from=-542
 
|bar1-left=0
 
|bar1-right=0.1
 
 
 
|legend2=[[Precambrian]]
 
 
 
|bar2-to=-542
 
|bar2-left=0
 
|bar2-right=0.2
 
 
 
 
 
|legend3=[[Infracambrian]]
 
|legend3-colour=#e0aacc
 
 
 
|bar3-to=-534
 
|bar3-left=0.1
 
|bar3-right=0.2
 
|bar3-colour=#e0aacc
 
 
 
|<!-- If this was bar 4 it would be overlapped by the Botomian bar -->
 
|bar14-from=-530
 
|bar14-to=-520
 
|bar14-left=0.95
 
|bar14-right=1.05
 
|bar14-colour=red
 
|legend14=Cambrian explosion
 
 
 
|<!--Epochs & stages-->
 
|bar5-text=[[Ediacaran]]
 
|bar5-to=-540
 
|bar5-left=0.2
 
|bar5-border-width=1
 
|bar5-colour=#cc9999
 
 
 
|bar6-text=[[Nemakit-Daldynian]]
 
|bar6-from=-542
 
|bar6-to=-534
 
|bar6-left=0.2
 
|bar6-border-width=0.1
 
|bar6-colour=#99cc99
 
 
 
|bar7-text=[[Tommotian]]
 
|bar7-from=-534
 
|bar7-to=-530
 
|bar7-left=0.1
 
|bar7-colour=#99cc99
 
|bar7-border-width=0.1
 
 
 
|bar8-from=-530.1
 
|bar8-to=-529.9
 
|bar8-left=0.2
 
|bar8-colour=black
 
 
 
|bar9-text=[[Atdabanian]]
 
|bar9-from=-530
 
|bar9-to=-524
 
 
|bar9-left=0.1
 
|bar9-left=0.1
 
|bar9-right=0.95
 
|bar9-right=0.95

Revision as of 10:14, 5 June 2015

|bar14-from=-530 |bar14-to=-520 |bar14-left=0.95 |bar14-right=1.05 |bar14-colour=red |legend14=Cambrian explosion

| |bar5-text=Ediacaran |bar5-to=-540 |bar5-left=0.2 |bar5-border-width=1 |bar5-border-colour= #996666 |bar5-colour=#cc9999

|bar6-text=Nemakit-Daldynian |bar6-from=-542 |bar6-to=-534 |bar6-left=0.2 |bar6-border-width=0.1 |bar6-colour=#99cc99

|bar7-text=Tommotian |bar7-from=-534 |bar7-to=-530 |bar7-left=0.1 |bar7-colour=#99cc99 |bar7-border-width=0.1

|bar8-from=-530.1 |bar8-to=-529.9 |bar8-left=0.2 |bar8-colour=black

|bar9-text=Atdabanian |bar9-from=-530 |bar9-to=-524 |bar9-left=0.1 |bar9-right=0.95 |bar9-colour=#99cc99

|bar10-text=Botomian |bar10-from=-524 |bar10-to=-518 |bar10-left=0.1 |bar10-colour=#99cc99 |bar10-border-width=0.1

|bar11-text=Toyonian |bar11-from=-518 |bar11-to=-513 |bar11-left=0.1 |bar11-border-width=0.1 |bar11-colour=#99cc99


|note1=Base of the Cambrian |note1-at=-542 |note1-colour=green

|note2=Middle Cambrian |note2-nudge-left=8.5 |note2-nudge-down=0 |note2-at=-507 |note2-remove-arrow=yes

|caption=An approximate time-scale of events
at the base of the Cambrian Period.
Axis scale is in millions of years ago. }}

Notes on the example

  • {{!}} must be used wherever you want a | to appear (e.g. the caption)
  • If you do not specify when a bar should start or end, it will continue to the edge of the plot
  • Text should not be too long for the bar
  • The way that overflowing text wraps is also handled differently in the two borders - it pokes out of the right of the bar on Firefox, but is wrapped within it by IE. Try to manually enter newlines when required rather than relying on browsers to sort it out. Or position a note over the bar - check out note2, which is nudged left over the plot background.