From 878945fe271424eec2cf3100676b770dc654e266 Mon Sep 17 00:00:00 2001
From: Frank Fuhlbrück
Date: Wed, 6 Oct 2021 13:00:20 +0200
Subject: update documentation to match progress of last year

---
 exercisesheets.tex | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

(limited to 'exercisesheets.tex')

diff --git a/exercisesheets.tex b/exercisesheets.tex
index 9c1d67c..887e5b4 100644
--- a/exercisesheets.tex
+++ b/exercisesheets.tex
@@ -53,7 +53,7 @@
 \usepackage[english,iso]{isodate}
 \title{The \exsh Package}
 \author{Sebastian Kuhnert\and Frank Fuhlbrück}
-\date{Version 0.7, \printdateTeX{2020/10/15}}
+\date{Version 0.8, \printdateTeX{2021/10/06}}
 
 \begin{document}
 \maketitle
@@ -61,12 +61,12 @@
 The \exsh package provides a way to typeset exercise sheets as used in
 university courses. It evolved from a set of macros an environments that were
 finally combined into this package. Starting from Version 0.7, there
-is an alternative variant designed for use eith the beamer package.
+is an alternative variant designed for use with the beamer class.
 This variant is called exercisesheets-beamer. Not all combinations of options have been testet with the beamer variant.
 
 
 \subsection*{Licence}
-Copyright \textcopyright{} 2008--2020 Sebastian Kuhnert and Frank Fuhlbrück.
+Copyright \textcopyright{} 2008--2021 Sebastian Kuhnert and Frank Fuhlbrück.
 Permission is granted to copy, distribute and/or modify this software under the
 terms of the \LaTeX{} Project Public Licence, version 1.3c or later. This
 package is maintained, the Current Maintainer is Sebastian
@@ -176,6 +176,10 @@ The following options are available:
   If this option is used, the points label for a Sub-Exercise is placed at the (right) end of the current line.
   It is especially useful if used in a context like \texttt{$\backslash$item$\backslash$points$\{3\}$}.
   This option exploits (and partially breaks) RTL-Support. 
+ \item[\option{exercisespath}] Set the (relative) path of the 
+  directory containing exercises to be included via 
+  \verb|\includeexercise|.
+
 \end{description}
 
 \subsection{Supplying Meta-Data}
@@ -243,6 +247,7 @@ The following \param{options} are supported:
   head. By default, the value passed to \verb|\subject| is used.
  \item[\option{semester=\param{semester}}] Set the semester included in the
   sheet head. By default, the value passed to \verb|\date| is used.
+ \item[\option{beamerwithheadline\opt{=\param{true/false}}}] Controls wether a headline with author, subject etc. is shown on beamer slides.
 \end{description}
 
 
@@ -294,6 +299,12 @@ supported:
  \item[\option{beamersolution}] For \exsh-beamer only. If this option
  is set all normal solutions will not be included and only 
  \option{beamersolution}s are typeset.
+ \item[\option{framed}] For \exsh-beamer only. If this option
+ is set for a normal solution, its content will be put on one or more
+ frames. Use \verb|\newframe| to start a new frame. This option is 
+ especially helpful if you provide your own definitions of
+ \verb|\only| etc. for non-beamer compilation. \verb|\newframe| is 
+ already defined as \verb|\relax| in  non-beamer \exsh.
 \end{description}
 
 Solutions are only typeset, if the \option{solutions} option is in effect. There
@@ -304,6 +315,21 @@ environment.
 
 \section{Utilities}
 
+\subsection{Loading Excercises From Files}
+\begin{lstlisting}
+\includeexercise(*\param{file name}*)
+\includeexercise*(*\param{file name}*)
+\end{lstlisting}
+
+Both load the exercise from exercisespath/\param{file name}. Note 
+that the exercise environment must be contained in the file. The 
+starred version is helpful for faster skipping of unused exercises.
+In this case, the file is not opened to search for labels. Whenever
+the exercise is not skipped and you use the starred version and also
+use labels within the exercise file, \exsh outputs an error. This is 
+done to ensure that references are not overlooked when the exercise 
+is actually skipped later.
+
 \subsection{Including Hints}
 
 \begin{lstlisting}
@@ -592,6 +618,9 @@ If you leave out the \option{solutions} option in you main file, running
 \texttt{pdflatex exercises.tex} will create \texttt{exercises.pdf} without
 solutions and \texttt{pdflatex solutions.tex} will create \texttt{solutions.pdf}
 with solutions.
+
+This also works well in combination with a make file that generates 
+\texttt{solutions.tex}.
 \end{document}
 
 %%% Local Variables: 
-- 
cgit v1.2.3

