summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jslectureplanner/README
blob: 4fd16bd10f523f00f42d76d89e9da3e55d20214d (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
==================================================================
The jslectureplanner package

A LaTeX package to help managing university courses.

Maintained by Jürgen Spitzmüller
E-mail: juergen (at) spitzmueller (dot) org
Code repository and issue tracker:
    https://github.com/jspitz/jslectureplanner

Released under the LaTeX Project Public License v1.3 or later
See http://www.latex-project.org/lppl.txt
==================================================================

== PURPOSE ==

The jslectureplanner package facilitates the generation and managment
of university course material. It provides an interface to set up and
access centralized course data that can be reused in all course documents.
Furthermore, the package is able to calculate the session dates of
a whole semester and generate course programs, if the sessions follow at
regular intervals and the date of the first session is specified.
Moreover, the package can be used to generate a sectioned course
bibliography via biblatex.


== CONTENTS ==

The package consists of the following files:

* jslectureplanner.sty (the LaTeX package)
* german-default.lps (German 'model' style file with default settings)
* cologne.lps (German style file attempted at the Univ. of Cologne)
* jslectureplanner.pdf (package documentation)
* jslectureplanner.tex (documentation source)
* README (this very file)

The following example files are included:

* metadata.tex: example metadata file
* lectureprogram.tex: example course program
* lectureprogram.pdf
* lecturescript.tex: example course script
* lecturescript.pdf
* lecturepresentation.tex: example course presentation
* lecturepresentation.pdf
* lecturehandout.tex: example course handout
* lecturehandout.pdf
* lecpresbody.tex: common body of presentation/handout
* lecturebib.tex: example course bibliography
* lecturebib.pdf
* lectureplanner-examples.bib


== DOCUMENTATION ==

See the included manual jslectureplanner.pdf for usage
instructions; also have a look at the example files.


== CHANGES ==

* V. 1.0.1 (2015-02-27): - Fix a regression introduced by v. 1.0 (\leccancel not properly
                           expanded).

* V. 1.0 (2015-02-27):   - Lecture types and term types are not hardcoded anymore and can
                           be freely modified and extended via \DefLecType and \DefSemType.
                         - Add option to add the instructor's name to both the course
                           (via \LecInstructor or 'instructor' package option) and to
                           specific sessions (via 'instructor' option of \NewSession).
                         - Add option to add names of presenting students to a session
                           (via 'presstudents' option).
                         - Add option to record the office number (\SetOfficeNumber
                           or 'officenumber' package option) [github issue #3].
                         - Add option to automatically shift all subsequent sessions by
                           a certain value after every nth session (\SetAutoOffset).
                           [github issue #2]
                         - Fix expansion issue in 'options' option of
                           \makebeamerprogram.
                         - Add 'cologne' style file.

* V. 0.9 (2015-02-08):   - Add a way to adjust the interval between two sessions
                           ('interval' package option and \LecInterval macro).
                         - Add a way to shift session dates from the regular
                           interval (\SetLecOffset).
                         - Rename option 'weeks' of the \SetBreaks macro to 'units'
                           ('weeks' still works, but is marked deprecated).

* V. 0.8 (2015-01-17):   - Fix corruption of \today.
                         - Add framework for different styles.
                         - Add option and macro to set a room
                           for the course as well as a
                           session-specific room.
                         - Remove redundant lecture type "vo"
                           from the documentation.
                         - Change \leccancel default definition
                           in favour of better translatability.

* V. 0.7 (2015-01-04):   - Add macro for resetting \today.
                         - Minor corrections in the manual.

* V. 0.6b (2014-12-12):  - Minor corrections in the manual and
                           example files.

* V. 0.6 (2014-12-12):   - Initial release to CTAN.