diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex | 58 |
1 files changed, 31 insertions, 27 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex index 5f124404152..86da67de7d5 100644 --- a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex +++ b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex @@ -27,9 +27,9 @@ \title{The jslectureplanner package} \author{Jürgen Spitzmüller% -\thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}}} +\thanks{Please report issues via \protect\url{https://github.com/jspitz/jslectureplanner}.}} -\date{Version 0.7, 2015/01/04} +\date{Version 0.8, 2015/01/17} \maketitle @@ -112,9 +112,6 @@ in ``the second \emph{session} of this course''). \begin{itemize} \item \joption{vl}: a lecture (verbose form: ``Vorlesung''\footnote{Sec.~\ref{sec:customizing-strings} explains how to customize these strings.}, short form: ``VL'', session form: ``Vorlesung'') -\item \joption{vo}: also a lecture\footnote{The division of ``vl'' and ``vo'' has historical (personal) reasons.} -(verbose form: ``Vorlesung'', short form: ``VO'', session form: -``Vorlesung'') \item \joption{ps}: undergraduate seminar (verbose form: ``Proseminar'', short form: ``PS'', session form: ``Sitzung'') \item \joption{se}: seminar (verbose form: ``Seminar'', short form: ``SE'', @@ -150,9 +147,9 @@ etc.) \item [{year=<year>}]~ \item [{uni=<university>}]~ \item [{institute=<institute>}]~ +\item [{room=<room>}]~ \item [{startdate=<startdate>}] Date of the first session (argument\emph{ -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. +must} have the form DD/MM/YYYY). \end{description} \subsubsection{Additional information} @@ -174,9 +171,8 @@ description.} \begin{itemize} \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{se}: seminar (\emph{Seminar}) \item \joption{ue}: practical course (\emph{Übung}) \item \joption{ko}: colloquium (\emph{Kolloquium}) \item \joption{pv}: research seminar (\emph{Privatissimum}) @@ -209,10 +205,9 @@ description.} your university \item \jcsmacro{LecInstitute\{<institute>\}}: Set your institute name +\item \jcsmacro{LecRoom\{<room>\}}: Set the room where the course takes place \item \jcsmacro{LecStartDate\{<startdate>\}}: Set date of 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} @@ -239,6 +234,7 @@ subtitle \item \joption{subtitle=<subtitle>}: Subtitle of the session \item \joption{shorttitle=<shorttitle>}: Short title of the session (for headings etc.) +\item \joption{room=<room>}: Specific room for this session (if it differs) \item \joption{bibsec=<keyword>}: Session keyword for the bibliography (see below sec.~\ref{sub:bibliographies}) \item \joption{cancel=<true|false>}: Whether this session takes place. @@ -303,8 +299,6 @@ 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}} @@ -344,6 +338,7 @@ the semester (e.\,g., ``WS 2014'') of the semester (e.\,g., ``Wintersemester 2014'') \item \jcsmacro{lecuniversity}: Outputs the university name \item \jcsmacro{lecinstitute}: Outputs the institute name +\item \jcsmacro{lecroom}: Outputs the room \item \jcsmacro{lecplatform}: Outputs information on the e-learning platform \item \jcsmacro{officehours}: Outputs the office hours @@ -457,6 +452,7 @@ the current session \item \jcsmacro{sesfulltitle}: Full title of the current session (title, separator, subtitle) \item \jcsmacro{sesnr}: Number of the current session +\item \jcsmacro{sesroom}: Room of the current session \end{itemize} \subsection{Generating session-specific information for an arbitrary session} @@ -475,6 +471,7 @@ 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{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 @@ -487,24 +484,14 @@ item line for session number \joption{<nr>} in the form \end{itemize} -\section{Resetting the current date} -\label{sec:resetdate} +\section{Customizing the output}\label{sec:customizing-strings} -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} - - -\subsection{Customizing the course type strings\label{sec:customizing-strings}} +\subsection{Customizing the course type strings} The strings of the course types can be changed via the macros: \begin{itemize} \item \jcsmacro{DefTypeVL\{<short form>\}\{<title>\}\{<session title>\}} -\item \jcsmacro{DefTypeVO\{<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>\}} @@ -516,7 +503,7 @@ An English form for a lecture, thus, can be achieved by e.\,g. \item \jcsmacro{DefTypeVL\{LEC\}\{Lecture\}\{Session\}} \end{itemize} The types themselves are hardcoded. If you need further\slash{}other -types, you need to modify the package. +types, you need to modify the package (or ask me to do it). \subsection{Customizing the term types} @@ -554,7 +541,7 @@ is German for ``no''). To modify or translate this, redefine the following macro \begin{lstlisting}[language={[LaTeX]TeX},basicstyle={\small\ttfamily},frame=single] -\newcommand*\leccancel{-- keine} +\newcommand*\leccancel{\ -- keine \lectypesession} \end{lstlisting} @@ -577,9 +564,26 @@ Again, use \jfcsmacro{renewcommand{*}} to redefine those. +\subsection{Using 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 +translations to other languages than German (but also other university conventions), I consider +them for inclusion to the package. + + \section{History} \begin{itemize} +\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. |