summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jslectureplanner
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-02-27 22:46:08 +0000
committerKarl Berry <karl@freefriends.org>2015-02-27 22:46:08 +0000
commit59ec3703e8068266ab208e8c512cc16a0105a229 (patch)
tree9ff64fa091221652ebb6423b94c49fe2d34350d0 /Master/texmf-dist/doc/latex/jslectureplanner
parent724b5c167d2eea34d93f9d021bf9437aa9c334bc (diff)
jslectureplanner (27feb15)
git-svn-id: svn://tug.org/texlive/trunk@36395 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/jslectureplanner')
-rw-r--r--Master/texmf-dist/doc/latex/jslectureplanner/README24
-rw-r--r--Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdfbin116569 -> 119854 bytes
-rw-r--r--Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex188
3 files changed, 155 insertions, 57 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/README b/Master/texmf-dist/doc/latex/jslectureplanner/README
index 626e6e34fd6..4fd16bd10f5 100644
--- a/Master/texmf-dist/doc/latex/jslectureplanner/README
+++ b/Master/texmf-dist/doc/latex/jslectureplanner/README
@@ -29,7 +29,8 @@ bibliography via biblatex.
The package consists of the following files:
* jslectureplanner.sty (the LaTeX package)
-* german-default.lps (German style file)
+* 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)
@@ -59,8 +60,27 @@ 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 \LecInternal macro).
+ ('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'
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf
index cb69d62a530..894df05da19 100644
--- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf
+++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
index eace8e47c81..5d12a545f24 100644
--- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
+++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
@@ -29,7 +29,7 @@
\author{Jürgen Spitzmüller%
\thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}.}}
-\date{Version 0.9, 2015/02/08}
+\date{Version 1.0.1, 2015/02/27}
\maketitle
@@ -59,9 +59,9 @@ 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 to customize them to some
-degree, particularly to translate them to other languages. This is
-described later in this manual.
+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
@@ -107,13 +107,13 @@ or via specific macros (see sec.~\ref{sec:via-macros}).
\subsubsection{Course classification\label{sec:lecture-classification}}
-The course classification draws on the conventions at German universities
+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. Possible values:
+\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}
@@ -129,6 +129,9 @@ form: ``UE'', 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}
@@ -149,6 +152,9 @@ short form: ``PV'', session form: ``Sitzung'')
\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>}]~
@@ -161,13 +167,15 @@ must} have the form DD/MM/YYYY). If no startdate is given, \jfcsmacro{today} is
\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 interface to set up the course metadata.
+The following macros provide an alternative way to set up the course metadata.
\subsubsection{Course classification}
\begin{itemize}
@@ -189,8 +197,8 @@ description.}
\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} (except for \joption{title} itself),
-so this macro can actually be used to record all metadata.
+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
@@ -198,7 +206,7 @@ title-subtitle separator (e.\,g., ``. '' or `` -- '')
\subsubsection{Date and place}
\begin{itemize}
-\item \textbackslash{}\jmacro{LecYear\{<term>\}\{<year>\}}, Record term and
+\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.}
@@ -216,17 +224,23 @@ your university
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}
-\clearpage
-
\section{Setting up a course schedule\label{sec:lecplan}}
In the metadata file, you can set up a schedule for the course by entering
@@ -241,8 +255,11 @@ Valid \joption{<options>}:
\item \joption{titlesep=<separator>}: Separator between session title and
subtitle
\item \joption{subtitle=<subtitle>}: Subtitle of the session
-\item \joption{shorttitle=<shorttitle>}: Short title of the session (for
+\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
@@ -344,10 +361,9 @@ verbose form (e.\,g., ``Seminar'')
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 full title of
-the course (title, separator, 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
@@ -361,17 +377,18 @@ the semester (e.\,g., ``WS 2014'')
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
-from the metadata in the form
+\item \jcsmacro{makeprogram}: Generates a course program in the form:
\begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single]
@@ -411,7 +428,9 @@ a beamer-suited lecture program from the metadata in the form
\joption{<options>} can be one of
\begin{itemize}
\item \joption{title=<title>}: Program title (<Heading>)
-\item \joption{options=<bfoptions>}: Beamer frame options
+\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
@@ -475,6 +494,8 @@ 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}
@@ -495,6 +516,10 @@ title of session number \joption{<nr>}
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
@@ -511,33 +536,37 @@ item line for session number \joption{<nr>} in the form
\section{Customizing the output}\label{sec:customizing-strings}
-\subsection{Customizing the course type strings}
+\subsection{Defining and customizing course types}
-The strings of the course types can be changed via the macros:
+The following macro allows to define new course types and redefine existing ones:
\begin{itemize}
-\item \jcsmacro{DefTypeVL\{<short form>\}\{<title>\}\{<session title>\}}
-\item \jcsmacro{DefTypePS\{<short form>\}\{<title>\}\{<session title>\}}
-\item \jcsmacro{DefTypeSE\{<short form>\}\{<title>\}\{<session title>\}}
-\item \jcsmacro{DefTypeUE\{<short form>\}\{<title>\}\{<session title>\}}
-\item \jcsmacro{DefTypeKO\{<short form>\}\{<title>\}\{<session title>\}}
-\item \jcsmacro{DefTypePV\{<short form>\}\{<title>\}\{<session title>\}}
+\item \jcsmacro{DefLecType\{<key>\}\{<short form>\}\{<title>\}\{<session title>\}}
\end{itemize}
-An English form for a lecture, thus, can be achieved by e.\,g.
+A new type, say summer school, thus, could be defined as follows:
\begin{itemize}
-\item \jcsmacro{DefTypeVL\{LEC\}\{Lecture\}\{Session\}}
+\item \jcsmacro{DefLecType\{ss\}\{SS\}\{Summer School\}\{Session\}}
\end{itemize}
-The types themselves are hardcoded. If you need further\slash{}other
-types, you need to modify the package (or ask me to do it).
+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{Customizing the term types}
+\subsection{Defining and customizing term types}
-The strings of the term types can be changed via the macros:
+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{DefTypeFS\{<short form>\}\{<verbose form>\}}
-\item \jcsmacro{DefTypeHS\{<short form>\}\{<verbose form>\}}
-\item \jcsmacro{DefTypeSS\{<short form>\}\{<verbose form>\}}
-\item \jcsmacro{DefTypeWS\{<short form>\}\{<verbose form>\}}
+\item \jcsmacro{DefSemType\{st\}\{ST\}\{Spring Term\}}
\end{itemize}
\subsection{Customizing the date format}
@@ -555,7 +584,7 @@ package. By default, the two formats are defined as follows:
\end{lstlisting}
-Use \jfmacro{\textbackslash{}renewcommand{*}} to redefine them.
+Use \jfcsmacro{renewcommand*} to redefine them.
\subsection{Misc. customizing}
@@ -588,14 +617,26 @@ Again, use \jfcsmacro{renewcommand{*}} to redefine
those.
-\subsection{Using styles}
+\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 only one style, \emph{german-default}, which includes the default
-strings. This one can be used as a model. If you provide me with other style files, in particular
+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.
@@ -603,19 +644,56 @@ them for inclusion to the package.
\section{History}
\begin{itemize}
-\item 2015/02/08 (v. 0.9): Add a way to adjust the interval between two sessions
- (\joption{interval} package option and \jcsmacro{LecInternal} macro); add a way to shift
- session dates from the regular interval (\jcsmacro{SetLecOffset}); rename option \joption{weeks}
- of the \jcsmacro{SetBreaks} macro to \joption{units} (\joption{weeks} still works, but is
- marked deprecated).
-\item 2015/01/17 (v. 0.8): Fix corruption of \jfcsmacro{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 \joption{vo} from the documentation;
- change \jcsmacro{leccancel} default definition in favour of better translatability.
-\item 2015/01/04 (v. 0.7): Add macro for resetting \jfcsmacro{today}; minor corrections in the manual.
-\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.
+\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}