diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex | 67 |
1 files changed, 44 insertions, 23 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex index 5d86eee9f57..315435eb6a5 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex +++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex @@ -72,7 +72,7 @@ \author{Jürgen Spitzmüller% \thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}.}} -\date{Version 1.8, 2019/02/06} +\date{Version 1.9, 2020/02/04} \maketitle @@ -312,12 +312,21 @@ your university Default is 90. \item \jcsmacro{LecInterval\{\jparam{interval}\}}: Adjust the interval (in days) between two sessions. The preset interval is 7 (=~weekly courses). -\item \jcsmacro{SetAutoOffset\{\jparam{n}\}\{\jparam{days}\}}: Automatically shift all subsequent sessions - by \jparam{days} extra days after every \jparam{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\}}). \jparam{n} must be a positive integer, \jparam{days} can - also be a negative integer value. +\item \jcsmacro{SetAutoOffset[\jparam{first}]\{\jparam{n}\}\{\jparam{days}\}}: + Automatically shift all subsequent sessions + by \jparam{days} extra days after every \jparam{n}th session, + counting the first session as the \jparam{first}th session for + this purpose. This is useful if your course meets multiple times + a week. For instance, a course meeting Tuesdays and Thursdays + could be defined via \jcsmacro{LecInterval\{2\}} and + \jcsmacro{SetAutoOffset\{2\}\{3\}}, a course meeting Monday, + Wednesday, Friday using \jcsmacro{LecInterval\{2\}} and + \jcsmacro{SetAutoOffset\{3\}\{1\}}. \jparam{n} must be a + positive integer, \jparam{days} can also be a negative integer + value. Use the optional \jparam{first} if the first session in + the course is not the first session in a group. For instance, if + your course meets Monday/Wednesday/Friday but the first day of + term is a Wednesday, use \jcsmacro{SetAutoOffset[2]\{3\}\{1\}}. \end{itemize} \subsubsection{Additional information}\label{ses-add} @@ -437,10 +446,10 @@ Possible \jmacro{\jparam{options}} are: \end{itemize} \item \jcsmacro{SetLecOffset\{\jparam{n}\}}: Shift the date of all subsequent sessions by \jparam{n} days. \jparam{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{SetBeamerFrameBreak}: Add a frame break in the beamer program at this position + (more precisely, start a new frame; see sec.~\ref{sec:lecprog} for details). + 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\{\jparam{code}\}}: Add arbitrary LaTeX code to the beamer program \item \jcsmacro{begin\{SessionBlock\}\{\jparam{Block title}\}}\\ @@ -545,14 +554,18 @@ a beamer-suited lecture program from the metadata in the form \end{frame} \end{lstlisting} -Note that multiple subsequent frames (not just slides) 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. - +Note that +\begin{itemize} + \item multiple subsequent frames (not just slides) are generated if the metadata + file contains \jcsmacro{SetBeamerFrameBreak} macros (this is because beamer frame breaks + via \jfoption{allowframebreaks} and \jfcsmacro{framebreak} do not allow for overlays). + \item you can refer to the frames via the automatically generated + labels \emph{beamerprogram} (for the first frame), \emph{beamerprogram2} + for the second, etc. + \item the number of program frames is currently limited to 4. If you need more, you should probably rethink + your program structure. +\end{itemize} +% \joption{\jparam{options}} include \begin{itemize} \item \joption{title=\jparam{title}}: Program title (\jparam{Heading}) @@ -1164,7 +1177,7 @@ linked to \jslp's \jcsmacro{lectypesession} value if I could not have written the packages of the \jslp\ bundle without the expertise of the incredible \LaTeX\ community. The packages heavily rely on functions and features provided by other packages (which are listed in sec.~\ref{sec:req-jslp} and \ref{sec:req-jsmt}). -I am deeply indepted to the authors of those packages. +I am deeply indebted to the authors of those packages. Furthermore, \emph{stackexchange} proved to be a great source of knowledge which provided me with solutions for specific tasks: \jsmt\ heavily draws on code for dynamic table generation that has been @@ -1173,17 +1186,25 @@ use code to test for \jfcsmacro{romannumeral} arguments which has been taken fro a \emph{stackexchange} post by Enrico Gregorio (\url{http://tex.stackexchange.com/a/50131}). The time span calculation uses code provided by Christian Hupfer at \url{https://tex.stackexchange.com/a/473552/19291}. -Thank you, Herbert, Enrico and Christian! Finally, Dominik Waßenhoven tested the package and provided +Thank you, Herbert, Enrico and Christian! +Richard Zach provided a fix and enhancement to \jcsmacro{SetAutoOffset}. Many thanks for this. +Finally, Dominik Waßenhoven tested the package and provided me with multiple suggestions, which effectively manifested in major new features such as the \jslp\ style files. Thanks, Dominik. \section{Release History} \begin{itemize} +\item 2020/02/04 (v. 1.9): + \begin{itemize} + \item Allow \jcsmacro{SetBeamerFrameBreak} within \joption{SessionBlock}. + \item Fix \jcsmacro{SetAutoOffset} at first session and add optional argument + to alter first session (fix contributed by Richard Zach). + \end{itemize} \item 2019/02/06 (v. 1.8): \begin{itemize} - \item Add support for displaying the next semester (\jcsmacro{AdjSem} and - \jcsmacro{AdjSemVerb}). + \item Add support for displaying the next semester (macros \jcsmacro{adjsemester} and + \jcsmacro{adjsemesterverb}). \item Add support for lecture and session start time, duration and thus also end time calculation. \item Add unstyled date formats which allow preceding \jfcsmacro{DTMsetdatestyle} |