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, 51 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex index 200bb441ebc..2086eaf92db 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex +++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex @@ -69,7 +69,7 @@ \author{Jürgen Spitzmüller% \thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}.}} -\date{Version 1.3, 2016/08/31} +\date{Version 1.4, 2016/10/19} \maketitle @@ -222,21 +222,22 @@ Also cf. sec.~\ref{sec:styles}. \item [\joption{year=<year>}] Year of the term \item [\joption{uni=<university>}] Your university \item [\joption{institute=<institute>}] Your institute/department -\item [\joption{room=<room>}] The room where the course generally takes place. - It is possible to specify diverging rooms for individual sessions - (see sec. \ref{sec:lecplan}). +\item [\joption{room=<room>}] The room where the course generally takes place; + it is possible to specify diverging rooms for individual sessions + (see sec. \ref{sec:lecplan}) \item [\joption{startdate=<startdate>}] The date of the first session (the argument - \emph{must} have the form DD/MM/YYYY). If no startdate is given, - \jfcsmacro{today} is used. -\item [\joption{interval=<interval>}] The interval (in days) between two sessions. - The preset interval is 7 (=~weekly courses). + \emph{must} have the form DD/MM/YYYY); if no startdate is given, + \jfcsmacro{today} is used +\item [\joption{interval=<interval>}] The interval (in days) between two sessions; + the preset interval is 7 (=~weekly courses) \end{description} \subsubsection{Additional information} \begin{description} -\item [\joption{instructor=<name>}] (General) course instructor's name. - It is possible to specify different or specific instructors for individual sessions - (see sec. \ref{sec:lecplan}). +\item [\joption{instructor=<name>}] (General) course instructor's name; + it is possible to specify different or specific instructors for individual sessions + (see sec. \ref{sec:lecplan}) +\item [\joption{shortinstructor=<name>}] Short form of the (general) course instructor's name (e.\,g., for headings) \item [\joption{platform=<data>}] Information of the e-learning platform (such as the URL) \item [\joption{officehours=<data>}] Date of your office hours @@ -306,7 +307,7 @@ the first session (the argument \emph{must} have the form DD/MM/YYYY) \subsubsection{Additional information}\label{ses-add} \begin{itemize} -\item \jcsmacro{LecInstructor\{<name>\}}: Record the (general) instructor's name +\item \jcsmacro{LecInstructor[<short name>]\{<name>\}}: Record the (general) instructor's name, including an optional short form for headings etc. \item \jcsmacro{SetOfficeHours\{<office hours>\}}: Record date of your office hours \item \jcsmacro{SetOfficeNumber\{<office number>\}}: Record your office (room) number \item \jcsmacro{SetPlatform\{<platform information>\}}: Record information @@ -331,6 +332,7 @@ Valid \joption{<options>} include: headings etc.) \item \joption{instructor=<name>}: Specific instructor for this session (if it differs from the usual course instructor) +\item \joption{shortinstructor=<name>}: Short form of the specific instructor for this session \item \joption{presstudents=<names>}: Students presenting in this session (used for student presentation lists, see below sec.~\ref{sec:preslists}) \item \joption{room=<room>}: Specific room for this session (if it differs @@ -438,7 +440,10 @@ title and subtitle \item \jcsmacro{lecfulltitle}: Outputs the course's full title (title, separator, subtitle) \item \jcsmacro{lecshorttitle}: Outputs the short version -of the course title +of the course title; if no explicit short title is specified, +the normal title is output (you can check whether +there is a unique short title by the test +\jcsmacro{iftoggle\{uniquelecshorttitle\}\{<true>\}\{<false>\}}) \item \jcsmacro{lecsemshort}: Outputs the short version of the term type (e.\,g., ``WS'') \item \jcsmacro{lecsemverb}: Outputs the verbose version @@ -451,6 +456,10 @@ of the semester (such as ``Winter\-semester 2014'') \item \jcsmacro{lecuniversity}: Outputs the university's name \item \jcsmacro{lecinstitute}: Outputs the institute's/department's name \item \jcsmacro{lecinstructor}: Outputs the (general) instructor's name +\item \jcsmacro{lecshortinstructor}: Outputs short form of the (general) instructor's name; +if no explicit short name is given, the normal name will be output (you can check whether +there is a unique short name by the test +\jcsmacro{iftoggle\{uniquelecshortinstructor\}\{<true>\}\{<false>\}}) \item \jcsmacro{lecroom}: Outputs the (general) course room \item \jcsmacro{lecplatform}: Outputs information on the e-learning platform @@ -615,12 +624,21 @@ the following macros output general session-specific information: \item \jcsmacro{sesshortdate}: Date of the current session, short form (no year) \item \jcsmacro{sestitle}: Main title of the current session +\item \jcsmacro{sesshorttitle}: Short title of the current session; if +no explicit short title is specified, the normal [main] title is output +(you can check whether there is a unique short title by the test +\jcsmacro{iftoggle\{uniquesesshorttitle\}\{<true>\}\{<false>\}}) \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{sesinstructor}: Current session's instructor's name; if you want to output this name only if it differs from the general instructor (\jcsmacro{lecinstructor}), use the starred version \jcsmacro{sesinstructor*} (furthermore, you can check whether +there is a unique session instructor by the test +\jcsmacro{iftoggle\{uniquesesinstructor\}\{<true>\}\{<false>\}}) +\item \jcsmacro{sesshortinstructor}: Current session's instructor's short name; if you want to output this name only if it differs from the general instructor (\jcsmacro{lecshortinstructor}), use the starred version \jcsmacro{sesshortinstructor*}; if no explicit instructor short name is given, the normal instructor name will be output (you can check whether +there is a unique short instructor [that differs from the long session instructor name] by the test +\jcsmacro{iftoggle\{uniquesesshortinstructor\}\{<true>\}\{<false>\}}) \item \jcsmacro{sespresstudents}: Students presenting in this session \item \jcsmacro{sesnr}: Number of the current session \item \jcsmacro{sesroom}: Room of the current session @@ -636,11 +654,14 @@ information for sessions that follow or precede the current session by a specifi \item \jcsmacro{AdjSessionFullTitle[<offset>]}: Outputs the full title (main title, separator, subtitle) of the adjacent session \item \jcsmacro{AdjSessionShortTitle[<offset>]}: Outputs the short - title of the adjacent session + title of the adjacent session; if no explicit short title is specified, the normal main title is output \item \jcsmacro{AdjSessionDate[<offset>]}: Outputs the date of the adjacent session \item \jcsmacro{AdjSessionShortDate[<offset>]}: Outputs the short date (no year) of the adjacent session \item \jcsmacro{AdjSessionInstructor[<offset>]}: Outputs the name of the instructor of the adjacent session + \item \jcsmacro{AdjSessionInstructor*[<offset>]}: Outputs the name of the instructor of the adjacent session if it differs from the general instructor (\jcsmacro{lecinstructor}) + \item \jcsmacro{AdjSessionShortInstructor[<offset>]}: Outputs the short name (or normal name, if no short name was specified) of the instructor of the adjacent session if it differs from the general instructor (\jcsmacro{lecshortinstructor}) + \item \jcsmacro{AdjSessionShortInstructor*[<offset>]}: Outputs the short name (or normal name, if no short name was specified) of the instructor of the adjacent session \item \jcsmacro{AdjSessionPresStudents[<offset>]}: Outputs the name of the students presenting in the adjacent session \item \jcsmacro{AdjSessionRoom[<offset>]}: Outputs the room of the adjacent session \end{itemize} @@ -657,13 +678,20 @@ 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>} +title of session number \joption{<nr>}; if +no explicit short title is specified, the normal main title is output \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{SessionInstructor*\{<nr>\}}: Outputs the name of the instructor of session +number \joption{<nr>} if it differs from the general instructor (\jcsmacro{lecinstructor}) +\item \jcsmacro{SessionShortInstructor\{<nr>\}}: Outputs the short name (or normal name, if no short name was specified) of the instructor of session +number \joption{<nr>} +\item \jcsmacro{SessionShortInstructor*\{<nr>\}}: Outputs the short name (or normal name, if no short name was specified) of the instructor of session +number \joption{<nr>} if it differs from the general instructor (\jcsmacro{lecinstructor}) \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>} @@ -1021,6 +1049,13 @@ the \jslp\ style files. Thanks, Dominik. \section{Release History} \begin{itemize} +\item 2016/10/19 (v. 1.4): + \begin{itemize} + \item Add instructor short forms for lecture and session. + \item Add starred versions of the \jcsmacro{sesinstructor}, \jcsmacro{SessionInstructor} and \jcsmacro{AdjSessionInstructor} macros that only produce output if the session instructor differs from the general course instructor. + \item All short\{instructor|title\} macros now output the long version if no short form was defined. + \item Add boolean tests for unique short forms and session instructors. + \end{itemize} \item 2016/08/31 (v. 1.3): \begin{itemize} \item \textbf{Backwards-incompatible change!} Use \textsf{datetime2} instead of \textsf{datetime} and \textsf{advdate}. |