summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex')
-rw-r--r--graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex81
1 files changed, 81 insertions, 0 deletions
diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex
new file mode 100644
index 0000000000..bdfd225f3c
--- /dev/null
+++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex
@@ -0,0 +1,81 @@
+% !TeX spellcheck = en_US
+% !TeX root = tikz-ext-manual.tex
+% Copyright 2022 by Qrrbrbirlbel
+%
+% This file may be distributed and/or modified
+%
+% 1. under the LaTeX Project Public License and/or
+% 2. under the GNU Free Documentation License.
+%
+
+\section{Calendar}
+\begin{tikzlibrary}{ext.calendar-plus}
+ This library extends the \tikzname\space library \referenceLibraryandIndexO{calendar}.
+ \inspiration{WeekNum-Q,CalCond-Q,CalMath-Q}{WeekNum-A,CalCond-A,CalMath-A}
+\end{tikzlibrary}
+
+\begin{multicols}{2}
+
+\subsection{Value-keys and nestable \texttt{if} key}
+
+The values of following keys are originally stored in some macros that are not
+accessible by the user. These are now simple value-keys.
+The |@|-protected macros are still available, of course.
+
+\begin{key}{/tikz/day xshift (initially 3ex)}
+\end{key}
+\begin{key}{/tikz/day yshift (initially 3.5ex)}
+\end{key}
+\begin{key}{/tikz/month xshift (initially 9ex)}
+\end{key}
+\begin{key}{/tikz/month yshift (initially 9ex)}
+\end{key}
+
+It is now also possible to nest |/tikz/if| occurrences.
+\begin{key}{/tikz/if=|(|\meta{conditions}|)|\meta{code or options}\opt{|else|\meta{else code or options}}}
+\end{key}
+
+\subsection{\pgfname math functions}
+\begin{math-function}{weeksinmonthofyear(\mvar{first weekday}, \mvar{month}, \mvar{year})}
+\mathcommand
+ Returns the number of (partial) weeks in the month \mvar{month} of year \mvar{year}
+ when this month begins on a \mvar{first weekday}.
+\end{math-function}
+\begin{math-function}{lastdayinmonthofyear(\mvar{month}, \mvar{year})}
+\mathcommand
+ Returns the last day (28, 29, 30 or 31) of month \mvar{month} of year \mvar{year}.
+\end{math-function}
+
+\subsection{Week numbering (ISO~8601)}
+
+The actual week number algorithm is implemented by the |pgfcalendar-ext| package/module in section~\ref{calendar:weeknumbering}.
+\begin{key}{/tikz/week code=\meta{code}}
+ Works like |/tikz/day code| or |/tikz/month code|, only for weeks.\indexKeyO{day code}\indexKeyO{month code}
+\end{key}
+
+\begin{key}{/tikz/week text=\meta{text}}
+ Works like |/tikz/day text| or |/tikz/month text|, only for weeks.\indexKeyO{day text}\indexKeyO{month text}
+\end{key}
+
+\begin{stylekey}{/tikz/every week}
+ Works like |/tikz/every day| or |/tikz/every month|, only for weeks.\indexKeyO{every day}\indexKeyO{every month}
+\end{stylekey}
+
+\begin{stylekey}{/tikz/week label left}
+ Places the week label to the left of the first day of the month. (For
+ |week list| and |month list| where a week does not start on a Monday, the
+ position is chosen ``as if'' the week had started on a Monday -- which is
+ usually exactly what you want.)
+ %
+\begin{codeexample}[preamble={\usetikzlibrary{ext.calendar-plus}}]
+\tikz
+ \calendar [week list, month label above centered,
+ dates=2022-07-01 to 2022-07-31,
+ week label left,
+ every week/.append style={gray!50!black,font=\sffamily}];
+\end{codeexample}
+ %
+\end{stylekey}
+
+\end{multicols}
+\endinput \ No newline at end of file