diff options
Diffstat (limited to 'Master/texmf-dist/doc/generic/pgf/text-en/pgfmanual-en-pgfcalendar.tex')
-rw-r--r-- | Master/texmf-dist/doc/generic/pgf/text-en/pgfmanual-en-pgfcalendar.tex | 58 |
1 files changed, 28 insertions, 30 deletions
diff --git a/Master/texmf-dist/doc/generic/pgf/text-en/pgfmanual-en-pgfcalendar.tex b/Master/texmf-dist/doc/generic/pgf/text-en/pgfmanual-en-pgfcalendar.tex index 6526f40394f..318c01cf384 100644 --- a/Master/texmf-dist/doc/generic/pgf/text-en/pgfmanual-en-pgfcalendar.tex +++ b/Master/texmf-dist/doc/generic/pgf/text-en/pgfmanual-en-pgfcalendar.tex @@ -17,7 +17,7 @@ This section describes the package |pgfcalendar|. This package can be used independently of \pgfname. It has two purposes: \begin{enumerate} - \item It provides functions for working with dates. Most noticably, + \item It provides functions for working with dates. Most noticeably, it can convert a date in ISO-standard format (like 1975-12-26) to a so-called Julian day number, which is defined in Wikipedia as follows: ``The Julian day or Julian day number is the @@ -35,7 +35,7 @@ This section describes the package |pgfcalendar|. is highly configurable and flexible (for example, it can produce both plain text calendars and also complicated \tikzname-based calendars), but most users will not use the macro directly. It is - the job of a frontend to provide useful configruations for + the job of a frontend to provide useful configurations for typesetting calendars based on this command. \end{enumerate} \end{package} @@ -73,20 +73,20 @@ This section describes the package |pgfcalendar|. \item |2006-01-01| refers to the first day of 2006. \item |2006-02-last| refers to February 28, 2006. \item |\year-\month-\day| refers to today. - \item |2006-01-01+2| refser to January 3, 2006. + \item |2006-01-01+2| refers to January 3, 2006. \item |\year-\month-\day+1| refers to tomorrow. \item |\year-\month-\day+-1| refers to yesterday. \end{itemize} - + The conversion method is taken from the English Wikipedia entry on - Julian days. + Julian days. \newcount\mycount \example |\pgfcalendardatetojulian{2007-01-14}{\mycount}| sets |\mycount| to \pgfcalendardatetojulian{2007-01-14}{\mycount}\the\mycount. - + \end{command} \begin{command}{\pgfcalendarjuliantodate\marg{Julian day}\marg{year @@ -130,7 +130,7 @@ This section describes the package |pgfcalendar|. \example |\pgfcalendarjuliantoweekday{2454115}{\mycount}| sets |\mycount| to - \pgfcalendarjuliantoweekday{2454115}{\mycount}\the\mycount. + \pgfcalendarjuliantoweekday{2454115}{\mycount}\the\mycount. \end{command} @@ -164,7 +164,7 @@ This section describes the package |pgfcalendar|. \itemcalendaroption{Sunday} as above. \itemcalendaroption{workday} Passed by Mondays, Tuesdays, Wednesdays, Thursdays, and Fridays. - \itemcalendaroption{weekend} Passed Saturdays and Sundays. + \itemcalendaroption{weekend} Passed Saturdays and Sundays. \itemcalendaroption{equals}|=|\meta{reference} The \meta{reference} can be in one of two forms: Either, it is a full ISO format date like |2007-01-01| or the year may be missing as in |12-31|. In the @@ -184,7 +184,7 @@ This section describes the package |pgfcalendar|. year. \itemcalendaroption{at most}|=|\meta{reference} as above. \itemcalendaroption{between}|=|\meta{start reference}| and |\meta{end - refernce} This test checks whether the current date lies between + reference} This test checks whether the current date lies between the two given reference dates. Both full and short version may be given. @@ -258,16 +258,16 @@ This section describes the package |pgfcalendar|. more details on translations. \example |\pgfcalendarweekdayname{2}| yields - \texttt{\pgfcalendarweekdayname{2}}. + \texttt{\pgfcalendarweekdayname{2}}. \end{command} \begin{command}{\pgfcalendarweekdayshortname\marg{week day number}} - This command works similiarly to the previous command, only an + This command works similarly to the previous command, only an abbreviated version of the week day is produced. \example |\pgfcalendarweekdayshortname{2}| yields - \texttt{\pgfcalendarweekdayshortname{2}}. + \texttt{\pgfcalendarweekdayshortname{2}}. \end{command} @@ -276,7 +276,7 @@ This section describes the package |pgfcalendar|. is given by the \meta{month number}. \example |\pgfcalendarmonthname{12}| yields - \texttt{\pgfcalendarmonthname{12}}. + \texttt{\pgfcalendarmonthname{12}}. \end{command} @@ -284,7 +284,7 @@ This section describes the package |pgfcalendar|. As above, only an abbreviated version is produced. \example |\pgfcalendarmonthshortname{12}| yields - \texttt{\pgfcalendarmonthshortname{12}}. + \texttt{\pgfcalendarmonthshortname{12}}. \end{command} @@ -319,14 +319,14 @@ documentation of this package for more details. \medskip \textbf{Basic typesetting process.} A calendar is typeset as follows: The \meta{start date} and - \meta{end date} specify a range of dates. For each date in this + \meta{end date} specify a range of dates. For each date in this range the \meta{rendering code} is executed with certain macros setup to yield information about the \emph{current date} (the current date in the enumeration of dates of the range). Typically, the \meta{rendering code} places nodes inside a picture, but it can do other things as well. Note that it is also the job of the \meta{rendering code} to position the calendar - correctly. + correctly. The different calls of the \meta{rending code} are not surrounded by \TeX\ groups (though you can do so yourself, of @@ -339,7 +339,7 @@ documentation of this package for more details. \begin{itemize} \item |\pgfcalendarprefix| - The \meta{prefix} parameter. This prefix is recomended for nodes + The \meta{prefix} parameter. This prefix is recommended for nodes inside the calendar, but you have to use it yourself explicitly. \item |\pgfcalendarbeginiso| The \meta{start date} of range being typeset in ISO format (like 2006-01-10). @@ -349,7 +349,7 @@ documentation of this package for more details. The \meta{end date} of range being typeset in ISO format. \item |\pgfcalendarendjulian| Julian day number of \meta{end date}. - \item |\pgfcalendarcurrentjulian| This \TeX\ count holds the + \item |\pgfcalendarcurrentjulian| This \TeX\ count holds the Julian day number of day currently begin rendered. \item |\pgfcalendarcurrentweekday| The weekday (a number with zero representing Monday) of the current date. @@ -357,7 +357,7 @@ documentation of this package for more details. \item |\pgfcalendarcurrentmonth| The month of the current date (always two digits with a leading zero, if necessary). \item |\pgfcalendarcurrentday| The day of month of the current date - (alwyas two digits). + (always two digits). \end{itemize} \medskip @@ -375,7 +375,7 @@ documentation of this package for more details. In a first example, let us create a very simple calendar: It just lists the dates in a certain range. \begin{codeexample}[vbox,ignorespaces] -\pgfcalendar{cal}{2007-01-20}{2007-02-10}{\pgfcalendarcurrentday\ } +\pgfcalendar{cal}{2007-01-20}{2007-02-10}{\pgfcalendarcurrentday\ } \end{codeexample} Let us now make this a little more interesting: Let us add a line break after each Sunday. @@ -384,7 +384,7 @@ documentation of this package for more details. { \pgfcalendarcurrentday\ \ifdate{Sunday}{\par}{} -} +} \end{codeexample} We now want to have all Mondays to be aligned on a column. For this, different approaches work. Here is one based positioning each day @@ -395,7 +395,7 @@ documentation of this package for more details. \leavevmode% \hbox to0pt{\hskip\pgfcalendarcurrentweekday cm\pgfcalendarcurrentday\hss}% \ifdate{Sunday}{\par}{}% -} +} \end{codeexample} Let us now typeset two complete months. \begin{codeexample}[vbox,ignorespaces] @@ -412,11 +412,11 @@ documentation of this package for more details. }% }% \ifdate{Sunday}{\par}{}% -} +} \end{codeexample} - For our final example, we use a |{tikzpicture}|. + For our final example, we use a |{tikzpicture}|. \begin{codeexample}[vbox,ignorespaces] -\begin{tikzpicture} +\begin{tikzpicture} \pgfcalendar{cal}{2007-01-20}{2007-02-10}{% \ifdate{workday} {\tikzset{filling/.style={fill=blue!20}}} @@ -452,12 +452,12 @@ documentation of this package for more details. \end{itemize} Normally, you should say |\let\%=\pgfcalendarshorthand| locally, so that you can write |\%wt| instead of the much more cumbersome - |\pgfcalendarshorthand{w}{t}|. + |\pgfcalendarshorthand{w}{t}|. \begin{codeexample}[leave comments] \let\%=\pgfcalendarshorthand \pgfcalendar{cal}{2007-01-20}{2007-01-20} -{ ISO form: \%y0-\%m0-\%d0, long form: \%wt, \%mt \%d-, \%y0} +{ ISO form: \%y0-\%m0-\%d0, long form: \%wt, \%mt \%d-, \%y0} \end{codeexample} \end{command} @@ -469,7 +469,5 @@ documentation of this package for more details. calendar, followed by a hyphen, followed by the ISO format version of the date. Thus, when the date |2007-01-01| is typeset in a calendar for the prefix |mycal|, the macro expands to - |mycal-2007-01-01|. + |mycal-2007-01-01|. \end{command} - - |