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.tex51
1 files changed, 39 insertions, 12 deletions
diff --git a/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex b/Master/texmf-dist/doc/latex/jslectureplanner/jslectureplanner.tex
index 2086eaf92db..17760427596 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.4, 2016/10/19}
+\date{Version 1.5, 2017/03/12}
\maketitle
@@ -119,7 +119,7 @@ bibliography for the course via \textsf{biblatex}.
Since the package has been 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
+of the package draws on this context. In particular, all default strings and
formats are German. However, it is possible to add new categories as
well as to customize and translate the strings.
This is described later in this manual.
@@ -237,14 +237,17 @@ Also cf. sec.~\ref{sec:styles}.
\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{shortinstructor=<name>}] Short form of the 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
\item [\joption{officenumber=<data>}] Your office (room) number
\end{description}
-\clearpage
+\subsubsection{Other global settings}
+\begin{description}
+ \item[\joption{sestitlesep=<separator>}] Specifies a default separator between session title and subtitle
+\end{description}
\subsection{Via macros\label{sec:via-macros}}
@@ -314,6 +317,11 @@ the first session (the argument \emph{must} have the form DD/MM/YYYY)
(such as URL) of the e-learning platform
\end{itemize}
+\subsubsection{Other global settings}\label{ses-global}
+\begin{itemize}
+\item \jcsmacro{SessionTitleSep\{<separator>\}}: Specify a default separator between session title and subtitle (e.\,g., ``. '' or `` -- ''). This is used if no specific separator has been specified in the session entry (see sec.~\ref{sec:lecplan}); by default, no separator is defined.
+\end{itemize}
+
\section{Setting up a course schedule}\label{sec:lecplan}
In the metadata file, you can set up a schedule for the course by entering
@@ -326,7 +334,8 @@ macro:
Valid \joption{<options>} include:
\begin{itemize}
\item \joption{titlesep=<separator>}: Separator between session title and
- subtitle
+ subtitle (e.\,g., \verb|titlesep={.\ }|); this overrides any global separator set via \joption{sestitlesep} option
+ or \jcsmacro{SessionTitleSep} macro for the current session
\item \joption{subtitle=<subtitle>}: Subtitle of the session
\item \joption{shorttitle=<shorttitle>}: Short title (for
headings etc.)
@@ -335,7 +344,7 @@ Valid \joption{<options>} include:
\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
+\item \joption{room=<room>}: Room for this session (if it differs
from the usual course room)
\item \joption{bibsec=<keyword>}: Session keyword for the bibliography
(see below sec.~\ref{sub:bibliographies} for its use)
@@ -805,11 +814,14 @@ The most elegant way to do the customizing is to use \emph{lecture planner style
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 two styles:
+Currently, the package ships three styles:
\begin{enumerate}
- \item \joption{german-default} simply includes the default strings.
+ \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
+ \item \joption{english} is a proof-of-concept localization to English.
+ This style can be used as a basis for English styles. The English examples
+ included in the \jslp\ bundle use this style.
+ \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}),
@@ -871,9 +883,10 @@ The package is loaded as usual:
\begin{quote}
\jcsmacro{usepackage[<options>]\{jsmembertable\}}
\end{quote}
-Currently, one package option is available:
+Currently, the following package options are available:
\begin{itemize}
\item \joption{datafile=<csv-file>}: Use external student data file (see sec.~\ref{sec:ext-data}).
+ \item \joption{datakeys=<keyorder>}: Specify order of items in CSV data file (see sec.~\ref{sec:ext-data}).
\end{itemize}
@@ -888,13 +901,20 @@ and the extension must be omitted in the option, so
\end{quote}
loads the file \texttt{mystudents.csv}.
-The external csv file must follow the following structure:
+It is assumed that the external CSV file conforms to the following structure:
\begin{lstlisting}[language={},basicstyle={\small\ttfamily},frame=single]
Prename1, Surname1, StudentID1, Email1
Prename2, Surname2, StudentID2, Email2
...
\end{lstlisting}
+The order if items can be adjusted via the \joption{datakeys} package option.
+The four items, \texttt{pname} (prename), \texttt{sname} (surname), \texttt{mid} (student ID) and \texttt{email}, can be freely re-ordered by that option. Note however, that all four items must be used. Thus, to change the order to \emph{Surname, Prename, Email, StudentID}, use:
+\begin{quote}
+ \jcsmacro{usepackage[datafile=mystudents,\\
+ \hphantom{\textbackslash usepackage[}datakeys=\{sname,pname,email,mid\}]\{jsmembertable\}}
+\end{quote}
+Note, finally, that the CSV file should have the same encoding than the tex file.
\subsection{Generating a course member table}
@@ -1011,7 +1031,7 @@ macros (using \jfcsmacro{renewcommand*}), for instance like this:
\end{lstlisting}
Again, if you use \jslp, you can use the \jslp\
style files in order to store those redefinitions globally.
-See the \texttt{german-default.lps} style file for a model.\footnote{%
+See the \texttt{german-default.lps} and \texttt{english.lps} style files for a model.\footnote{%
Note that within styles, you must use \jfcsmacro{newcommand*} instead of
\jfcsmacro{renewcommand*}, since the styles are loaded before the \jsmt\ package.}
Of course, you need to load \jslp\ with the respective \joption{style} option then
@@ -1049,6 +1069,13 @@ the \jslp\ style files. Thanks, Dominik.
\section{Release History}
\begin{itemize}
+\item 2017/03/12 (v. 1.5):
+ \begin{itemize}
+ \item Add \joption{english} style file (proof of concept).
+ \item Add \joption{datakeys} option to \jsmt.
+ \item Add package option \joption{sestitlesep} and macro \jcsmacro{SessionTitleSep} that
+ allow for the definition of a global session title-subtitle separator.
+ \end{itemize}
\item 2016/10/19 (v. 1.4):
\begin{itemize}
\item Add instructor short forms for lecture and session.