handin (11apr18)

git-svn-id: svn://tug.org/texlive/trunk@47590 c570f23f-e606-0410-a88d-b1316a301751

6 files changed, 290 insertions, 75 deletions

diff --git a/Master/texmf-dist/doc/latex/handin/README.txt b/Master/texmf-dist/doc/latex/handin/README.txt
index f3ec0ee45ec..18f66e96245 100644
--- a/Master/texmf-dist/doc/latex/handin/README.txt
+++ b/Master/texmf-dist/doc/latex/handin/README.txt
@@ -17,7 +17,7 @@ https://github.com/Strauman/Handin-LaTeX-template/
 
 Licence:
 
-The LaTeX package handin - version v0.0.3 (2018/04/04) build 41
+The LaTeX package handin - version v0.1.0 (2018/04/10) build 47
 handin.sty
 -------------------------------------------------------------------------------------------
 Copyright (c) 2018 by Andreas Storvik Strauman
diff --git a/Master/texmf-dist/doc/latex/handin/example.pdf b/Master/texmf-dist/doc/latex/handin/example.pdf
index 1e60b785da0..94a8ccc766a 100644
--- a/Master/texmf-dist/doc/latex/handin/example.pdf
+++ b/Master/texmf-dist/doc/latex/handin/example.pdf
diff --git a/Master/texmf-dist/doc/latex/handin/handin-doc.pdf b/Master/texmf-dist/doc/latex/handin/handin-doc.pdf
index 6945e5a6824..6cb13c74ced 100644
--- a/Master/texmf-dist/doc/latex/handin/handin-doc.pdf
+++ b/Master/texmf-dist/doc/latex/handin/handin-doc.pdf
diff --git a/Master/texmf-dist/doc/latex/handin/handin-doc.tex b/Master/texmf-dist/doc/latex/handin/handin-doc.tex
index 557a5d290d0..0e6348c5152 100644
--- a/Master/texmf-dist/doc/latex/handin/handin-doc.tex
+++ b/Master/texmf-dist/doc/latex/handin/handin-doc.tex
@@ -1,5 +1,5 @@
-%% handin v0.0.3b41 - 2018/04/04
-%% The LaTeX package handin - version v0.0.3 (2018/04/04) build 41
+%% handin v0.1.0b47 - 2018/04/10
+%% The LaTeX package handin - version v0.1.0 (2018/04/10) build 47
 %% #PACKAGE.sty
 %% -------------------------------------------------------------------------------------------
 %% Copyright (c) 2018 by Andreas Storvik Strauman
@@ -24,7 +24,7 @@
   moretexcs={arrayrulecolor,draw,includegraphics,ifthenelse,isodd,lipsum,path,pgfkeysalso},
   classoffset=1,
   moretexcs={% core
-    problem,pproblem,title,author,logo,coursename,coursetitle,institute,containspages,pagetext,settable
+    problem,pproblem,title,author,logo,coursename,coursetitle,institute,containspages,pagetext,settable,handinsetup,currentProblem,currentPartProblem,currentProblemIfNewPage
   },
   texcsstyle=*\color{Definition}\bfseries,
   classoffset=0,% restore default
@@ -43,6 +43,7 @@
     drop fuzzy shadow,#1}
   \makeatother
 \let\dac\docAuxCommand
+\long\def\keyDef#1#2#3#4{\begin{docKey}{#1}{=\meta{#2}}{\meta{default}=#3}#4\end{docKey}}
 \tcbset{documentation listing style=mydocumentation}
 % Magenta HREF style
 \let\oldhref\href
@@ -55,7 +56,7 @@
 
 
 \setlength{\parindent}{0pt}
-\title{{Handin - manual\\ v0.0.3{\\[-0.5em]\footnotesize(build 41)}}}
+\title{{handin - manual\\ v0.1.0{\\[-0.5em]\footnotesize(build 47)}}}
 \author{Andreas Strauman}
 \begin{document}
 \maketitle
@@ -66,15 +67,69 @@ This is a package that makes it easy for student to hand in a formatted document
 
 If you are a teacher, this package works just as well for creating exercises!\\
  
-If you found any bugs or want new functionality, to contribute, view the commented source, get latest version of this package or get in touch with me, you can do all of that at \url{https://github.com/Strauman/Handin-LaTeX-template/}
+If you found any bugs or want new functionality, to contribute, view the commented source, get latest version of this package or get in touch with me, you can do all of that at \url{https://github.com/Strauman/Handin-LaTeX-template/}. If you have questions of functionality, kindly direct them to the community\\ \url{http://tex.stackexchange.com}. The author is active on this site regularly.
+
 \tableofcontents
 \clearpage
  \section{Reference}
+\subsection{Making exercises}
+Here are commands related to creating exercises
+\begin{docCommand}{problem}{\marg{text}}
+ This command will print out a problem header. For example \dac{problem}\{1\}
+ prints a nice big header \textbf{Problem 1} You can do a star (*) after \dac{problem} to
+ prevent it from showing in the table of contents
+\end{docCommand}
+\begin{docCommand}{problem*}{\marg{text}}
+ Does the same as \dac{problem}, but does not add the problem to the table of contents
+\end{docCommand}
+\begin{docCommand}{pproblem}{\marg{text}}
+ This command will print out a part problem header based on what problem you are on.
+ For example if you already have done \dac{problem}\{1\}, then \dac{pproblem}\{a\}
+ prints a nice big header \textbf{(1a)}. Note that the default behaviour is such that if you are on a
+ new page, then the part problems are shown with the exercise number in front of it. If not
+ it is omitted. If you want to change this behaviour, see \dac{keyRef}\{part problem header\}
+\end{docCommand}
+\begin{docCommand}{pproblem*}{\marg{text}}
+ Does the same as \dac{pproblem}, but does not add the part problem to the table of contents
+\end{docCommand}
+\subsection{Package options (\dac{handinsetup})}
+ You can do configurations on this package, and probably
+ even more to come in later versions!
+\begin{docCommand}{handinsetup}{\marg{[key/values]}}
+ Here is a list of the different keys and their meaning
+\end{docCommand}
+\keyDef{problem header}{macro}{\dac{@tr}\{Problem\}~\dac{currentProblem}}{
+This options contains the formatting of the problem header. Use \dac{currentProblem} to access the number of the current exercise, and \dac{@tr}\{Problem\} to access the translation of Problem.\\
+Defaults to \dac{@tr}\{Problem\}~\dac{currentProblem}
+}
+\keyDef{part problem header}{macro}{See below}{
+ This defaults to: \dac{currentProblemIfNewPage}\dac{currentPartProblem}).
+ See \refCom{currentProblemIfNewPage} and \refCom{currentPartProblem}
+}
+\keyDef{problem TOC}{macro}{\meta{contents of problem header}}{
+ This key decides what is written to the table of contents. It defaults to extract the content in \refKey{problem header}
+}
+\keyDef{part problem TOC}{macro}{\meta{contents of part problem header}}{
+ This key decides what is written to the table of contents. It defaults to \dac{currentPartProblem}
+ (which is what the user last sent to \dac{pproblem}).
+}
+\keyDef{logo width}{number}{0.4}{
+ Give as factor (between 0 and 1) of total text width.
+ This is a temporary fix for logo not being customisable, and is scheduled to be updated in a later version.
+}
+\keyDef{title style}{wholepage or small}{wholepage}{
+If "wholepage", \dac{maketitle} will produce a full front-page. If "small", \dac{maketitle} will produce a smaller title containing the course name, course title, title, and author.
+}
+ \subsubsection*{Example} If you don't want to have the exercise number ever in front of the letter, then you'd do
+\begin{dispListing}
+ \handinsetup{part problem header=\currentPartProblem}
+\end{dispListing}
 \subsection{Page formatting commands}
 This package redefines \dac{maketitle}.
 Here are some front-page commands. See layout.pdf for where they will appear.
 These commands all have to be executed in the preamble (that is after \dac{documentclass} and before \dac{begin}\{document\})\\
-The \dac{title} and \dac{author} commands are as per usual:
+The \dac{title} and \dac{author} commands are as per usual,
+but are made lasting (not cleared by \dac{maketitle}) with \dac{thetitle} and \dac{theauthor} for use in headers and footers
 \begin{docCommand}{title}{\marg{title}}
 \end{docCommand}
 \begin{docCommand}{author}{\marg{your name}}
@@ -113,22 +168,36 @@ The current language is set by the \texttt{iflang} package, so you can use e.g.
 \usepackage[german]{babel}
 \end{dispListing}
 \subsection{General reference}
-\begin{docCommand}{problem}{\marg{text}}
- This command will print out a problem header. For example \dac{problem}\{1\}
- prints a nice big header \textbf{Problem 1} You can do a star (*) after \dac{problem} to
- prevent it from showing in the table of contents
-\end{docCommand}
-\begin{docCommand}{problem}{}
- Does the same as \dac{problem}, but does not add the problem to the table of contents
+\begin{docCommand}{currentProblem}{}
+Contains the argument of the last call to \dac{problem}
+\begin{dispListing}
+\pproblem{hello}
+\pproblem{world}
+\currentPartProblem %<- contains world
+\end{dispListing}
 \end{docCommand}
-\begin{docCommand}{pproblem}{\marg{text}}
- This command will print out a part problem header based on what problem you are on.
- For example if you already have done \dac{problem}\{1\}, then \dac{pproblem}\{a\}
- prints a nice big header \textbf{(1a)}. You can do a star (*) after \dac{pproblem} to
- prevent it from showing in the table of contents
+\begin{docCommand}{currentPartProblem}{}
+ Just as \refCom{currentProblem}, but contains the argument of the last call to \dac{pproblem}
 \end{docCommand}
-\begin{docCommand}{pproblem}{}
- Does the same as \dac{pproblem}, but does not add the part problem to the table of contents
+\begin{docCommand}{currentProblemIfNewPage}{}
+If the problem is not defined on the current page, then
+The first time \dac{currentProblemIfNewPage} is called on a page,
+it expands to the current problem number. If not, it expands to empty.
+If the problem is defined on the current page, it also expands to empty.
+ This is used in the default key for the \dac{keyRef}\{part problem header\}.
+ Here are some examples
+\begin{dispListing}
+\problem{1}
+\currentProblemIfNewPage % <- empty
+\end{dispListing}
+
+
+\begin{dispListing}
+\problem{4}
+\clearpage
+\currentProblemIfNewPage % <- expands to 4
+\currentProblemIfNewPage % <- expands to empty
+\end{dispListing}
 \end{docCommand}
 \begin{docCommand}{settable}{\marg{text}}
 \begin{dispListing}
@@ -157,5 +226,20 @@ The current language is set by the \texttt{iflang} package, so you can use e.g.
   v0.0.3b41&2018/04/04&\begin{itemize}
     \item German language added by africola \newline (\url{https://github.com/africola})
   \end{itemize}\\
+  v0.0.4&2018/04/06&\begin{itemize}
+    \item Made proper margins for problem headers and part problem headers
+    \item Added \texttt{microtype} and Latin Modern font (\texttt{cfr-lm})\newline
+    Contributed by:\newline
+    \href{https://github.com/koppor}{koppor} (\url{https://github.com/koppor})
+  \end{itemize}\\
+  v0.1.0&2018/04/10&\begin{itemize}
+    \item Introduced package options
+    \item New slick, minimalistic, front page by \href{https://github.com/DanielTrosten/}{DanielTrosten}
+    \item Added support for \dac{thetitle} and \dac{theauthor} by \href{https://github.com/MadsAdrian/}{MadsAdrian}
+    \item Footer bar by default by \href{https://github.com/MadsAdrian/}{MadsAdrian}
+    \item New part problem counting features
+    \item Misc fixes of margin bugs
+    \item Better file structuring on page style by \href{https://github.com/MadsAdrian/}{MadsAdrian}
+  \end{itemize}\\
 \end{tabularx}
  \end{document}
diff --git a/Master/texmf-dist/doc/latex/handin/layout.pdf b/Master/texmf-dist/doc/latex/handin/layout.pdf
index 2231225d5a8..dfa20382e25 100644
--- a/Master/texmf-dist/doc/latex/handin/layout.pdf
+++ b/Master/texmf-dist/doc/latex/handin/layout.pdf
diff --git a/Master/texmf-dist/tex/latex/handin/handin.sty b/Master/texmf-dist/tex/latex/handin/handin.sty
index 61edfdf8625..0fca58285bd 100644
--- a/Master/texmf-dist/tex/latex/handin/handin.sty
+++ b/Master/texmf-dist/tex/latex/handin/handin.sty
@@ -1,5 +1,5 @@
-%% handin v0.0.3b41 - 2018/04/04
-%% The LaTeX package handin - version v0.0.3 (2018/04/04) build 41
+%% handin v0.1.0 - 2018/04/10
+%% The LaTeX package handin - version v0.1.0 (2018/04/10) build 47
 %% handin.sty
 %% -------------------------------------------------------------------------------------------
 %% Copyright (c) 2018 by Andreas Storvik Strauman
@@ -13,27 +13,94 @@
 %% version 2008/05/04 or later.
 %% This work has the LPPL maintenance status `author-maintained'.
 %% This work consists of all files listed in README.txt
-\ProvidesPackage{handin}[2018/04/04 v0.0.3 Creates a setup that is ideal for handing in hard-science school papers that are divided in exercises.]
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{handin}[2018/04/10 v0.1.0 Creates a setup that is ideal for handing in hard-science school papers that are divided in exercises.]
+\newlength{\extramargins}
+\setlength{\extramargins}{4em}
+\PackageWarningNoLine{handin-v0.1.0}{This package is in the alpha stage, and if something unexpected happens please, oh pretty please, report it to https://github.com/Strauman/Handin-LaTeX-template. Thank you!}
 \usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
 \usepackage{graphicx}
 \usepackage{lastpage}
 \usepackage{scrextend}
-\def\exerciseNr{0}
-\gdef\problem{\@ifnextchar*{\expandafter\@problem\@secondoftwo}{\@problemTOC}}
-\gdef\@problemTOC#1{  \addcontentsline{toc}{section}{\@tr{Problem} #1}
-  \@problem{#1}
+\newcommand{\epage@everypage@hook}{}
+\newcommand{\epage@thispage@hook}{}
+\newcommand*{\AddEverypageHook}[1]{%
+  \g@addto@macro\epage@everypage@hook{#1}}
+\newcommand*{\AddThispageHook}[1]{%
+  \g@addto@macro\epage@thispage@hook{#1}}
+\newcommand*{\epage@ep@init}{%
+  \let\epage@op@saved\@outputpage
+  \def\@outputpage{%
+    \epage@op@preamble
+    \epage@op@saved
+    \epage@op@postamble}}
+\newcommand*{\epage@op@preamble}{%
+  \let\epage@begindvi\@begindvi
+  \def\@begindvi{%
+    \epage@everypage@hook
+    \epage@thispage@hook
+    \gdef\epage@thispage@hook{}
+    \epage@begindvi}}
+\newcommand*{\epage@op@postamble}{%
+  \let\@begindvi\epage@begindvi}
+\AtBeginDocument{\epage@ep@init}
+\newlength{\partproblemheadermargin}
+\newlength{\problemheadermargin}
+\newlength{\probleminset}
+\setlength{\problemheadermargin}{0em}
+\setlength{\probleminset}{3em}
+\setlength{\partproblemheadermargin}{2em}
+\def\fullproblemmargin{\dimexpr -\extramargins/2+\problemheadermargin\relax}
+\def\fullpartproblemmargin{\dimexpr\partproblemheadermargin\relax}
+\newcommand{\@atMargin}[2]{\strut\vadjust{\@domark{#1}{#2}}}
+\newcommand{\@domark}[2]{%
+  \hbox to #2{    \vbox to 0pt{      \kern-\dp\strutbox
+      \smash{\llap{#1}}
+      \vss
+}%
 }
-\newcommand{\@problem}[1]{  \def\exerciseNr{#1}
-  \begin{addmargin}{-1.5em}
-    {\normalfont\Large\bfseries \@tr{Problem} #1}
-  \end{addmargin}
 }
-\gdef\pproblem{\@ifnextchar*{\expandafter\@pproblem\@secondoftwo}{\@pproblemTOC}}
-\gdef\@pproblemTOC#1{  \addcontentsline{toc}{subsection}{\exerciseNr #1}
-  \@pproblem{#1}
+\gdef\isFirstProblem{1}
+\def\AtFirstProblem{\begin{addmargin}{\probleminset}
+\preto\@enddocumenthook{\end{addmargin}}
 }
-\newcommand{\@pproblem}[1]{  \vspace*{1em}
-  \hspace*{-0.5em}{\normalfont\Large\bfseries\exerciseNr #1)}
+\gdef\currentProblem{0}
+\gdef\currentPartProblem{0}
+\def\exerciseNr{\currentProblem}
+\global\let\@ProblemOnThisPage\@isTrue%
+\AddEverypageHook{%
+\global\let\@ProblemOnThisPage\@isFalse%
+}
+\gdef\currentProblemIfNewPage{\if\@ProblemOnThisPage\@isFalse%
+\global\let\@ProblemOnThisPage\@isTrue%
+\currentProblem\fi}%
+\gdef\problem{\@ifstar{\@problem}{\@problemTOC}}
+\gdef\@problemTOC#1{%
+  \gdef\currentProblem{#1}%
+  \addcontentsline{toc}{section}{\handin@opt@problemheaderTOC}%
+  \@problem{#1}%
+}
+\def\@problem#1{%
+\global\let\@ProblemOnThisPage\@isTrue
+\def\isTrue{1}%
+\if\isFirstProblem\isTrue%
+\AtFirstProblem%
+\gdef\isFirstProblem{0}%
+\fi%
+  \gdef\currentProblem{#1}%
+  \vbox to 0pt{%
+    \hspace*{\fullproblemmargin}{\normalfont\Large\bfseries\handin@opt@problemheader}%
+}\vspace*{1.5\baselineskip}%
+}
+\gdef\pproblem{\@ifstar{\@pproblem}{\@pproblemTOC}}
+\gdef\@pproblemTOC#1{%
+  \gdef\currentPartProblem{#1}
+  \addcontentsline{toc}{subsection}{\handin@opt@partproblemheaderTOC}%
+  \@pproblem{\currentPartProblem}%
+}
+\def\@pproblem#1{%
+\@atMargin{{\normalfont\Large\bfseries\handin@opt@partproblemheader}}{\fullpartproblemmargin}\ignorespaces%
 }
  \usepackage{fancyhdr}
 \usepackage{geometry}
@@ -42,6 +109,50 @@
 \usepackage{bm}
 \usepackage{esint}
 \usepackage{iflang}
+\usepackage{etoolbox}
+\usepackage{pgfkeys}
+\usepackage[
+  babel=true, %
+  expansion=alltext,
+  protrusion=alltext-nott, %
+  final %
+]{microtype}
+\usepackage[%
+    rm={oldstyle=false,proportional=true},%
+    sf={oldstyle=false,proportional=true},%
+    tt={oldstyle=false,proportional=true,variable=true},%
+    qt=false%
+]{cfr-lm}
+\edef\@isTrue{1}
+\edef\@isFalse{0}
+\pgfkeys{/handinsetup/.is family, /handinsetup,
+default/.style = {problem header={\@tr{Problem}~\currentProblem},
+part problem header={\currentProblemIfNewPage\currentPartProblem)},
+problem TOC={\handin@opt@problemheader},
+part problem TOC={\currentPartProblem},
+logo width={0.4},
+title style=wholepage,
+},
+problem header/.store in = \handin@opt@problemheader,
+part problem header/.store in = \handin@opt@partproblemheader,
+problem TOC/.store in = \handin@opt@problemheaderTOC,
+part problem TOC/.store in = \handin@opt@partproblemheaderTOC,
+logo width/.estore in = \handin@opt@logowidth,
+title style/.style = {titles/#1/.get = \handin@opt@titlestyle},
+titles/.cd,
+  wholepage/.initial = \handin@title@wholepage,
+  small/.initial = \handin@title@small,
+switches/.cd,
+  On/.initial = \@isTrue,
+  on/.initial = \@isTrue,
+  T/.initial =  \@isTrue
+  Off/.initial = \@isFalse,
+  off/.initial = \@isFalse,
+  F/.initial = \@isFalse,
+}
+\newcommand\handinsetup[1]{  \pgfkeys{/handinsetup, #1}%
+}
+\handinsetup{default}
 \def\@tr#1{  \ifcsname tr@#1\endcsname%
     \csname tr@#1\endcsname%
   \else%
@@ -101,52 +212,72 @@
 }
 \fi
 \settable{title}
+\let\@tmp@title\title
+\gdef\title#1{    \@tmp@title{#1}
+    \gdef\thetitle{#1}
+}
 \settable{author}
+\let\@tmp@author\author
+\gdef\author#1{    \@tmp@author{#1}
+    \gdef\theauthor{#1}
+}
 \settable{logo}
 \settable{coursename}
 \settable{coursetitle}
 \settable{institute}
-\settable{containspages}
-\settable{pagetext}
-\setlength\parindent{0pt}
-\geometry{paper=a4paper, bottom=3cm, top=3cm, footnotesep=3cm}
-\fancyhf{}
-\addtolength\headwidth{4em}
-\fancyheadoffset{2em}
-\pagestyle{fancy}
+\settable[\@tr{containspages}]{containspages}
+\settable[\@tr{pagetext}]{pagetext}
 \let\old@maketitle = \maketitle
-\def\maketitle{	\old@maketitle
+\gdef\@maketitle{\handin@opt@titlestyle}
+\gdef\handin@title@wholepage{%
 	\thispagestyle{empty}
-	\clearpage
+	\begin{center}
+		\ifshowoff
+			\Huge{\textbackslash logo}\\
+			\Large{\@title} \\[1.5cm]
+		\else
+		\ifset@logo{			\includegraphics[width=\handin@opt@logowidth\textwidth]{\@logo}\\[0.5cm]
+			\Large{\@title} \\[1.5cm]
+}{			\ea\@latex@warning{Use \noexpand\logo{path/to/image} to set a logo on the front page}
+			\Huge{\@title} \\[1.0cm]
 }
-\def\@maketitle{%
-\begin{center}
-  \ifshowoff
-    \Huge{\textbackslash logo}\\
-    \Large{\@title} \\[1.5cm]
-  \else
-  \ifset@logo{    \includegraphics[scale=1]{\@logo}\\[0.5cm]
-    \Large{\@title} \\[1.5cm]
-}{    \ea\@latex@warning{Use \noexpand\logo{path/to/image} to set a logo on the front page}
-    \Huge{\@title} \\[1.0cm]
+		\fi
+	\end{center}
+	\begin{center}
+		\textbf{\@coursename~--~\@coursetitle}\\[1cm]
+		\textbf{\@author} \\[1cm]
+		\textbf{\today} \\[3cm]
+	\end{center}
+	\begin{center}
+		\vfill
+		\@containspages\\[0.5cm]
+		\textsc{\@institute}
+	\end{center}
+	\clearpage
 }
-  \fi
-\end{center}
-\begin{center}
-  \textbf{\@coursename - \@coursetitle}\\[1cm]
-  \textbf{\@author} \\[1cm]
-  \textbf{\today} \\[3cm]
-\end{center}
-\begin{center}
-  \vfill
-  \ifset@containspages{    \@containspages
-}{    \@tr{containspages}
-}\\[0.5cm]
-  \textsc{\@institute}
-\end{center}
- 	\rhead{\@author}
-	\lhead{\@coursename - \@coursetitle}
-	\ifset@pagetext{		\rfoot{\@pagetext}
-}{		\rfoot{\@tr{pagetext}}
+\gdef\handin@title@small{%
+	\begin{center}
+		\ifshowoff
+			\Huge{\textbackslash logo}\\[0.5cm]
+		\else
+		\ifset@logo{			\includegraphics[width=\handin@opt@logowidth\textwidth]{\@logo} \\[0.5cm]
+}{			\ea\@latex@warning{Use \noexpand\logo{path/to/image} to set a logo on the front page}
 }
+		\fi
+		{\huge{\textbf{\@coursename~--~\@coursetitle \\[0.3cm] \@title}}}\\[0.3cm]
+		{\large \@author}
+	\end{center}
 }
+\geometry{paper=a4paper, bottom=3cm, top=3cm, footnotesep=3cm}
+\pagestyle{fancy}
+\setlength\parindent{0pt}
+\addtolength\headwidth{\extramargins}
+\fancyheadoffset{\dimexpr\extramargins/2\relax}
+    \renewcommand{\headrulewidth}{.3pt} %
+    \lhead{\@coursename~--~\thetitle}
+    \cfoot{}
+    \rhead{\today}
+    \renewcommand{\footrulewidth}{.3pt} %
+    \lfoot{\theauthor}
+    \cfoot{}
+    \rfoot{\@pagetext}