diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/uassign/uassign.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/uassign/uassign.tex | 190 |
1 files changed, 131 insertions, 59 deletions
diff --git a/Master/texmf-dist/doc/latex/uassign/uassign.tex b/Master/texmf-dist/doc/latex/uassign/uassign.tex index 20ef3bdfb83..0b8c40c2342 100644 --- a/Master/texmf-dist/doc/latex/uassign/uassign.tex +++ b/Master/texmf-dist/doc/latex/uassign/uassign.tex @@ -1,9 +1,9 @@ -\documentclass[12pt]{article} +\documentclass[twocolumn,twoside,11pt]{report} -\usepackage{uassign} +\usepackage[nobox]{assign} \usepackage{hyperref} \usepackage[margin=1.0in]{geometry} -%\usepackage{bookmark} +\def\arraystretch{1.2} \hypersetup{ colorlinks, @@ -20,95 +20,167 @@ \begin{document} \maketitle -\tableofcontents -\section{Overview} +\setcounter{secnumdepth}{-1} +\chapter{Overview} -The purpose of the \texttt{uassign} is to provide a simple question and solution environment for typesetting university assignments. Although there exist \LaTeX \ classes, such as the \texttt{exam} class, and packages, such as the \texttt{exercise} package, which could be used for this purpose, the \texttt{uassign} package was designed with the following objectives in mind: +\section{Description} +The purpose of the \texttt{uassign} package is to provide simple question and solution style environments for typesetting university assignments. The \texttt{uassign} package was designed with the following objectives in mind: \begin{itemize} -\item \textit{Simplicity}: Two environments -- one for questions and one for solutions -\item \textit{Hide environments}: Ability to produce a question sheet (questions only, i.e. an assignment) and a solution sheet (solutions only, i.e. an answer key) or both. This is done by passing a \texttt{hidequestions} or \texttt{hideanswers} option to the package -\item \textit{Minimal dependencies}: Only the \textit{ifelse} package is needed. All environments, i.e. \texttt{tabular}, \texttt{figure}, etc. can be used within the question and solution environments. +\item \textit{Simplicity}: \texttt{uassign} package is small and easy to modify +\item \textit{Hide environments}: Ability to produce a question sheet (questions only) and a solution sheet (solutions only) or both. This is done by passing the \texttt{hidequestions} or \texttt{hideanswers} option to the package. +\item \textit{Flexibility}: The \texttt{uassign} package doesn't create conflicts with other packages, such as \texttt{hyperref} when included. Commands which could cause conflicts with other packages are used only when certain options are passed to the \texttt{uassign} package. -By default used within the \texttt{question} and \texttt{solution} environment. \end{itemize}% see http://tex.stackexchange.com/questions/242036/multiline-code-listings-in-cweb -\def\beginlisting{% - \par\vskip\baselineskip% - \begingroup% - \tt\obeylines\obeyspaces% - \catcode`\{12\catcode`\}12% -} -\def\endlisting{% - \endgroup\par% - \vskip\baselineskip% -} - -The \texttt{question} and \texttt{solution} environments provide the following features: - -\begin{itemize} -\item Automatic question numbering. The question counter is called \texttt{questioncounter} and its value can be accessed using \verb|\thequestioncounter|. Likewise, the solution counter is called \texttt{solutioncounter} and its value can be accessed using \verb|\thesolutioncounter|. To set the value of the question counter use \verb|\setcounter{questioncounter}{5}| and the next question would be question \texttt{6.} -\item Indenting. The question numbers are right aligned in the left margin, and the entire question or solution is indented using a \verb|\list|. -\end{itemize} - -\section{Environments} -\subsection{\texttt{question} environment} - -Simply use \verb|\begin{question} ... code ... \end{question}|. For example: +\section{Features} + +\subsection{Environments} + +\begin{table}[!htpb] +\centering +\begin{tabular}{l l l} +\hline +Environment & Description \\ \hline +\texttt{question} & Assignment questions \\ +\texttt{solution} & Assignment solutions \\ +\texttt{example} & Illustrative examples \\ +\texttt{exsolution} & Solution to examples \\ +\texttt{definition} & Definitions for terms \\ \hline +\end{tabular} +\caption{Environments provided by \texttt{uassign}} +\end{table} + +\vspace{10mm} +\subsection{Commands} + +\begin{table}[!htpb] +\centering +\begin{tabular}{l l l} +\hline +Command & Description \\ \hline +\verb|\ientry| & Bold-faced index entry \\ \hline +%\verb|\ebox| & Square box to end solution \\ \hline +\end{tabular} +\caption{Commands provided by \texttt{uassign}} +\end{table} + +\subsection{Options} + +\begin{table}[!htpb] +\centering +\begin{tabular}{l l} +\hline +Option & Description \\ \hline +\verb|hidequestions| & Hide \texttt{question} \\ +\verb|hideanswers| & Hide \texttt{solution} \\ +\verb|assignheader| & \texttt{fancyhdr} \\ +\verb|notesheader| & \texttt{titlesec}, \texttt{fancyhdr} \\ +\verb|links| & \texttt{hypersetup} format \\ \hline +\end{tabular} +\caption{Options provided by \texttt{uassign}} +\end{table} + +\subsection{Packages used} + +\begin{table}[!htpb] +\centering +\begin{tabular}{l l} +\hline +Package(s) & Usage \\ \hline +\texttt{ifthen} & Processing options \\ +\texttt{hyperref} & Hyperlinks in pdf \\ +\texttt{bookmark} & pdf bookmarks \\ +\texttt{color} & Color links \\ +\texttt{enumerate} & Options for \texttt{enumerate} \\ +\texttt{amsmath, amsthm} & Math typesetting \\ +\texttt{fancyhdr} & Format top of page header \\ +\texttt{titlesec} & Format section, chapter \\ \hline +\end{tabular} +\caption{Packages used by \texttt{uassign}} +\end{table} + +\section{Demonstration} + +\subsection{question environment} \begin{verbatim} \begin{question} -What is the answer to life and all its questions? +What is the answer to life? \end{question} \end{verbatim} -\noindent Which produces the following output: - +\hrule \begin{question} -What is the answer to life and all its questions? +What is the answer to life? \end{question} -\bigskip -\noindent Notice that the question is automatically numbered. +\vspace{3mm} +\hrule -\subsection{\texttt{solution} environment} - -Simply use \verb|\begin{solution} ... code ... \end{solution}|. For example: +\subsection{solution environment} \begin{verbatim} -\setcounter{questioncounter}{3} -\setcounter{solutioncounter}{3} - -\begin{question} -What is the answer to life and all it's questions? -\end{question} +\begin{solution} +The answer is 42. +\end{solution} +\end{verbatim} +\hrule \begin{solution} The answer is 42. \end{solution} + +\vspace{3mm} +\hrule + +\subsection{example environment} + +\begin{verbatim} +\begin{example} +Explain what facebook is. +\end{example} \end{verbatim} -\noindent Which produces the following output: +\hrule +\begin{example} +Explain what facebook is. +\end{example} -\setcounter{questioncounter}{3} -\setcounter{solutioncounter}{3} +\vspace{3mm} +\hrule -\begin{question} -What is the answer to life and all it's questions? -\end{question} +\subsection{exsolution environment} +\begin{verbatim} \begin{solution} -The answer is 42. +Facebook is a social media site. \end{solution} +\end{verbatim} + +\hrule +\begin{exsolution} +Facebook is a social media site. +\end{exsolution} -\bigskip\noindent -A \texttt{medskip} of spacing is used before each question and solution environment. +\vspace{3mm} +\hrule -\section{Hiding environments} +\subsection{definition environment} + +\begin{verbatim} +\begin{definition} +The \ientry{mean} is the average value. +\end{definition} +\end{verbatim} -To hide solutions use the \texttt{hideanswers} option. When you load the package, the code would be \verb|\usepackage[hideanswers]{uassign}|. Likewise, questions can be hided using the \texttt{hidequestions} option. +\hrule +\begin{definition} +The \ientry{mean} is the average value. +\end{definition} -If questions are hide, then solutions are numbered. If questions are shown and solutions are shown, then solutions will have the word \textbf{Solution:} at the start of the solution. +\vspace{3mm} +\hrule \end{document} |