More (mostly SE) updates

.gitignore

@@ -1,10 +1,16 @@
 *.swp
+*.DS_Store
 
 # Ignore generated files
+# Intentionally allow *.cls file for convenience
 uw-ece-workreport.cls
-uw-wkrpt.cls
+#uw-wkrpt.cls
 uw-wkrpt.drv
-uw-wkrpt.pdf
+uw-wkrpt*.pdf
+
+# Ignore biber files
+*.bcf
+*.run.xml
 
 # Taken from https://github.com/github/gitignore/blob/master/LaTeX.gitignore
 *.acn

Makefile

@@ -21,7 +21,6 @@ PACKAGE = uw-wkrpt
 
 # Use pdfLaTeX for best results
 LATEX = pdflatex
-LATEX2DVI = $(LATEX) --output-format=dvi
 LATEX2PDF = $(LATEX) --output-format=pdf
 
 # MakeIndex parameters
@@ -31,9 +30,9 @@ GGLO = gglo.ist
 
 # Bibliography
 BIBTEX = bibtex
+BIBER = biber
 
 # Texi2DVI knows most about compilation
-TEXI2DVI = LATEX="$(LATEX2DVI)" texi2dvi -l latex
 TEXI2PDF = PDFLATEX="$(LATEX2PDF)" texi2dvi -l latex -p
 
 # Installation
@@ -62,41 +61,33 @@ TEXFILES=\
          $(PACKAGE)*.log\
          $(PACKAGE)*.pdf\
          $(PACKAGE)*.sty\
-         $(PACKAGE)*.toc
+         $(PACKAGE)*.toc\
+         $(PACKAGE)*.bcf\
+         $(PACKAGE)*.out\
+         $(PACKAGE)*.run.xml
 
-.PHONY : all examples install uninstall dvi pdf examples-dvi examples-pdf clean
+.PHONY : all examples install uninstall pdf examples-pdf clean
 
-all : $(PACKAGE).cls $(PACKAGE).dvi $(PACKAGE).pdf ;
+all : $(PACKAGE).cls $(PACKAGE).pdf ;
 
-examples : examples-dvi examples-pdf ;
+examples : examples-pdf ;
 
 install : all examples
 	$(INSTALL) -d $(DESTDIR)/texmf/tex/$(TDSFORMAT)/$(PACKAGE)
 	$(INSTALL) -d $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)
 	$(INSTALL) -d $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/examples
 	$(INSTALL_DATA) $(PACKAGE).cls $(DESTDIR)/texmf/tex/$(TDSFORMAT)/$(PACKAGE)/
-	$(INSTALL_DATA) $(PACKAGE).dvi $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/
 	$(INSTALL_DATA) $(PACKAGE).pdf $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/
 	$(INSTALL_DATA) $(PACKAGE)-*.tex $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/examples
-	$(INSTALL_DATA) $(PACKAGE)-*.dvi $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/examples
 	$(INSTALL_DATA) $(PACKAGE)-*.pdf $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/examples
 
 uninstall :
 	$(RM) $(DESTDIR)/texmf/tex/$(TDSFORMAT)/$(PACKAGE)/$(PACKAGE).cls
-	$(RM) $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/$(PACKAGE).dvi
 	$(RM) $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/$(PACKAGE).pdf
 	$(RM) -r $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)/examples
 	-rmdir -p $(DESTDIR)/texmf/doc/$(TDSFORMAT)/$(PACKAGE)
 	-rmdir -p $(DESTDIR)/texmf/tex/$(TDSFORMAT)/$(PACKAGE)
 
-dvi : $(PACKAGE).dvi ;
-
-examples-dvi : $(PACKAGE).cls    \
-               $(PACKAGE)-cecs.dvi \
-	       $(PACKAGE)-ece.dvi  \
-	       $(PACKAGE)-math.dvi \
-	       $(PACKAGE)-se.dvi   ;
-
 pdf : $(PACKAGE).pdf ;
 
 examples-pdf : $(PACKAGE).cls    \
@@ -108,22 +99,15 @@ examples-pdf : $(PACKAGE).cls    \
 %.cls : %.ins %.dtx
 	$(LATEX) $<
 
-$(PACKAGE)-%.dvi : $(PACKAGE)-%.tex $(PACKAGE).cls don-hires.eps
-	$(TEXI2DVI) $<
-
-%.dvi : %.tex $(PACKAGE).cls
-	$(TEXI2DVI) $<
+# This is redundant, but the SE example needs biblatex to run
+$(PACKAGE)-se.pdf : $(PACKAGE)-se.tex $(PACKAGE).cls
+	$(TEXI2PDF) $<
+	$(BIBER) $(PACKAGE)-se
+	$(TEXI2PDF) $<
 
 %.pdf : %.tex $(PACKAGE).cls
 	$(TEXI2PDF) $<
 
-$(PACKAGE).dvi : $(PACKAGE).dtx $(PACKAGE).cls
-	$(TEXI2DVI) $<
-	$(MAKEINDEX) -s $(GIND) $(PACKAGE).idx
-	$(MAKEINDEX) -s $(GGLO) -o $(PACKAGE).gls $(PACKAGE).glo
-	$(LATEX2DVI) $<
-	$(LATEX2DVI) $<
-
 $(PACKAGE).pdf : $(PACKAGE).dtx $(PACKAGE).cls
 	$(TEXI2PDF) $<
 	$(MAKEINDEX) -s $(GIND) $(PACKAGE).idx

Makefile.example

@@ -14,9 +14,8 @@ all: report.tex report.bib latexmk.pl uw-wkrpt.cls
 
 clean:
 	perl latexmk.pl -c
-	rm -f report.bbl
+	rm -f report.bcf
 	rm -f report.run.xml
-	rm -f report-blx.bib
 
 clean-all: clean
 	rm -f report.pdf

README.md

@@ -21,7 +21,7 @@ really quite helpful. You can read any of the example work reports, as well as:
 You can also find more information on-line.  There is an [FAQ][3] and a
 [page listing documentation for beginners][4].
 
-[2]: http://people.ee.ethz.ch/~oetiker/lshort/
+[2]: http://tobi.oetiker.ch/lshort/
 [3]: http://faq.tug.org
 [4]: http://www.tug.org/begin.html
 
@@ -66,6 +66,16 @@ lines:
 You will want to comment out any other instances of `page_width` and
 `page_height` by using the `%` character.
 
+### Dockerfile
+
+If you use Docker, lucaswoj has provided a [Dockerfile][5] to automate the LaTeX
+setup.
+
+Note that this method is not officially supported or endorsed. It is mentioned
+only in the hope that some users find it useful.
+
+[5]: https://gist.github.com/lucaswoj/176af70493aa4a37cbf8
+
 ## Examples
 
 There are several examples included:
@@ -83,9 +93,9 @@ ensure all the auxilliary files (eg table of contents) are created. You will
 also have to run `bibtex` to generate the bibliography, and then run `pdflatex`
 again, afterwards.
 
-To simply this process, you may find [Latexmk][5] to be useful.
+To simply this process, you may find [Latexmk][6] to be useful.
 
-[5]: http://www.phys.psu.edu/~collins/software/latexmk-jcc/
+[6]: http://www.phys.psu.edu/~collins/software/latexmk-jcc/
 
 Latexmk will run `pdflatex` and `bibtex` as many times as is necessary for you,
 so you only need to call it once. See Makefile.example.
@@ -126,6 +136,34 @@ line, just add `\usepackage{foo}`, where `foo` is the package name.
 * ltxtable: for a merge of longtable and tabularx, which may not work.
 * times, mathptm: for using the Times font in your text and math.
 
+# Status of this project
+
+**I am looking for a new maintainer for this project. In the meantime, I am more
+than happy to review and accept PRs.**
+
+---
+
+This LaTeX class was originally created by Simon Law in 2002. In 2011, Casey
+Banner created a GitHub repo for this class and made some updates. All other
+uw-wkrpt repos on GitHub are forks of Casey's repo.
+
+In 2012, I significantly updated the class to match the latest requirements for
+the software engineering program. I am reasonably confident that the class
+conforms to the SE work report guidelines of Fall 2012.
+
+However, there is still much work to be done. The SE guidelines are at best two
+years outdated, and the other guidelines are eleven years outdated. A lot of
+LaTeX conventions and best practices have changed over the last decade. The
+class is in need of a major update (or even rewrite).
+
+I no longer have the interest to do this, and am now looking for a new
+maintainer for this project. If you are interested, please let me know.
+
+This class has helped many students with the formatting of their work reports,
+and I hope it will continue to do so.
+
+-- Ming-Ho Yee, 2014-05-25
+
 # Contributors
 
 -- Simon Law <[email protected]>  Wed, 30 Apr 2003 19:34:41 -0400

uw-wkrpt-se.tex

@@ -19,7 +19,7 @@
 %
 % We begin by calling the workreport class which includes all the
 % definitions for the macros we will use.
-\documentclass[se,blockletter]{uw-wkrpt}
+\documentclass[se]{uw-wkrpt}
 
 % LaTeX preamble: load some packages to add functionality
 \usepackage{graphicx} % Include graphic importing
@@ -29,8 +29,17 @@
 
 \usepackage{indentfirst} % Indent first paragraph of each section
 
+\usepackage[titletoc,title]{appendix} % Prefix appendix letters with `Appendix'
+
+% For mathematical symbols in our pseudocode
+\usepackage{amsmath}
+
+% Use the algorithmicx package for pseudocode
+\usepackage{algorithm}
+\usepackage{algpseudocode}
+
 % Use biblatex for references
-\usepackage[style=ieee,sorting=none,dateabbrev=false]{biblatex}
+\usepackage[style=ieee,sorting=none,dateabbrev=false,backend=biber]{biblatex}
 \addbibresource{uw-wkrpt-bib.bib} % Specify the bibliography file
 
 % This needs to be the last package loaded
@@ -57,6 +66,9 @@
 % Fill in your student ID number.
 \uwid{01234567}
 
+% Fill in the name of the PNG file with your signature, or leave unchanged.
+\signature{signature}
+
 % Fill in your home address.
 \address{123 University Ave. W.\\*
          Waterloo, ON\ \ N2L 3G1}
@@ -86,7 +98,7 @@
 \program{Software Engineering}
 
 % Fill in the department chair's name.
-\chair{Dr.\ C.\ Clarke}
+\chair{Dr.\ A.\ Morton}
 
 % Fill in the department chair's mailing address.
 \chairaddress{Software Engineering\\*
@@ -222,8 +234,29 @@ \subsection{Advantages}
   \item Math output is by far superior in \LaTeX.  You can write things
         like $\sum_{i=1}^{\infty} \frac{1}{x}$ or:
         \[\int_{0}^{\infty} \delta(x)\,dx = u(x) + C\]
+
+  \item Many useful packages, such as \texttt{algorithmicx}, are available. For
+        example, consider the nonsensical pseudocode in Figure
+        \ref{code:nonsense} generated by the \texttt{algorithmicx} package.
 \end{itemize}
 
+\begin{figure}
+  \caption{Nonsense pseudocode.}
+  \label{code:nonsense}
+  \begin{algorithmic}[1]
+    \Function{Nonsense}{$f, x$}
+      \For{\textbf{each} cow $C$ in $f$}
+        \State $l \gets \text{an arbitrary llama in $C$}$
+        \State \text{set $l$ to True}
+        \State $result \gets \Call{Complicate}{f, l}$
+        \If {$result \not = \text{UNKNOWN}$}
+          \State \text{\textbf{return} result}
+        \EndIf
+      \EndFor
+    \EndFunction
+  \end{algorithmic}
+\end{figure}
+
 \subsection{What are \TeX{} and \LaTeX{}?}
 %
 \TeX{} was designed and implemented by Donald E. Knuth, the famous author
@@ -465,6 +498,7 @@ \section{Acknowledgements}
 %%
 %% Don't forget to refer to all your appendices in the main report.
 \appendix
+\begin{appendices}
 
 \section{Bugs}\label{app:bugs}
 Currently, there are some known problems with this document class.
@@ -476,6 +510,12 @@ \section{Bugs}\label{app:bugs}
   \item It does not bring world peace.
 \end{itemize}
 
+\subsection{Subsection}
+
+foobar
+
+\subsubsection{subsubsection}
+
 Fixes for these bugs are most certainly welcome.  Please provide a patch
 against the document class document.
 
@@ -870,4 +910,5 @@ \subsection*{\centerline{How to Apply These Terms to Your New Programs}}
 
 \end{singlespacing}
 
+\end{appendices}
 \end{document}