summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex')
-rw-r--r--Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex130
1 files changed, 71 insertions, 59 deletions
diff --git a/Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex b/Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex
index 6e3dd08d221..1a0277c2320 100644
--- a/Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex
+++ b/Master/texmf-dist/doc/generic/chronosys/docchronosys_en.tex
@@ -1,4 +1,4 @@
-% This is is the english code for the documentation of the `chronosys' package.
+% This is is the code for the english documentation of the `chronosys' package.
%
% The maintener of this work is Mathieu Long.
% email : mlong.tex@hotmail.fr
@@ -42,8 +42,16 @@
\definetyping[typingTEX][option=TEX]
\setuptyping[typingTEX][color=darkblue]
+\setupcolors[state=start]
+\useURL[MetaPost_TUG][http://www.tug.org/docs/metapost/mpman.pdf]
+\useURL[Tikz_CTAN][http://mirror.ctan.org/graphics/pgf/base/doc/generic/pgf/pgfmanual.pdf]
\starttext
+\startmode[mkiv]
+\def\METAPOST{MetaPost}
+\stopmode
+
+
\placebookmarks[chapter,section,subsection][chapter,section]
\usemodule[chronosys]
\startstandardmakeup\switchtobodyfont[myface,16pt]
@@ -68,7 +76,7 @@
\parskip 1cm
\chapter{Introduction}
-\type{Chronosys} is distributed under the LaTeX Project Public License.You may use it for drawing timelines. It uses the \type{tikz} package for drawing. You need to have \ETEX\ to use it.
+\type{Chronosys} is distributed under the LaTeX Project Public License.You may use it for drawing timelines. It uses the \type{tikz}\footnote{for more informations on \type{tikz}, see \from[Tikz_CTAN]} package for drawing. You need to have \ETEX\ to use it.
\blank
\unprotect
This package is version {\unprotect\chron@sysversion\protect}, others versions might be created later.
@@ -78,14 +86,23 @@ It is recommended not to load the \type{color.tex} file if you use plain \TeX.
You can load \type{chronosys} by~:
\startitemize[4]
-\item \type{\usemodule[chronosys]} in \CONTEXT.
-\item \type{\usepackage{chronosys}} in \LaTeX.
-\item \type{\input chronosys} in plain \TeX.
+\item \tex{usemodule[chronosys]} in \CONTEXT.
+\item \tex{usepackage{chronosys}} in \LaTeX.
+\item \tex{input chronosys} in plain \TeX.
\stopitemize
-With the new version you can modify the alignment of the timeline on the page, the width of the labels of the events; it provides a better support
-of the events placed over the timeline, the possibility of colouring the background of the labels of the periods and events, of creating new commands
-and corrects problems of compatibility.
+\subject{updates' history}
+\startitemize[1]
+\item 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 events placed above the frieze, added the ability to colour the text background of events and periods.
+\item 1.15 : added possibility to create owns new commands, to graduate automatically the timeline, change the alternation of colours
+ periods and fixes some compatibility issues.
+\item 1.2 (actual version) : reduces the use of the module \type{tikz} at least possible, remove the former limitation of the impossibility of
+switching the default value of \type{textwidth}. With \CONTEXT, added possibility using \METAPOST\footnote{for more informations on \METAPOST, see \from[MetaPost_TUG]} instead of \type{tikz} (and
+ conversely, reuse \type {tikz} instead of \METAPOST{}) using the commands \tex{chronoswitchtomodeMP} and \tex{chronoswitchtomodeTikz}~; with
+the Mark IV version using \METAPOST{} default.
+
+\stopitemize
\blank
@@ -97,9 +114,9 @@ I wish to thank Gonçalo {\sc Pereira} for his idea about colouring in white the
\chapter{First use}
-\section{Main function: \type{\startchronology}}
+\section{Main function: \tex{startchronology}}
-The control sequence \type{\startchronology}\index{startchronology} is the first one you need to know.\footnote{There are \type{\begin{chronology}} and \type{\end{chronology}} for \LaTeX}~: it starts the chronological frieze :
+The control sequence \tex{startchronology}\index{startchronology} is the first one you need to know.\footnote{There are \tex{begin}\arg{chronology} and \tex{end}\arg{chronology} for \LaTeX}~: it starts the chronological frieze :
\startalignment[middle]
\starttypingTEX
@@ -108,7 +125,7 @@ The control sequence \type{\startchronology}\index{startchronology} is the first
\stopalignment
\leftaligned{\switchtobodyfont[12.4pt] See \in[startchronologyoptions] to have the different possible options}
\blank[small]
-The next one is \type{\stopchronology}\index{stopchronology}\footnote{or \type{\end{chronology}}}, it ends the timeline.
+The next one is \tex{stopchronology}\index{stopchronology}\footnote{or \tex{end}\arg{chronology}}, it ends the timeline.
\startalignment[middle]
\starttypingTEX
@@ -128,9 +145,9 @@ The next one is \type{\stopchronology}\index{stopchronology}\footnote{or \type{\
You can see the timeline is on all the page's width, furthermore it starts at {\os0} and ends at the current year {\os\the\year} when this document was compiled. \type{Chronosys} will compare these years with the events and periods you will give him (see \in[event] and \in[period]).
\blank[small]Now let's learn how to add events on the timeline.
-\section[event]{Events: \type{\chronoevent}}
+\section[event]{Events: \tex{chronoevent}}
-You can add events with \type{\chronoevent}\index{chronoevent}. This control sequence needs two arguments: the first one is the date of the event\footnote{you can go to \in[eventnewdate] to see another way of specifying the date} and the second is the label of this event.
+You can add events with \tex{chronoevent}\index{chronoevent}. This control sequence needs two arguments: the first one is the date of the event\footnote{you can go to \in[eventnewdate] to see another way of specifying the date} and the second is the label of this event.
\startalignment[middle]
\starttypingTEX
@@ -177,9 +194,9 @@ The event appears between {\os 0} et {\os\the\year}, proportionally with his gap
\type{Chronosys} won't generate any error if the event's date is out of the starting year and 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 \in[startchronologyoptions]).
-\section[period]{Periods: \type{\chronoperiode}}
+\section[period]{Periods: \tex{chronoperiode}}
-You can also add one period (or several\footnote{If two periods are overlapping, the last one will overlap the other}) on the frieze with \type{\chronoperiode}\index{chronperiode}.
+You can also add one period (or several\footnote{If two periods are overlapping, the last one will overlap the other}) on the frieze with \tex{chronoperiode}\index{chronperiode}.
\startalignment[middle]
\starttypingTEX
@@ -212,9 +229,9 @@ N.B.: on the period from {\os1000} to {\os1999}, blue on the timeline, we can no
The period appears automatically with colour, and the dates are also visible (see \in[periodoptions] to disable them) and the label. The periods can be automatically coloured in 5 colours : blue, red, cyan, purple and yellow, except if the colour is identical to the frieze's one. Of course you can choose the colour of the period (see \in[periodoptions]).
-\section[chronograduation]{Automatic graduation : \type{\chronograduation}}
+\section[chronograduation]{Automatic graduation : \tex{chronograduation}}
-Use \type{\chronograduation} to add a graduation on the timeline.
+Use \tex{chronograduation} to add a graduation on the timeline.
\startalignment[middle]
\starttypingTEX
@@ -233,7 +250,7 @@ Use \type{\chronograduation} to add a graduation on the timeline.
\chronograduation{100}
\stopchronology
\startchronology
-\chronograduation[periode][dateselevation=\z@]{100}
+\chronograduation[periode][dateselevation=0pt]{100}
\stopchronology
\stoptypingTEX
\startchronology
@@ -245,9 +262,9 @@ Use \type{\chronograduation} to add a graduation on the timeline.
\chapter[Personnalisation]{Time-lines' customization}
-\section{\type{\startchronology}}
+\section{\tex{startchronology}}
\subsection{Example}
-\type{\startchronology} can have an optional argument in brackets.
+\tex{startchronology} can have an optional argument in brackets.
For example:
\starttypingTEX
@@ -264,13 +281,13 @@ color=darkblue,height=7ex,width=\hsize]
\bigskip
\subsection{Different options}
-The different options of \type{\startchronology}\index{startchronology} are:
+The different options of \tex{startchronology}\index{startchronology} are:
\startitemize
\head \type{startyear}\index{startyear} :\par starting year of the timeline. It needs to be a valid \type{number}. It is by default {\os0}
\head \type{stopyear}\index{stopyear} :\par ending year of the timeline. It also needs to be a valid \type{number}. It is the current year by default.
-\head \type{color}\index{color} :\par colour of the frieze. It must be a \type{colour} recognized by the \type{tikz} package. It is black by default.
+\head \type{color}\index{color} :\par colour of the frieze. It must be a valid \type{colour}. It is black by default.
\head \type{height}\index{height} :\par height of the frieze. It must be a valid \type{dimen} and it is \type{0.7pc} by default.
-\head \type{width}\index{width} :\par width of the frieze. It must be a valid \type{dimen} and it is \type{\hsize}\footnote{\type{\textwidth} in \LaTeX} by default.
+\head \type{width}\index{width} :\par width of the frieze. It must be a valid \type{dimen} and it is \tex{hsize}\footnote{\tex{textwidth} in \LaTeX} by default.
\head \type{datesstyle}\index{datessyle} :\par style to apply to dates. It must be a \type{control sequence} (it can take one argument, which will be the dates), is empty by default.
\head \type{dateselevation}\index{dateselevation} :\par height of the dates from the timeline, it must be a valid \type{dimen} and it is \type{20pt} par by default.
\head \type{startdate}\index{startdate} :\par boolean which indicate if the starting year has to be placed. It must be either \type{true} or \type{false} and it is \type{true} by default.
@@ -287,7 +304,7 @@ The different options of \type{\startchronology}\index{startchronology} are:
\subsection[startchronologyoptions]{Summary}
\placetable[here][fig:startchronologyoptions]{\type{startchronology}'s options}
\starttable[|l|c|l|]
-\HL\VL\use{3}\ReFormat[cB]{\type{\startchronology[}\em ...=...\type{]}}\VL\SR
+\HL\VL\use{3}\ReFormat[cB]{\tex{startchronology[}\em ...=...\type{]}}\VL\SR
\VL\type{startyear} \NC=\NC\type{<number>}
\VL\FR\VL
\type{stopyear} \NC=\NC\type{<number>}\VL\FR
@@ -314,9 +331,9 @@ The different options of \type{\startchronology}\index{startchronology} are:
\stoptable
\page[yes]
-\section{\type{\chronoperiode}}
+\section{\tex{chronoperiode}}
\subsection{Example}
-\type{\chronoperiode} can have an optional argument for the options' customization.
+\tex{chronoperiode} can have an optional argument for the options' customization.
\starttypingTEX
\startchronology[startyear=-800,stopyear=500,
color=darkgreen, height=3cm]
@@ -341,7 +358,7 @@ box=true]{-509}{-27}{Roman Republic}
\subsection{Colours alternation}
As we saw, the colour of the periods alternates between blue, red, cyan, purple and yellow. You can define your own colours alternation
-with \crlf\type{\chronoperiodecoloralternation}\index{chronoperiodecoloralternation}.
+with \crlf\tex{chronoperiodecoloralternation}\index{chronoperiodecoloralternation}.
\startalignment[middle]
\starttypingTEX
@@ -377,7 +394,7 @@ Example:
\stopchronology
You can also restart the alternation at the beginning or on a specific colour with\crlf
-\type{\restartchronoperiodecolor}\index{restartchronoperiodecolor}.
+\tex{restartchronoperiodecolor}\index{restartchronoperiodecolor}.
\startalignment[middle]
\starttypingTEX
@@ -391,7 +408,7 @@ You can also restart the alternation at the beginning or on a specific colour wi
\subsection[chronoperiodsoptions]{Different options}
-The different options of \type{\chronoperiode}\index{chronoperiode} are:
+The different options of \tex{chronoperiode}\index{chronoperiode} are:
\startitemize
\head \type{startdate}\index{startdate} :\par boolean. It indicate if the starting year has to be placed, and must be either \type{true} or \type{false}. It is \type{true} by default.
@@ -403,10 +420,10 @@ The different options of \type{\chronoperiode}\index{chronoperiode} are:
\head \type{textstyle}\index{textstyle} : \par style to apply to the label. It must be a \type{control sequence} or
\noindent\type{control sequence#1} and is empty by default.
-\head \type{color}\index{color} :\par colour of the period on the frieze. It must be a \type{colour} recognized by \type{tikz}. It alternates between blue, red, cyan, purple and yellow by default.
+\head \type{color}\index{color} :\par colour of the period on the frieze. It must be a valid \type{colour}. It alternates between blue, red, cyan, purple and yellow by default.
\head \type{dateselevation}\index{dateselevation} :\par height of the dates from the frieze. It must be a valid \type{dimen} and it is \type{0pt} by default.
\head \type{textdepth}\index{textdepth} :\par depth of the label from the frieze. It must be a valid \type{dimen} and it is \type{15pt} by default.
-\head \type{colorbox}\index{colorbox} :\par colour of the background of the text of the period. It must be a \type{colour} recognized by \type{tikz} and it is white by default.
+\head \type{colorbox}\index{colorbox} :\par colour of the background of the text of the period. It must be a valid \type{colour} and it is white by default.
\head \type{ifcolorbox}\index{ifcolorbox} :\par boolean which indicates if the background of the text has to be coloured. It must be either \type{true} or \type{false}. It is \type{true} by default.
\head \type{topheight}\index{topheight} : \par height of the top of the period on the timeline. It must be a valid \type{dimen} and it is equal to the \type{height of the timeline} by default.
\head \type{bottomdepth}\index{bottomdepth} : \par height of the bottom of the period on the timeline. It must be a valid \type{dimen} and it is \type{0pt} by default.
@@ -416,7 +433,7 @@ The different options of \type{\chronoperiode}\index{chronoperiode} are:
\placetable[here][fig:chronoperiodeoptions]{\type{chronoperiode}'s options}
\starttable[|l|c|l|]
-\HL\VL\use{3}\ReFormat[cB]{\type{\chronoperiode[}\em ...=...\type{]{...}{...}{...}}}\VL\SR
+\HL\VL\use{3}\ReFormat[cB]{\tex{chronoperiode[}\em ...=...\type{]{...}{...}{...}}}\VL\SR
\VL\type{startdate} \NC=\NC\type{<true>} {\em or} \type{<false>}\VL\LR
\VL\type{stopdate} \NC=\NC\type{<true>} {\em or} \type{<false>}\VL\LR
\VL\type{dates} \NC=\NC\type{<true>} {\em or} \type{<false>}\VL\LR
@@ -431,16 +448,16 @@ The different options of \type{\chronoperiode}\index{chronoperiode} are:
\VL\type{bottomdepth} \NC =\NC \type{<dimen>}\VL\FR\HL
\stoptable
-\section{\type{\chronoevent}}
+\page[yes]
+
+\section{\tex{chronoevent}}
-\type{\chronoevent} can also have an optional argument for customization.
+\tex{chronoevent} can also have an optional argument for customization.
\subsection{Example}
\starttypingTEX
-\def\MyIcon{{\starttikzpicture \filldraw
-[color=orange](0,0)--(0,5pt)--(5pt,5pt)
---(5pt,0)--cycle;\stoptikzpicture}}
+\def\MyIcon{{\color{orange}\vrule width 5pt height5pt\relax}}
\catcode`\@=11
\def\chron@selectmonth#1{\ifcase#1\or January\or February\or
@@ -456,7 +473,7 @@ icon=\MyIcon,year=false, textwidth=4.5cm]{15/3/-44}
assassination of Caesar}
\stopchronology
\stoptypingTEX
-\def\MyIcon{{\starttikzpicture \filldraw[color=orange](0,0)--(0,5pt)--(5pt,5pt)--(5pt,0)--cycle;\stoptikzpicture}}
+\def\MyIcon{{\color[orange]\vrule width 5pt height5pt\relax}}
\catcode`\@=11
\def\chron@selectmonth#1{\ifcase#1\or January\or February\or
March\or April\or May\or June\or July\or August\or September\or
@@ -490,15 +507,10 @@ As for the periods, to avoid vertical straight to overlap the others labels, as
You should type the events from the one you want to place from the farthest to the nearest from the timeline. You can of course choose the colour of the box, and disable it if you need (see \in[chronoeventsoptions]).
-\subsubsection[nosetuptextwidthexplanation]{Width of the text}
-
-You can modify the width of the label, in the aim to cut the lines to avoid exceeding on the others labels. You do this with the option \type{textwidth}\index{textwidth} of \type{\chronovent}.
-However, this functionality is considered to be disabled, except if you specify this option. This is done in the aim to avoid problems about the alignment of the text. This option cannot have a default value (see \in[permanentchanges]).
-
\subsubsection[eventnewdate]{A new way for specifying the date}
-You can specify with more precision the date with \type{\chronoevent}\index{chronoevent}. We saw that typing
-\type{\chronoevent{-44}{Assassination of Caesar}} specified the year of the event, now we will saw the way of specifying
+You can specify with more precision the date with \tex{chronoevent}\index{chronoevent}. We saw that typing
+\tex{chronoevent}\arg{-44}\arg{Assassination of Caesar} specified the year of the event, now we will saw the way of specifying
the month and the day. You have to type \type{<day number>/<number of the month>/year}, only specifying the year is compulsory.
You can give only the year as we saw before, the number of the month and the year or the day number and the number of the month and the year. The number of the month is automatically converted to the name of the month (in French by default). You can disable this conversion (see \in[eventoptions]).The control sequence of conversion is:
@@ -556,10 +568,10 @@ Here are the different possible options\index{chronoevent}.
\head \type{datesseparation}\index{datesseparation} : symbol of separation of each element of the date. It can be a control sequence or some text and is a space by default.
\head \type{datestyle}\index{datestyle} :\par style to apply to the entire date with the symbols of separation. It must be a \type{control sequence} or \type{control sequence#1}.
\head \type{datesstyle}\index{datesstyle} :\par style to apply each element of the date without the symbols of separation. It must be a \type{control sequence} or \type{control sequence#1}.
-\head \type{colorbox}\index{colorbox} :\par colour of the background of the text and date of the event. It must be a \type{colour} recognized by \type{tikz} and it is white by default.
+\head \type{colorbox}\index{colorbox} :\par colour of the background of the text and date of the event. It must be a valid \type{colour} and it is white by default.
\head \type{ifcolorbox}\index{ifcolorbox} :\par boolean which indicates if the background of the text and the date has to be coloured. It must be either \type{true} or \type{false}. It is \type{true} by default.
\head \type{textwidth}\index{textwidth} :\par
-Width of the label on the page. Contrary to the other options, this one cannot have a default value and is disabled while the option is no given.
+Width of the label on the page.
It must be a valid \type{dimen}.
\stopitemize
@@ -567,7 +579,7 @@ It must be a valid \type{dimen}.
\placetable[here][fig:chronoeventoptions]{\type{chronoevent}'s options}
\starttable[|l|c|l|]
-\HL\VL\use{3}\ReFormat[cB]{\type{\chronoevent[}\em ...=...\type{]{...}{...}}}\VL\SR
+\HL\VL\use{3}\ReFormat[cB]{\tex{chronoevent[}\em ...=...\type{]{...}{...}}}\VL\SR
\VL\type{barre}\NC=\NC \type{<true>} {\em or} \type{<false>}\VL\FR
\VL\type{date}\NC=\NC \type{<true>} {\em or} \type{<false>}\VL\FR
\VL\type{conversionmonth}\NC=\NC \type{<true>} {\em or} \type{<false>}\VL\FR
@@ -590,7 +602,7 @@ It must be a valid \type{dimen}.
\chapter[permanentchanges]{Permanent changes}
\section[definecommands]{Creating new commands}
-You can create your own commands to place events and periods on the timeline with \type{\definechronoevent} and \type{\definechronoperiode}.
+You can create your own commands to place events and periods on the timeline with \tex{definechronoevent} and \tex{definechronoperiode}.
\startalignment[middle]
\starttypingTEX
@@ -614,7 +626,7 @@ N.B.: in \CONTEXT, the syntax is
\stoptypingTEX
\stopalignment
-The commands \type{\chrono<name of the command>} are now defined. For instance,
+The commands \tex{chrono<name of the command>} are now defined. For instance,
\starttypingTEX
\definechronoperiode{MyPeriod}[color=yellow, textstyle=\it]
@@ -634,9 +646,8 @@ The commands \type{\chrono<name of the command>} are now defined. For instance,
\stopchronology
\section[setupdefaultvalues]{Modify the default values}
-You can apply changes on default values with using \type{\setupchronology},\crlf \type{\setupchronoevent} and \type{\setupchronoperiode}. You use the
-same name for each option you want to change. The only exception is \type{textwidth} of \type{\chronoevent} (see
- \in[nosetuptextwidthexplanation]).
+You can apply changes on default values with using \tex{setupchronology},\crlf \tex{setupchronoevent} and \tex{setupchronoperiode}. You use the
+same name for each option you want to change.
\index{setupchronology}\index{setupchronoevent} \index{setupchronoperiode}.
\startalignment[middle]
@@ -647,8 +658,8 @@ same name for each option you want to change. The only exception is \type{textwi
\starttabulate[|l|l|]
\NC \color[blue] <text> \NC \type{periode} \em or \type{event} or \type{logy} or \type{graduation}\FR
-\NC \color[blue] ...\NC name of the command to customize (except for \type{\setupchronology}, and\FR
-\NC \NC for\type{\setupchronograduation} it is the style of the graduation ; see \in[definecommands])\FR
+\NC \color[blue] ...\NC name of the command to customize (except for \tex{setupchronology}, and\FR
+\NC \NC for\tex{setupchronograduation} it is the style of the graduation ; see \in[definecommands])\FR
\NC \color[blue] 1. \NC options (see \in[Personnalisation])\FR
\stoptabulate
@@ -660,9 +671,9 @@ N.B.: Again, in \CONTEXT, the syntax is :
\stoptypingTEX
\stopalignment
-The option \type {name of the command to customize} is only available for \crlf \type{\setupchronoevent} and \type{\setupchronoperiode}, and in the case of \crlf\type{\setupchronograduation} it matches the style of graduation (\type{event} or \type{period}).
+The option \type {name of the command to customize} is only available for \crlf \tex{setupchronoevent} and \tex{setupchronoperiode}, and in the case of \crlf\tex{setupchronograduation} it matches the style of graduation (\type{event} or \type{period}).
-If it is not given, the changes will affect \type {\chronoperiode} and \type{\chronoevent} , otherwise they will affect the command given in
+If it is not given, the changes will affect \type {\chronoperiode} and \tex{chronoevent} , otherwise they will affect the command given in
option.
For example,
@@ -694,12 +705,13 @@ For example,
\startalignment[middle]
\starttypingTEX
-\setupchronoperiode{color=\chron@periodcolor}
+\setupchronoperiode{color=\chronoperiodcolor}
\stoptypingTEX
\stopalignment
-\setupchronoperiode[color=\chron@periodcolor]
+\setupchronoperiode[color=\chronoperiodcolor]
\startchronology
+\chronograduation{250}
\chronoperiode{1050}{1450}{Anything you want}
\chronoperiode{1800}{1899}{19\high{th} century}
\chronoevent{1600}{Anything else}