summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-10-25 21:34:13 +0000
committerKarl Berry <karl@freefriends.org>2018-10-25 21:34:13 +0000
commit4f28912f38990fab7aac77cdaba57f15b9d4bd0b (patch)
tree62e74a2663cdf348edf60d38944534b6e17fc066 /Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex
parent9d1eb542f4a942d64b1d26d0887de84a56abde39 (diff)
brandeis-problemset (25oct18)
git-svn-id: svn://tug.org/texlive/trunk@48989 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex')
-rw-r--r--Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex58
1 files changed, 51 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex b/Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex
index 0bf25e08b0e..9a823c3cf3b 100644
--- a/Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex
+++ b/Master/texmf-dist/doc/latex/brandeis-problemset/brandeis-problemset.tex
@@ -2,7 +2,7 @@
\usepackage{brandeis-problemset-doc}
\author{Rebecca Turner\thanks{Brandeis University; \email{rebeccaturner@brandeis.edu}}}
\title{The \bps\ Document Class}
-\date{2018-10-19}
+\date{2018-10-24}
\begin{document}
\maketitle
@@ -22,7 +22,7 @@
\note{The \bps\ document class should be considered experimental; the only
stable \textsc{api} is that of the \env{problem} environment.}
-\note{Browse the sources, contribute, or complain at
+\note{Browse the sources, contribute, or complain at \\
\https{github.com/9999years/brandeis-problemset}}
\tableofcontents
@@ -195,6 +195,11 @@ number & A problem number; if given, the problem-number counter
will not advance. The number must be robust, because it goes inside
a \cs{section}. \\
pagebreak & True/false (default: true). Add a pagebreak before the problem? \\
+label & Adds a custom label to the problem with \cs{label} that can be used
+ with \cs{ref} \\
+part & Indicates that this problem starts a new ``part'' of the assignment
+ \\
+partlabel & Adds a custom label to this part; see \option{label} \\
\end{Optionlist}
Vertical material is allowed in a~\env{problem}.
@@ -305,6 +310,9 @@ An environment for drawing Gantt charts indicating process scheduling. The
mandatory argument indicates how small the grid should be; \texttt{19}
subdivides the line into 19 cells.
+To use the \env{ganttschedule} environment, make sure to use the
+\option{gantt} package option.
+
Within a \env{ganttschedule}, use the \cs{burst} command to indicate an
active process (i.e.\ a process burst).
@@ -314,11 +322,25 @@ Draw a burst for process \marg{pid} of time length \meta{burst length}.
\note{These aren't really Gantt charts, but that's what Dr.\ Shrira calls
them, so that's what they're called here.}
-\note{Because \env{ganttschedule} relies on \ctan{tikz}, \ctan{fp}, and
- \ctan{calc}, it can add significantly to document compile times.
- If you intend to use the \env{ganttschedule}
- environment, make sure to use the \option{gantt} class option or set
- \option{gantt} in \cs{problemsetsetup}.}
+\cprotect\note{Because \env{ganttschedule} relies on \ctan{tikz}, \ctan{fp},
+ and \ctan{calc}, it can add significantly to document compile times. If
+ you intend to use the \env{ganttschedule} environment, make sure to use
+ the \option{gantt} class option or set \option{gantt} in
+ \cs{problemsetsetup}. If you fail to include the \option{gantt} option,
+ you will see an error message:
+
+\begin{latexcode}
+! Package brandeis-problemset Error: ganttschedule enviornment not loaded in preamble.
+
+See the brandeis-problemset package documentation for explanation.
+Type H <return> for immediate help.
+l.4 \burst
+ {1}{1}
+? H
+Did you mean to use the 'gantt' option for the brandeis-problemset document class?
+
+\end{latexcode}
+}
\begin{latexcode}
\begin{ganttschedule}{19}
@@ -432,4 +454,26 @@ $\Rm{Foo}(a, n)$ computes $a^n$, and will run in $O(n)$ time always.
\end{document}
\end{latexcode}
+\pagebreak
+\begin{changelog}
+\begin{version}{v=0.3.0, date=2018-10-24, author=Rebecca Turner}
+ \added changelog.
+ \added support for \cs{part}s and referencing problems.
+ \added options to \env{problem} environment: \option{part},
+ \option{label}, and \option{partlabel}.
+ \added \cs{maketitle} (contrast with \cs{maketitlepage}).
+\end{version}
+\begin{version}{v=0.2.0, date=2018-10-20, author=Rebecca Turner}
+ \item Renamed to \bps.
+ \added license header.
+ \added \env{ganttschedule} environment.
+ \added keywords to pseudocode environment: \texttt{and}, \texttt{or},
+ \texttt{nil}, and \texttt{len}.
+ \added \cs{ac} command for acronyms.
+ \added package example.
+\end{version}
+\shortversion{v=0.1.0, date=2018-10-19, author=Rebecca Turner,
+ changes=Initial beta as \ltxclass{problemset}.}
+\end{changelog}
+
\end{document}