docchronosys en

Download Docchronosys En

Post on 09-Jul-2016

4 views

Category:

Documents

2 download

Embed Size (px)

TRANSCRIPT

  • ChronosysDraw timelines diagrams !

    1982 2050

    2011chronosyss creation

    Mathieu Longmlong.tex@hotmail.fr

  • 1

    Contents

    1 Introduction 2

    2 First use 32.1 Main function: \startchronology 32.2 Events: \chronoevent 32.3 Periods: \chronoperiode 42.4 Automatic graduation : \chronograduation 5

    3 Time-lines customization 73.1 \startchronology 73.1.1 Example 73.1.2 Dierent options 73.1.3 Summary 93.2 \chronoperiode 103.2.1 Example 103.2.2 The colour of the background 103.2.3 Colours alternation 103.2.4 Dierent options 113.2.5 Summary 133.3 \chronoevent 143.3.1 Example 143.3.2 Specicities 143.3.2.1 The colour box of the text 143.3.2.2 A new way for specifying the date 153.3.3 Dierent options 163.3.4 Summary 18

    4 Permanent changes 194.1 Creating new commands 194.2 Modify the default values 19

    5 Index 22

  • Introduction

    2

    1 Introduction

    Chronosys is distributed under the LaTeX Project Public License.You may use itfor drawing timelines. It uses the tikz1 package for drawing. You need to have-TEX to use it.

    This package is version 1.2, others versions might be created later.

    It is recommended not to load the color.tex le if you use plain TEX.

    You can load chronosys by :

    \usemodule[chronosys] in ConTEXt.

    \usepackagechronosys in LATEX.

    \input chronosys in plain TEX.

    updates history

    1.10 : added possibility to change the alignment of the timeline on the page,change the width of the text of the label of events, improved support for eventsplaced above the frieze, added the ability to colour the text background of eventsand periods.

    1.15 : added possibility to create owns new commands, to graduate automat-ically the timeline, change the alternation of colours periods and xes somecompatibility issues.

    1.2 (actual version) : reduces the use of the module tikz at least possible,remove the former limitation of the impossibility of switching the default valueof textwidth. With ConTEXt, added possibility using MetaPost

    2 instead oftikz (and conversely, reuse tikz instead of MetaPost) using the commands\chronoswitchtomodeMP and \chronoswitchtomodeTikz ; with the Mark IVversion using MetaPost default.

    I wish to thank Gonalo Pereira for his idea about colouring in white thebackground of the labels of events and periods to avoid them to be mixed withother vertical straights.

    1 for more informations on tikz, see http://mirror.ctan.org/graphics/pgf/base/doc/generic/pgf/pgfmanual.pdf

    2 for more informations on MetaPost, see http://www.tug.org/docs/metapost/mpman.pdf

  • First use Events: \chronoevent

    3

    2 First use

    2.1 Main function: \startchronology

    The control sequence \startchronology is the rst one you need to know.3 : itstarts the chronological frieze :

    \startchronology[...=...]

    See 3.1.3 to have the dierent possible options

    The next one is \stopchronology4, it ends the timeline.

    \stopchronology

    Lets have a look on the result :

    \startchronology\stopchronology

    0 2012

    You can see the timeline is on all the pages width, furthermore it starts at 0and ends at the current year 2012 when this document was compiled. Chronosyswill compare these years with the events and periods you will give him (see 2.2 and2.3).

    Now lets learn how to add events on the timeline.

    2.2 Events: \chronoevent

    You can add events with \chronoevent. This control sequence needs two arguments:the rst one is the date of the event5 and the second is the label of this event.

    \chronoevent[...=...]{1.}{2.}

    ...=... options (see 3.3.4)1. date (number)2. label

    3 There are \begin{chronology} and \end{chronology} for LATEX4 or \end{chronology}5 you can go to 3.3.2.2 to see another way of specifying the date

  • First use Periods: \chronoperiode

    4

    For instance:

    \startchronology\chronoevent{1977}{\TeX's creation}\stopchronology

    0 2012

    1977TEXs creation

    The event appears between 0 et 2012, proportionally with his gap with 0. Youcan also give several events:

    \startchronology\chronoevent{476}{Fall of the Roman empire}\chronoevent{1492}{Discovery of America}\chronoevent{1969}{first steps on the Moon}\stopchronology

    0 2012

    476Fall of the Roman empire

    1492Discovery of America

    1969rst steps on the Moon

    N.B.: the font size has been reduced to avoid label to overlap; a best way willbe given further (see 3.3.4).

    Chronosys wont generate any error if the events date is out of the starting yearand ending year, however it will be ignored. The way of customize the timeline,especially the starting year and ending year, will be seen further(see 3.1.3).

    2.3 Periods: \chronoperiode

    You can also add one period (or several6) on the frieze with \chronoperiode.

    \chronoperiode[...=...]{1.}{2.}{3.}

    ...=... options (see 3.2.5)1. date of the beginning (number)

    6 If two periods are overlapping, the last one will overlap the other

  • First use Automatic graduation : \chronograduation

    5

    2. date of the end (number)3. label

    \startchronology\chronoperiode{1000}{1999}{2\high{nd} Millennium}\chronoperiode{192}{476}{Eastern Roman Empire}\chronoevent{1969}{first steps on the Moon}\stopchronology

    0 2012

    2nd Millennium

    1000 1999

    Eastern Roman Empire

    192 476

    1969rst steps on the Moon

    N.B.: on the period from 1000 to 1999, blue on the timeline, we can now see thevertical straight under the frieze. You can disable it (see 3.3.4), but if you want ityou should place the events after the periods.

    The period appears automatically with colour, and the dates are also visible (see3.2.5 to disable them) and the label. The periods can be automatically coloured in5 colours : blue, red, cyan, purple and yellow, except if the colour is identical to thefriezes one. Of course you can choose the colour of the period (see 3.2.5).

    2.4 Automatic graduation : \chronograduation

    Use \chronograduation to add a graduation on the timeline.

    \chronograduation[style][...=...]{1.}

    style periode or event...=... options (see 3.2.4 et 3.3.3)1. interval (number)

    \startchronology\chronograduation{100}\stopchronology\startchronology\chronograduation[periode][dateselevation=0pt]{100}\stopchronology

    0 2012

    100 200 300 400 500 600 700 800 900 1000 1100 1200 1300 1400 1500 1600 1700 1800 1900 2000

  • First use Automatic graduation : \chronograduation

    6

    0 20120 100100 200 300 400 500 600 700 800 900 1000 1100 1200 1300 1400 1500 1600 1700 1800 1900 2000

  • Time-lines customization \startchronology

    7

    3 Time-lines customization

    3.1 \startchronology

    3.1.1 Example

    \startchronology can have an optional argument in brackets. For example:

    \startchronology[startyear=-800,stopyear=500,color=darkblue,height=7ex,width=\hsize]\chronoevent{-753}{Rome's foundation}\stopchronology

    -800 500

    -753Romes foundation

    3.1.2 Dierent options

    The dierent options of \startchronology are:

    startyear :

    starting year of the timeline. It needs to be a valid number. It is by default 0

    stopyear :

    ending year of the timeline. It also needs to be a valid number. It is the currentyear by default.

    color :

    colour of the frieze. It must be a valid colour. It is black by default.

    height :

    height of the frieze. It must be a valid dimen and it is 0.7pc by default.

  • Time-lines customization \startchronology

    8

    width :

    width of the frieze. It must be a valid dimen and it is \hsize7 by default.

    datesstyle :

    style to apply to dates. It must be a control sequence (it can take one argu-ment, which will be the dates), is empty by default.

    dateselevation :

    height of the dates from the timeline, it must be a valid dimen and it is 20ptpar by default.

    startdate :

    boolean which indicate if the starting year has to be placed. It must be eithertrue or false and it is true by default.

    stopdate :

    boolean which indicate if the ending year has to be placed. It must be eithertrue or false and it is true by default.

    dates :

    boolean which indicate if both dates have to be placed. It must be either trueor false and it is true by default.

    arrow :

    boolean which indicate if an arrowhead has to be placed. It must be either trueor false and it is true by default.

    arrowheight :

    height of the arrowhead. It must be a valid dimen and it is identical to the heightof the timeline by default.

    arrowwidth :

    width of the arrowhead. It encroaches on the entire (height) width of the frieze.It must be a valid dimen and it is 1/10 of the entire width of the timeline (width)by default.

    7 \textwidth in LATEX

  • Time-lines customization \startchronology

    9

    arrowcolor :

    colour of the arrowhead. It must be a colour recognized by the tikz package.It is identical to the colour of the frieze by default.

    box :

    boolean which indicates if the timeline should be passed back with a black line.It must be either true or false and it is false by default.

    align :

    alignment of the timeline on the page. You can choose between right, centerand left. It is center by default.

    3.1.3 Summary

    \startchronology[...=...]

    startyear =

    stopyear =

    color =

    height =

    width =

    datesstyle = or

    dateselevation =

    startdate = or

    stopdate = or

    dates = or

    arrow = or

    arrowheight =

    arrowwidth =

    arrowcolor =

    box = or

    align = or or

    Table 3.1 startchronologys options