Debian Codegraph @

texmf-dist/doc/latex/tikz-kalender/README.md

raw
1 ## A LaTeX based calendar using TikZ
2
3 For usage see the example files »tikz-kalender-example1.tex«,
4 »tikz-kalender-example2.tex«, and »*.events«. See also my [Git
5 repository](https://github.com/rolfn/kalenderRN). The Code is inspired by this
6 [document](http://www.texample.net/tikz/examples/a-calender-for-doublesided-din-a4/)
7 and has the »Creative Commons attribution license (CC-BY-SA)«.
8
9 The class »tikz-kalender« requires the package »tikz« and the tkiz libraries
10 »calc« and »calendar«.
11
12 ### Short Description
13
14 #### Keys for the macro \setup
15
16 `\setup[key1=value1,key2=value2,..]`
17
18 ##### General
19
20 * `year=`_year of the calendar_
21 * `yearText=`_text for the year_ (default: 4-digit current year)
22 * `title=`_title of the calendar_
23 * `events=`_list of files with events or periods_ (without the ending `.events`)
24 * `showweeknumbers=`_true or empty or false_ (showing the number of the week)
25 * `lang=`_language for marking_ (option passed to package babel)
26 * `paper=`_papersize abbreviation_ (understandable by package geometry;
27 default: a4)
28 * `print=`_true or empty or false_ (printer-friendly orientation for
29 double-side printing; default: false)
30 * `onePageOnly=`_true or empty or false_ (print calendar on one page only instead of two; default: false)
31 * `xcoloroptions=`_options_ (passed to package xcolor; default: svgnames)
32
33 ##### Color definitions
34
35 * `titleColor=...` (default: dark)
36 * `eventColor=...` (default: medium)
37 * `periodColor=...` (default: period)
38 * `monthBGcolor=...` (background; default: dark)
39 * `monthColor=...` (default: white)
40 * `workdayColor=...`
41 * `saturdayColor=...` (default: bright)
42 * `sundayColor=...` (default: medium)
43
44 The default colors:
45
46 * dark: `{HTML}{A57C00}`
47 * medium: `dark!35`
48 * bright: `dark!20`
49 * period: `gray!30`
50
51 ##### Font definitions
52
53 * `titleFont=...`
54 * `yearFont=...`
55 * `monthFont=...`
56 * `dayFont=...`
57 * `dayNbFont=...`
58 * `weekNbFont=...`
59 * `eventFont=...`
60
61 ##### Examples
62
63 * `titleFont={\fontsize{1.2em}{1.2em}}`
64 * `yearFont={\itshape}`
65 * `titleColor=IndianRed3` (required `xcoloroptions={x11names}`)
66
67 #### Macros \event and \period inside of events files
68
69 ##### Examples
70
71 * `\event{\year-10-09}{John Lennon (1940)}`; uncolored every year event
72
73 * `\event*{2016-03-27}{Ostersonntag}`; event colored with the color defined
74 by the key `eventColor` (general holiday)
75
76 * `\event*{2016-07-10}{Fußball-EM: Endspiel}[color=DarkTurquoise]`;
77 colored event with a special color
78
79 * `\period{2016-12-23}{2017-01-03}`; period colored with the color defined
80 by the key `periodColor`
81
82 * `\period{2016-02-01}{2016-02-06}[color=LightGreen]`; period colored with a
83 special color
84
85 * `\period{2016-09-12}{2016-10-04}[color=red!30,name=Urlaub]`; named period
86 colored with a special color
87
88 Rolf Niepraschk, 2026-01-27