summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
blob: 5d12a545f243ffa05698f3e7411958d3e53bbec4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
\documentclass[english]{article}

\usepackage{charter}
\usepackage[scaled=0.87]{beramono}
\usepackage[T1]{fontenc}
\usepackage[latin9]{inputenc}
\usepackage{url}

% markup
\newcommand*\jmacro[1]{\textbf{\texttt{#1}}}
\newcommand*\jcsmacro[1]{\jmacro{\textbackslash{#1}}}
\newcommand*\joption[1]{\textbf{\texttt{#1}}}
\newcommand*\jfmacro[1]{\texttt{#1}}
\newcommand*\jfcsmacro[1]{\jfmacro{\textbackslash{#1}}}

\usepackage{babel}
\usepackage{listings}
\lstset{language={[LaTeX]TeX},
        basicstyle={\small\ttfamily},
        frame=single}
\renewcommand{\lstlistingname}{Listing}

\setcounter{tocdepth}{2}

\begin{document}

\title{The jslectureplanner package}

\author{Jürgen Spitzmüller%
\thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}.}}

\date{Version 1.0.1, 2015/02/27}

\maketitle

\tableofcontents

\section{Aim of this package}

I have written this package in order to facilitate (and somewhat systematize)
the planning of my university courses. The basic idea of this package
is that you record all general data of a course (date, semester, type,
course title, session titles, general information etc.) in a central
tex file and then input this file to all documents related to the
course (such as the course program, bibliography, scripts, handouts, beamer
presentations, exercises etc.), in order to re-use the recorded data.
This is particularly helpful if you have standard courses which
are held every other semester: instead of changing the data in every
single file, you just need to change it once, in the metadata file.

To further facilitate the planning, the package is able to calculate
the session dates of a whole semester, if the sessions of the course
follow at regular intervals.
You only need to set the date of the first session, the package does
the rest. Moreover, the package can be used to generate a sectioned
bibliography for the course via \textsf{biblatex}.

Since the package was written for my own needs, it is somewhat tied
to my workflow. Particularly, it is tied to my context: teaching in
the Humanities at a German-speaking university. Hence, the categorization
of the package draws on this context. In particular, all strings and
formats are German. However, it is possible add new categories as well as
to customize and translate the strings.
This is described later in this manual.

This manual describes the basic user interface of the package. Please
also refer to the example files included in the package  in order to
see how it is supposed to be used ``in practice''.


\section{Requirements}

The following packages are required: \textsf{etoolbox}, \textsf{advdate},
\textsf{xkeyval}, \textsf{datetime}, \textsf{calc}.


\section{General idea}

The general idea goes as follows:
\begin{itemize}
\item Set up a \emph{metadata.tex} file (or whatever name you prefer) and
record all meta information of the course in it (as described in sec.~\ref{sec:course-metadata}
and \ref{sec:lecplan}).
\item In your documents, load the package (\jcsmacro{usepackage\{jslectureplanner\}})
and/or%
\footnote{If you prefer to record the data via package options
(see sec.~\ref{sub:package-options}) instead of macros (see sec.~\ref{sec:via-macros}),
you need to load the package in the metadata file itself.}
 input the metadata file (\jcsmacro{input\{metadata.tex\}}).
\item Finally, use the macros described in sec.~\ref{sec:general-course-info}
and \ref{sec:session-specific-info} to retrieve the respective data and re-use
the recorded information in your documents.
\end{itemize}
The procedure is detailed in the following sections.


\section{Setting up course metadata\label{sec:course-metadata}}

You can set up the course metadata either via package options (if
you load the package in the metadata file; see sec.~\ref{sub:package-options})
or via specific macros (see sec.~\ref{sec:via-macros}).


\subsection{Via package options\label{sub:package-options}}

\jcsmacro{usepackage[<comma-separated options>]\{jslectureplanner\}}

\subsubsection{Course classification\label{sec:lecture-classification}}

The default course classification draws on the conventions at German universities
(or those where I have worked, for that matter). Each type is connected
to a verbose string (such as ``Seminar''), a short form (such as
``SE'') and a form that is used to denote individual sessions (as
in ``the second \emph{session} of this course'').
\begin{description}
\item [{type=<type>}] Defines the course type. Preset values:

\begin{itemize}
\item \joption{vl}: A lecture (verbose form: ``Vorlesung''\footnote{Sec.~\ref{sec:customizing-strings}
explains how to customize these strings.}, short form: ``VL'', session form: ``Vorlesung'')
\item \joption{ps}: Undergraduate seminar (verbose form: ``Proseminar'',
short form: ``PS'', session form: ``Sitzung'')
\item \joption{se}: Seminar (verbose form: ``Seminar'', short form: ``SE'',
session form: ``Sitzung'')
\item \joption{ue}: Practical course (verbose form: ``Übung'', short
form: ``UE'', session form: ``Sitzung'')
\item \joption{ko}: Colloquium (verbose form: ``Kolloquium'', short form:
``KO'', session form: ``Sitzung'')
\item \joption{pv}: Research seminar (verbose form: ``Privatissimum'',
short form: ``PV'', session form: ``Sitzung'')
\end{itemize}

Sec.~\ref{sec:customizing-strings} explains how to customize and extend this list.
Also cf. sec.~\ref{sec:styles} on the concept of ``styles''.
\end{description}

\subsubsection{Course title}
\begin{description}
\item [{title=<title>}] Main title of the course
\item [{titlesep=<separator>}] Separator between title and subtitle
\item [{subtitle=<subtitle>}] Subtitle of the course
\item [{shorttitle=<shorttitle>}] Short title of the course (for headings etc.)
\end{description}

\subsubsection{Date and place\label{sec:date-and-place}}
\begin{description}
\item [{semester=<term>,}] where \joption{<term>} is one of

\begin{itemize}
\item \joption{fs}: Spring term (``Frühjahrssemester'', short form: ``FS'')
\item \joption{hs}: Fall term (``Herbstsemester'', short form: ``HS'')
\item \joption{ss}: Summer term (``Sommersemester'', short form: ``SoSe'')
\item \joption{ws}: Winter term (``Wintersemester'', short form: ``WS'')
\end{itemize}
Sec.~\ref{sec:customizing-strings} explains how to customize and extend this list.
Also cf. sec.~\ref{sec:styles}.

\item [{year=<year>}]~
\item [{uni=<university>}]~
\item [{institute=<institute>}]~
\item [{room=<room>}]~
\item [{startdate=<startdate>}] Date of the first session (argument\emph{
must} have the form DD/MM/YYYY). If no startdate is given, \jfcsmacro{today} is used.
\item [{interval=<interval>}] Interval (in days) between two sessions.
      The preset interval is 7 (=~weekly courses).
\end{description}

\subsubsection{Additional information}
\begin{description}
\item [{instructor=<name>}] Instructor's name
\item [{platform=<data>}] Information (e.\,g., URL) of the e-learning platform
\item [{officehours=<data>}] Date of your office hours
\item [{officenumber=<data>}] Your office number
\end{description}

\subsection{Via macros\label{sec:via-macros}}

The following macros provide an alternative way to set up the course metadata.

\subsubsection{Course classification}
\begin{itemize}
\item \jcsmacro{LecType\{<course type>\}}: Set course type;
\joption{<course type>} is one of\footnote{See above sec.~\ref{sec:lecture-classification} for a detailed
description.}

\begin{itemize}
\item \joption{vl}: Lecture (\emph{Vorlesung})
\item \joption{ps}: Undergraduate seminar (\emph{Proseminar})
\item \joption{se}: Seminar (\emph{Seminar})
\item \joption{ue}: Practical course (\emph{Übung})
\item \joption{ko}: Colloquium (\emph{Kolloquium})
\item \joption{pv}: Research seminar (\emph{Privatissimum})
\end{itemize}
\end{itemize}

\subsubsection{Course title}
\begin{itemize}
\item \jcsmacro{LecTitle[<package options>]\{<title>\}}: Record course title and options;
\joption{<package options>} might be any set of package options described
in sec.~\ref{sub:package-options}, so this macro can actually be used to record
all metadata.
\item \jcsmacro{LecTitleSep\{<title separator>\}}: Specify course
title-subtitle separator (e.\,g., ``. '' or `` -- '')
\item \jcsmacro{LecSubTitle\{<subtitle>\}}: Record course subtitle
\end{itemize}

\subsubsection{Date and place}
\begin{itemize}
\item \jcsmacro{LecYear\{<term>\}\{<year>\}}, Record term and
year of the course; \joption{<term>} is one of\footnote{See above sec.~\ref{sec:date-and-place} for a detailed
description.}

\begin{itemize}
\item \joption{fs}: Spring term (\emph{Frühjahrssemester})
\item \joption{hs}: Fall term (\emph{Herbstsemester})
\item \joption{ss}: Summer term (\emph{Sommersemester})
\item \joption{ws}: Winter term (\emph{Wintersemester})
\end{itemize}
\item \jcsmacro{LecUni\{<university>\}}: Record the name of
your university
\item \jcsmacro{LecInstitute\{<institute>\}}: Record your institute's name
\item \jcsmacro{LecRoom\{<room>\}}: Record the room where the course takes place
\item \jcsmacro{LecStartDate\{<startdate>\}}: Set date of
the first session (argument\emph{ must} have the form DD/MM/YYYY)
\item \jcsmacro{LecInterval\{<interval>\}}: Adjust the interval (in days) between two sessions.
      The preset interval is 7 (=~weekly courses).
\item \jcsmacro{SetAutoOffset\{<n>\}\{<days>\}}: Automatically shift all subsequent sessions
      by <days> extra  days after every <n>th session. This is useful if you have each week
      two regular sessions and then a pause until the next week (for instance, a Tuesday +
      Thursday course could be defined via \jcsmacro{LecInterval\{2\}} and 
      \jcsmacro{SetAutoOffset\{2\}\{3\}}). <n> must be a positive integer, <days> can 
      also be a negative integer value.
\end{itemize}

\subsubsection{Additional information}
\begin{itemize}
\item \jcsmacro{LecInstructor\{<name>\}}: Record the instructor's name
\item \jcsmacro{SetOfficeHours\{<office hours>\}}: Record date of your office hours
\item \jcsmacro{SetOfficeNumber\{<office number>\}}: Record your office number
\item \jcsmacro{SetPlatform\{<platform information>\}}: Record information
(e.\,g., URL) of the e-learning platform
\end{itemize}

\section{Setting up a course schedule\label{sec:lecplan}}

In the metadata file, you can set up a schedule for the course by entering
session information in chronological order. This is done via the following
macro:
\begin{itemize}
\item \jcsmacro{NewSession[<options>]\{Session title\}}


Valid \joption{<options>}:
\begin{itemize}
\item \joption{titlesep=<separator>}: Separator between session title and
    subtitle
\item \joption{subtitle=<subtitle>}: Subtitle of the session
\item \joption{shorttitle=<shorttitle>}: Short title (for
    headings etc.)
\item \joption{instructor=<name>}: Specific instructor for this session
    (if it differs from the usual course instructor)
\item \joption{presstudents=<names>}: Students presenting in this session
\item \joption{room=<room>}: Specific room for this session (if it differs
    from the usual course room)
\item \joption{bibsec=<keyword>}: Session keyword for the bibliography
    (see below sec.~\ref{sub:bibliographies} for its use)
\item \joption{cancel=<true|false>}: Marks this session as ``canceled''.
    If you specify \joption{cancel=true}, the session will be printed
    in the program in bold type and appended by a verbal comment.
    For example,

\jcsmacro{NewSession[cancel=true]\{Dies Academicus\}}

will expand to
\begin{quote}
\textbf{15.\,05.: Dies Academicus -- keine Sitzung}
\end{quote}

(i.\,e., ``Dies Academicus -- no session'').

Furthermore, a canceled session is not counted in the session counter
that is used to retrieve session-specific information
(see below sec.~\ref{sec:session-specific-info}).

\end{itemize}
\item \jcsmacro{SetBreak[<span>]\{Break\}}: Add a semester break
(e.\,g., holidays) that affects one session. The macro increments
the internal counters respectively and expands in the program to

\begin{center}
\textbf{(Break)}
\par\end{center}

By means of the optional argument, the real time span of the break
might be given if you want to print it on the program. If you pass
an optional argument \joption{<span>}, the macro will expand to

\begin{center}
\textbf{(<span>: Break)}
\par\end{center}

E.\,g., \jcsmacro{SetBreak[28.05.-{}-3.06.]\{Whitsun holidays\}}
expands to


\begin{center}
\textbf{(28.05.--3.06.: Whitsun holidays)}
\par\end{center}

\item \jcsmacro{SetBreaks[<options>]\{Break\}}: Add
a semester break that affects more than one session (e.\,g., two-week holidays).
The output in the program is identical to the \jcsmacro{SetBreak} macro,
but the counter incrementation can be adjusted to the needed time span.

Possible \jmacro{<options>} are:
\begin{itemize}
\item \joption{units=<n>}: Number of interval units the break takes. One \emph{unit}
    is the number of days as specified by the \joption{interval} option (one week by
    default\footnote{The former option \joption{weeks} is deprecated as of v. 0.9,
    since the interval can be adjusted now.}).
    This value is needed in order to increment the internal counter that is used to
    calculate the session dates. If \joption{units} is not specified, the counter is
    incremented by one.\footnote{That is: \jcsmacro{SetBreak\{Break\}} =
    \jcsmacro{SetBreaks\{Break\}} = \jcsmacro{SetBreaks[units=1]\{Break\}}.}
    <n> must be a positive integer.
\item \joption{span=<span>}: Real time span (verbally output on the program)
\end{itemize}
\item \jcsmacro{SetLecOffset\{<n>\}}: Shift the date of all subsequent sessions by <n> days.
    <n> can also be negative.
\item \jcsmacro{SetBeamerFrameBreak}: Add a frame break in
the beamer program at this position (more precisely, start a new frame).
This also increments the frame counter which is used for subsequent program
frame titles. Note that you can insert maximally 3 breaks.
\item \jcsmacro{SetBeamerHook\{<code>\}}: Add arbitrary \LaTeX{}
code to the beamer program
\item \jcsmacro{begin\{SessionBlock\}\{<Block title>\}}\\
\ldots{} \\
\jcsmacro{end\{SessionBlock\}}:\\
Thematic block consisting of several sessions. Respective sessions
are nested inside this block.
\end{itemize}

\section{Retrieving general course information\label{sec:general-course-info}}

Once the metadata file is set up as documented above and input to
your document(s), you can retrieve the recorded as well as some concatenated
information by means the following macros.


\subsection{Course data}

The following macros output general course-specific information:
\begin{itemize}
\item \jcsmacro{lectype}: Outputs the course type in short
form (e.\,g., ``SE'')
\item \jcsmacro{lectypeverb}: Outputs the course type in
verbose form (e.\,g., ``Seminar'')
\item \jcsmacro{lectypesession}: Outputs the appropriate
``session'' string (e.\,g., ``Vorlesung'' or ``Sitzung'')
\item \jcsmacro{lectitle}: Outputs the main title of the
course
\item \jcsmacro{lectitlesep}: Outputs the separator between
title and subtitle
\item \jcsmacro{lecsubtitle}: Outputs the subtitle of the course
\item \jcsmacro{lecfulltitle}: Outputs the course's full title
    (title, separator, subtitle)
\item \jcsmacro{lecshorttitle}: Outputs the short version
of the course title
\item \jcsmacro{lecsemshort}: Outputs the short version of
the term type (e.\,g., ``WS'')
\item \jcsmacro{lecsemverb}: Outputs the verbose version
of the term type (e.\,g., ``Wintersemester'')
\item \jcsmacro{lecyear}: Outputs the year
\item \jcsmacro{lecsemester}: Outputs the short version of
the semester (e.\,g., ``WS 2014'')
\item \jcsmacro{lecsemesterverb}: Outputs the verbose version
of the semester (e.\,g., ``Wintersemester 2014'')
\item \jcsmacro{lecuniversity}: Outputs the university's name
\item \jcsmacro{lecinstitute}: Outputs the institute's name
\item \jcsmacro{lecinstructor}: Outputs the instructor's name
\item \jcsmacro{lecroom}: Outputs the course room
\item \jcsmacro{lecplatform}: Outputs information on the
e-learning platform
\item \jcsmacro{officehours}: Outputs the office hours
\item \jcsmacro{officenumber}: Outputs the office number
\end{itemize}

\subsection{Generating course programs}
\label{sec:lecprog}
\begin{itemize}
\item \jcsmacro{makeprogram}: Generates a course program in the form:


\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\begin{labeling}{\lecprogramlistindent}
\item[<short date>] <session full title>
...
(break)
...
\item[<short date>] <session full title>
\end{labeling}
\end{lstlisting}



The \jmacro{labeling} environment is defined by the KOMA classes.
The package provides a fallback, however, if another class is used.

\item \jcsmacro{makebeamerprogram[<options>]}: Generates
a beamer-suited lecture program from the metadata in the form


\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\begin[label=beamerprogram<nr>,<bfoptions>]{frame}
\frametitle{<Heading>}
\begin{description}[\lecprogramlistindent]
\item[<short date>] <session full title>
...
(break)
...
\item[<short date>] <session full title>
\end{description}
\end{frame}
\end{lstlisting}



\joption{<options>} can be one of
\begin{itemize}
\item \joption{title=<title>}: Program title (<Heading>)
\item \joption{options=<bfoptions>}: Beamer frame options. Note that yey-value
    beamer frame options need to be embraced, as in\\
    \jcsmacro{makebeamerprogram[options=\{shrink=10\}]}
\end{itemize}

Note that multiple subsequent frames are generated if the metadata
file contains \jcsmacro{SetBeamerFrameBreak} macros.
Also note that you can refer to the frames via the automatically generated
labels \emph{beamerprogram} (for the first frame), \emph{beamerprogram2}
for the second, etc. Finally note that the number of program frames
is currently limited to 4. If you need more, you should probably rethink
your program structure.

\end{itemize}

\subsection{Generating bibliographies\label{sub:bibliographies}}

The package provides macros for easy generation of sectioned bibliographies
via \textsf{biblatex}. The macro
\begin{itemize}
\item \jcsmacro{makesessionbib}
\end{itemize}
generates code in the form

\begin{lstlisting}[basicstyle={\small\ttfamily},frame=single,moretexcs={[1]{printbibliography}}]
\section{<session full title>}
\nocite{*}
\printbibliography[keyword=<session keyword>,heading=none]
\end{lstlisting}
 for each session of the lecture which has been linked to a \textsf{biblatex}
keyword via the \joption{bibsec} option (see above sec.~\ref{sec:lecplan}).

So if you specify your session with a keyword via the \joption{bibsec}
option, and tag your Bib\TeX{} database entries with that keyword,
you will get a list of session-specific literature.

\clearpage

\section{Retrieving session-specific information\label{sec:session-specific-info}}

In session-specific documents, you also need information specific
to the current session. This is done as follows.


\subsection{Setting the current session}

Use \jcsmacro{ThisSession\{<nr>\}} to tell the package
which session is current. \joption{<nr>} is an integer value, e.\,g.
\jcsmacro{ThisSession\{3\}} for the 3rd session of
the lecture.


\subsection{Generating session-specific information for the current session}

If you have specified the current session via the macro \jcsmacro{ThisSession},
the following macros output general session-specific information:
\begin{itemize}
\item \jcsmacro{sesdate}: Date of the current session
\item \jcsmacro{sesshortdate}: Date of the current session,
short form (no year)
\item \jcsmacro{sestitle}: Main title of the current session
\item \jcsmacro{sestitlesep}: Title-subtitle separator of
the current session
\item \jcsmacro{sessubtitle}: Subtitle of the current session
\item \jcsmacro{sesfulltitle}: Full title of the current
session (title, separator, subtitle)
\item \jcsmacro{sesinstructor}: Current session's instructor's name
\item \jcsmacro{sespresstudents}: Students presenting in this session
\item \jcsmacro{sesnr}: Number of the current session
\item \jcsmacro{sesroom}: Room of the current session
\end{itemize}

\subsection{Generating session-specific information for an arbitrary session}

Independent of the value of \jcsmacro{ThisSession},
you can retrieve the following information for arbitrary sessions
(session number \joption{<nr>}) via the following macros:
\begin{itemize}
\item \jcsmacro{SessionTitle\{<nr>\}}: Outputs the main title
of session number \joption{<nr>}
\item \jcsmacro{SessionFullTitle\{<nr>\}}: Outputs the full
title (main title, separator, subtitle) of session number \joption{<nr>}
\item \jcsmacro{SessionShortTitle\{<nr>\}}: Outputs the short
title of session number \joption{<nr>}
\item \jcsmacro{SessionDate\{<nr>\}}: Outputs the date of
session number \joption{<nr>}
\item \jcsmacro{SessionShortDate\{<nr>\}}: Outputs the short
date (no year) of session number \joption{<nr>}
\item \jcsmacro{SessionInstructor\{<nr>\}}: Outputs the name of the instructor of session
number \joption{<nr>}
\item \jcsmacro{SessionPresStudents\{<nr>\}}: Outputs the name of the students presenting
in session number \joption{<nr>}
\item \jcsmacro{SessionRoom\{<nr>\}}: Outputs the room of session number \joption{<nr>}
\item \jcsmacro{MakeProgramline\{<nr>\}}: Outputs a list
item line for session number \joption{<nr>} in the form


\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\item[{\bfseries <short date>}] <session full title>
\end{lstlisting}


\end{itemize}


\section{Customizing the output}\label{sec:customizing-strings}


\subsection{Defining and customizing course types}

The following macro allows to define new course types and redefine existing ones:
\begin{itemize}
\item \jcsmacro{DefLecType\{<key>\}\{<short form>\}\{<title>\}\{<session title>\}}
\end{itemize}
A new type, say summer school, thus, could be defined as follows:
\begin{itemize}
\item \jcsmacro{DefLecType\{ss\}\{SS\}\{Summer School\}\{Session\}}
\end{itemize}
This could then be set via \jcsmacro{LecType\{ss\}} or the package option
\joption{type=ss}, respectively.

Likewise, you can use the macro to redefine existing styles, e.\,g. change
the ``session'' string of type \joption{vl} via
\begin{itemize}
\item \jcsmacro{DefLecType\{vl\}\{VL\}\{Vorlesung\}\{Einheit\}}
\end{itemize}
If you need to change or add types, consider the use of styles
(see sec.~\ref{sec:styles}).


\subsection{Defining and customizing term types}

The available term (semester) types can be changed and extended via the macro:
\begin{itemize}
\item \jcsmacro{DefSemType\{<key>\}\{<short form>\}\{<verbose form>\}}
\end{itemize}
Thus, you could add a new term type ``spring term'' via
\begin{itemize}
\item \jcsmacro{DefSemType\{st\}\{ST\}\{Spring Term\}}
\end{itemize}

\subsection{Customizing the date format}

If you need to change the date format, redefine the macros \jcsmacro{lecdateformat}
(for the long format) and \jcsmacro{lecdateshortformat}
(for the short format), using the syntax provided by the \textsf{datetime}
package. By default, the two formats are defined as follows:

\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\newcommand*\lecdateformat{%
    \THEDAY.\,\twodigit{\THEMONTH}.\,\THEYEAR}
\newcommand*\lecdateshortformat{%
    \THEDAY.\,\twodigit{\THEMONTH}.}
\end{lstlisting}


Use \jfcsmacro{renewcommand*} to redefine them.


\subsection{Misc. customizing}

The canceling output is ``Session title -- keine <Session>'' (``keine''
is German for ``no''). To modify or translate this, redefine the
following macro

\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\newcommand*\leccancel{\ -- keine \lectypesession}
\end{lstlisting}


The default program string used in beamer frames can be changed by
redefining

\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\newcommand*\lecprogram{Programm}
\end{lstlisting}


The indentation used in program lists can be changed by redefining

\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
\newcommand*\lecprogramlistindent{\textbf{88.\,88.}}
\end{lstlisting}


Again, use \jfcsmacro{renewcommand{*}} to redefine
those.


\subsection{Using styles}\label{sec:styles}

The most elegant way to do the customizing is to use \emph{lecture planner style} (*.lps) files.
These files can be loaded via the \joption{style=<style>} package option, where <style>
is the file name without *.lps extension.

Currently, the package ships two styles:
\begin{enumerate}
 \item \joption{german-default} simply includes the default strings.
     This style is meant to be used as a model for new styles.
\item \joption{cologne} provides some specifics current at the University of Cologne
     (\emph{Universität zu Köln}):
     \begin{itemize}
      \item Additional course types: \joption{ak} (AK, \emph{Arbeitskurs}),
      \joption{as} (AS, \emph{Aufbauseminar}), \joption{es} (ES, \emph{Einführungsseminar}),
      \joption{evl} (EVL, \emph{Einführungsvorlesung}), \joption{hs} (HS, \emph{Hauptseminar}).
     \end{itemize}
     
\end{enumerate}
If you provide me with other style files, in particular
translations to other languages than German (but also other university conventions), I consider
them for inclusion to the package.


\section{History}

\begin{itemize}
\item 2015/02/27 (v.\,1.0.1):
     \begin{itemize}
       \item Fix a regression introduced by v. 1.0 (\jcsmacro{leccancel}
             was not properly expanded).
     \end{itemize}
\item 2015/02/27 (v.\,1.0):
     \begin{itemize}
       \item Lecture types and term types are not hardcoded anymore and can be freely
             modified and extended via \jcsmacro{DefLecType} and \jcsmacro{DefSemType}.
       \item Add option to add the instructor's name to both the course (via
             \jcsmacro{LecInstructor} or \joption{instructor} package option) and
             to specific sessions (via \joption{instructor} option of
             \jcsmacro{NewSession}).
       \item Add option to add names of presenting students to a session (via
             \joption{presstudents} option).
       \item Add option to record the office number (\jcsmacro{SetOfficeNumber}
             or package option \joption{officenumber}).
       \item Fix expansion issue in \joption{options} option of \jcsmacro{makebeamerprogram}.
       \item Add option to automatically shift all subsequent sessions by a certain value
             after every \emph{n}th session (\jcsmacro{SetAutoOffset}).
       \item Add \joption{cologne} style file.
    \end{itemize}
\item 2015/02/08 (v. 0.9):
     \begin{itemize}
       \item Add a way to adjust the interval between two sessions
             (\joption{interval} package option and \jcsmacro{LecInterval} macro).
       \item Add a way to shift session dates from the regular interval
             (macro \jcsmacro{SetLecOffset}).
       \item Add option and macro to set a room for the course as well as
             a session-specific room.
       \item Rename option \joption{weeks} of the \jcsmacro{SetBreaks} macro
             to \joption{units} (\joption{weeks} still works, but is marked deprecated).
    \end{itemize} 
\item 2015/01/17 (v.\,0.8):
    \begin{itemize}
       \item Fix corruption of \jfcsmacro{today}.
       \item Add framework for different styles.
       \item Add option and macro to set a room for the course as well as
             a session-specific room.
       \item Remove redundant lecture type \joption{vo} from the documentation.
       \item Change \jcsmacro{leccancel} default definition in favour of better
             translatability.
    \end{itemize}\filbreak
\item 2015/01/04 (v.\,0.7):
    \begin{itemize}
       \item Add macro for resetting \jfcsmacro{today}.
       \item Minor corrections in the manual.
    \end{itemize}
\item 2014/12/12 (v.\,0.6\,b): Minor corrections in the manual and example files.
\item 2014/12/12 (v.\,0.6): Initial release to CTAN.
\end{itemize}

\end{document}