summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-04-01 22:20:15 +0000
committerKarl Berry <karl@freefriends.org>2018-04-01 22:20:15 +0000
commitf02c0d33eefe844fb67c5e438cfdcc26085c2223 (patch)
treef5d9e6c8bd755565b594be5520f4ad27a14a75ac /Master/texmf-dist/doc
parentdc1e5266cbb2963f2e07e08edbc99966baa582b4 (diff)
exercisebank (2apr18)
git-svn-id: svn://tug.org/texlive/trunk@47223 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/exercisebank/README.txt34
-rw-r--r--Master/texmf-dist/doc/latex/exercisebank/example.zipbin0 -> 1642 bytes
-rw-r--r--Master/texmf-dist/doc/latex/exercisebank/exercisebank.pdfbin0 -> 156236 bytes
-rw-r--r--Master/texmf-dist/doc/latex/exercisebank/exercisebank.tex170
4 files changed, 204 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/exercisebank/README.txt b/Master/texmf-dist/doc/latex/exercisebank/README.txt
new file mode 100644
index 00000000000..ac8a33ea27f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/exercisebank/README.txt
@@ -0,0 +1,34 @@
+Exercisebank:
+A tool for creating and managing exercise sets in maths, physics, statistics and the like.
+
+Files:
+- exercisebank.sty : The exercise bank
+- exercisebank.pdf : Description of how the package works
+- example.zip : containing example
+ |-- example.tex : example of use
+ |-- exercises/ : Directory containing exercises that could be use
+ |---| -- firstexercise.tex: example exercise
+ |---| -- secondexercise.tex: example exercise
+ |---| -- thirdexercise.tex: example exercise
+
+Author: Storvik Strauman, Andreas
+
+For bug report, inquires, contributed or anything else:
+https://github.com/Strauman/exerciseBank
+
+Licence:
+
+The LaTeX package exercisebank - version 0.0.2-1 (2018/04/01)
+exercisebank.sty: Exercise bank
+-------------------------------------------------------------------------------------------
+Copyright (c) 2018 by Andreas Storvik Strauman
+-------------------------------------------------------------------------------------------
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3c
+of this license or (at your option) any later version.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3c or later is part of all distributions of LaTeX
+version 2008/05/04 or later.
+This work has the LPPL maintenance status `author-maintained'.
+This work consists of all files listed in README
diff --git a/Master/texmf-dist/doc/latex/exercisebank/example.zip b/Master/texmf-dist/doc/latex/exercisebank/example.zip
new file mode 100644
index 00000000000..ddb4874ba10
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/exercisebank/example.zip
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/exercisebank/exercisebank.pdf b/Master/texmf-dist/doc/latex/exercisebank/exercisebank.pdf
new file mode 100644
index 00000000000..51e87200e5e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/exercisebank/exercisebank.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/exercisebank/exercisebank.tex b/Master/texmf-dist/doc/latex/exercisebank/exercisebank.tex
new file mode 100644
index 00000000000..cd25ef4c775
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/exercisebank/exercisebank.tex
@@ -0,0 +1,170 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% This is a generated file %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\documentclass{article}
+\usepackage[all]{tcolorbox}
+\input{styling}
+\input{preamble}
+\let\dac\docAuxCommand
+\tcbset{documentation listing style=mydocumentation}
+
+\setlength{\parindent}{0pt}
+\author{Andreas Strauman}
+\begin{document}
+\maketitle
+\tableofcontents
+\clearpage
+\input{intro}
+\section{Reference}
+\subsection{Environments}
+\begin{docEnvironment}[]{problem}{}
+ Inside the exercises folder, you keep your exercises. Inside there you'd use a problem environment to write your partproblems. It might be a little confusing that you're using \dac{begin}\{problem\} instead of \dac{begin}\{partproblem\} when you're writing a partproblem, but it's less typing.
+\begin{marker}\dac{end}\{problem\} has to be on it's own line without any leading spaces!\end{marker}
+
+\end{docEnvironment}
+
+\begin{docEnvironment}[]{solution}{}
+ Things inside here is only visible if \refCom{DisplaySolutions} are given before \dac{begin}\{document\}
+\begin{marker}\dac{end}\{solution\} has to be on it's own line without any leading spaces!\end{marker}
+
+\end{docEnvironment}
+
+\begin{docCommand}[]{DisplaySolutions}{}
+ Turns on the solutions, so they are shown.
+
+\end{docCommand}
+
+\begin{docEnvironment}[]{intro}{}
+ Sometimes you'd want to introcude your exercises and tell a little bit about it. Maybe have a figure there also. Those things should go inside this environment. This can be treated as a problem in terms of counting. See \refCom{makeset} for more info.
+\begin{marker}\dac{end}\{intro\} has to be on it's own line without any leading spaces!\end{marker}
+
+\end{docEnvironment}
+
+\subsection{Internationalization}
+\begin{docCommand}[]{translateExBank}{\marg{Translation key/vals}}
+ This is to translate the text inside the package. As of now the available key/values are
+\begin{itemize}
+\item Problem
+\item Solution
+\end{itemize}
+
+\end{docCommand}
+
+ The Norwegian translation would then be done with
+
+
+\begin{dispListing}
+ \translateExBank{Problem=Oppgave, Solution=Løsning}
+
+\end{dispListing}
+
+\subsection{Triggers}
+\begin{docCommand}[]{Trigger}{\marg{Any Macro}}
+ See \refCom{At}\\
+Available triggers:\\
+ \dac{At}\dac{InputExercise}\\ Triggers before a file is included\\
+\dac{At}\dac{BeginProblem}\\ Triggers before a file is included, but only if problem headers are to be written (no [nohead] given)\\
+\dac{At}\dac{EndProblem}\\ Triggers right after problem is included if [nohead] \emph{not} given\\
+\dac{At}\dac{BeginBuildset}\\ Triggers right before a set has begun building (not if \dac{sprite} is used). You might want to put your set-header here\\
+\dac{At}\dac{EndBuildset}\\ Triggers when a set has stopped building (not if \dac{sprite} is used)\\
+
+
+\end{docCommand}
+
+\subsection{General reference}
+\begin{docCommand}[]{ownLineNoSpacesGotIt}{}
+ This is to annoy the user enough to get his attention about the requirements of the \refEnv{problem}, \refEnv{solution} and \refEnv{intro} environments.\\
+ Compilation wont work unless \dac{end}\{problem\}, \dac{end}\{solution\} and \dac{end}\{intro\} are on their own lines and without any spaces. This warning can be removed by doing \dac{def}\dac{ownLineNoSpacesGotIt}{} before \dac{usepackage}\{exbank\}.
+
+\end{docCommand}
+
+\begin{docCommand}[]{setExercisesDir}{\marg{directory}}
+ This is the directory, relative to the file you included the package,
+ where the package should be looking for exercises. Default is \texttt{exercises}
+
+\end{docCommand}
+
+
+
+ This package also includes some extra stuff. For example the \dac{At} and \dac{Trigger}
+
+
+\begin{docCommand}[]{At}{\marg{AnyMacro}}
+Here you can send any macro because it isn't evaluated! For example \dac{At}\dac{BeginSomething} is fine and even if \dac{BeginSomething} is not defined. Also and when using \dac{Trigger} it just ignores it if it didn't exist. It's pretty similar in function as to \dac{AtBeginDocument}.
+
+\end{docCommand}
+
+\begin{dispListing}
+\At\BeginSomething{DoSomething}
+ Which is triggered with
+ \Trigger\BeginSomething, this evaluates to DoSomething
+
+\end{dispListing}
+
+\subsection{Making sets}
+\begin{docCommand}[]{makeset}{\oarg{intro,nohead}\marg{filable}}
+ This command is the one you use to make a set! Later you use \dac{buildset} to build the sets you make. The \meta{filable} argument is either the name of the file relative to the \dac{exerciseDir}-path (default its in the root called exercises), or you could use the \dac{select} or \dac{exclude} to respectively cherry pick or exclude exercises. (See their docs).\\
+ \oarg{intro} this counts the intro environment as a part problem, so that you can \dac{select} or \dac{exclude} the intro\\
+ \oarg{nohead} prevents the builder from adding a problem header. This is handy if you want to create an exercise that is composed of multiple parts. You can use the \dac{phead} to insert the problem header where you want it
+
+\end{docCommand}
+
+\begin{dispListing}
+ \makeset[nohead]\{\phead, \select{myexercise}{1,2,3}}
+
+\end{dispListing}
+
+\begin{docCommand}[]{exclude}{\marg{exerciseFileName}\marg{Comma separated numbers}}
+As you can see in the intro section of the documentation, this is for excluding partproblems
+To be used in \refCom{makeset}
+
+\end{docCommand}
+
+\begin{docCommand}[]{select}{\marg{exerciseFileName}\marg{Comma separated numbers}}
+As you can see in the intro section of the documentation, this is for cherry picking partproblems
+To be used in \refCom{makeset}
+
+\end{docCommand}
+
+
+
+\begin{docCommand}[]{about}{\marg{text}}
+ This contains information about an exercise set. It is intended to be on the top of an
+ exercise, explaining short what the exercise is about. It's only visible when using \dac{sprite}
+
+\end{docCommand}
+
+\begin{docCommand}[]{sprite}{\oarg{PiP}}
+ This is a way to visualize all exercises. It takes one optional argument which is how many pages
+ inside one page. Defaults to 4
+ \begin{marker}If \dac{sprite} is used, it should be the only command in \dac{begin}\{document\}\dac{end}\{document\}\end{marker}
+
+\end{docCommand}
+
+
+
+\begin{docCommand}[]{pplabel}{\marg{label}}
+ Labels a partproblem. You can reference to it later using \dac{ppref}\{\meta{label\}}
+
+\end{docCommand}
+
+\begin{docCommand}[]{ppref}{\marg{label}}
+ Reference a partproblem created by \dac{pplabel}\{\meta{label\}}. This prints e.g. 1c)
+
+\end{docCommand}
+
+\begin{docCommand}[]{ppref}{\marg{label}}
+ Reference a partproblem created by \dac{pplabel}\{\meta{label\}}. This prints e.g. 1
+
+\end{docCommand}
+
+\subsection{Counters}
+
+
+\docCounter{problemcounter}-counter holds the current problem number and
+\docCounter{partproblemcounter}-counter holds the current partproblem \emph{number}.
+
+
+
+\end{document}