summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex')
-rw-r--r--Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex57
1 files changed, 38 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
index 8d3a0399dc5..5f124404152 100644
--- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
+++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
@@ -4,6 +4,7 @@
\usepackage[scaled=0.87]{beramono}
\usepackage[T1]{fontenc}
\usepackage[latin9]{inputenc}
+\usepackage{url}
% markup
\newcommand*\jmacro[1]{\textbf{\texttt{#1}}}
@@ -25,9 +26,10 @@
\title{The jslectureplanner package}
-\author{Jürgen Spitzmüller\thanks{juergen@spitzmueller.org}}
+\author{Jürgen Spitzmüller%
+\thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}}}
-\date{Version 0.6\,b, 2014/12/12}
+\date{Version 0.7, 2015/01/04}
\maketitle
@@ -141,7 +143,7 @@ etc.)
\begin{itemize}
\item \joption{fs}: spring term (``Frühjahrssemester'', short form: ``FS'')
-\item \joption{hs}: autumn term (``Herbstsemester'', short form: ``HS'')
+\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}
@@ -149,7 +151,8 @@ etc.)
\item [{uni=<university>}]~
\item [{institute=<institute>}]~
\item [{startdate=<startdate>}] Date of the first session (argument\emph{
-must} have the form DD/MM/YYYY)
+must} have the form DD/MM/YYYY). Note that this option changes the value of \jfcsmacro{today}.
+See sec.~\ref{sec:resetdate} how to reset it.
\end{description}
\subsubsection{Additional information}
@@ -170,13 +173,13 @@ subsection.
description.}
\begin{itemize}
-\item \joption{vl}
-\item \joption{vo}
-\item \joption{ps}
-\item \joption{se}
-\item \joption{ue}
-\item \joption{ko}
-\item \joption{pv}
+\item \joption{vl}: lecture (\emph{Vorlesung})
+\item \joption{vo}: lecture (alternative)
+\item \joption{ps}: undergraduate seminar (\emph{Proseminar})
+\item \joption{se}: seminar (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}
@@ -197,17 +200,19 @@ year of the course; \joption{<term>} is one of\footnote{See above sec.~\ref{sec:
description.}
\begin{itemize}
-\item \joption{fs}
-\item \joption{hs}
-\item \joption{ss}
-\item \joption{ws}
+\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>\}}: Set the name of
your university
\item \jcsmacro{LecInstitute\{<institute>\}}: Set your institute
name
\item \jcsmacro{LecStartDate\{<startdate>\}}: Set date of
-the first session (argument\emph{ must} have the form DD/MM/YYYY)
+the first session (argument\emph{ must} have the form DD/MM/YYYY).
+Note that this macro changes the value of \jfcsmacro{today}.
+See sec.~\ref{sec:resetdate} how to reset it.
\end{itemize}
\subsubsection{Additional information}
@@ -298,6 +303,8 @@ code to the beamer program
Thematic block consisting of several sessions. Respective sessions
are nested inside this block.
\end{itemize}
+Note that setting up a course plan changes the value of \jfcsmacro{today}.
+See sec.~\ref{sec:resetdate} how to reset it.
\section{Retrieving general course information\label{sec:general-course-info}}
@@ -343,6 +350,7 @@ e-learning platform
\end{itemize}
\subsection{Generating lecture programs}
+\label{sec:lecprog}
\begin{itemize}
\item \jcsmacro{makeprogram}: Generates a lecture program
from the metadata in the form
@@ -478,6 +486,16 @@ item line for session number \joption{<nr>} in the form
\end{itemize}
+
+\section{Resetting the current date}
+\label{sec:resetdate}
+
+The date calculation mechanism (as provided by the \textsf{advdate} package) rewrites the value
+of \jfcsmacro{today}. So after you defined a start date via the \joption{startdate} option or
+the \jcsmacro{LecStartDate} macro and/or set up a course plan as described in sec.~\ref{sec:lecprog},
+\jfcsmacro{today} will most likely not return today's date anymore.
+To restore the current date, use the macro \jcsmacro{ResetDate} after your course plan has been set up.
+
\section{Customizing the output}
@@ -555,15 +573,16 @@ The indentation used in program lists can be changed by redefining
\end{lstlisting}
-Again, use \jfmacro{\textbackslash{}renewcommand{*}} to redefine
+Again, use \jfcsmacro{renewcommand{*}} to redefine
those.
\section{History}
\begin{itemize}
-\item 2012/12/12 (v. 0.6\,b): Minor corrections in the manual and example files.
-\item 2012/12/12 (v. 0.6): Initial release to CTAN.
+\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.
\end{itemize}
\end{document}