ueaassig v3.01: LaTeX 2"Class for Writing UEA Exam Sheets

This is the documentation for ueaassig, a class le for typesetting assignment sheets.

1.1 Class Options

In addition to the standard options that can be passed to the article class le, the following options are also available:

The defaults are: 12pt, a4paper, times. If one of the large font sizes are used (14pt, 17pt or 20pt) the extarticle class le will be loaded, otherwise the article class le will be loaded.

1.2 Title Page Information

The title page information should be specied inside the titleinfo titleinfo environment at the start of the document. Within this environment you may use the following commands:

\title{Laboratory Exercise 1 --- Getting Started}

This species the percentage value of the assignment. For example, if the assignment has a value of 20%:

This species the learning outcomes. As with \aim, the argument should include \subjectspecific and/or \transferable.

1.3 Assignment Details

After the titleinfo environment (described above), the description of the assignment should following in the assignment assignment environment. For example:

\begin{assignment}
  This is the description of the assignment.
  Your task is to write an application that’s rather clever and
  requires a lot of imagination and talent.
\end{assignment}

The general guidelines should be specied in the guidelines guidelines environment. For example:

\begin{guidelines}
  The application must be:
  \begin{itemize}
    \item Clever
    \item Imaginative
  \end{itemize}
  Please read carefully the submission guidelines below.
\end{guidelines}

The assessment information should be specied in the assessment assessment environment. Within this environment you can use the marksawarded marksaward environment. This should contain a series of

\begin{assessment}
  \begin{marksawarded}
    \submark{10}{Including comments in the code}
    \submark{80}{Writing working code}
    \submark{10}{Writing documentation}
  \end{marksawarded}
\end{assessment}

1.4 Submission Procedure, Deadlines and Plagiarism

At the end of the document, you should use the submission submission environment to add the submission details. For example:

\begin{submission}
  Write all the files comprising the application to a CD or DVD and
  test that it works on one of the PC lab computers. Write your
  student number on the CD or DVD.
  Print an assignment cover sheet from your portal.
  Attach your written work and the CD or DVD (in a suitable cover)
  to the cover sheet.
\end{submission}

At the end of this environment, boilerplate text about deadlines and plagiarism will be inserted.

1.5 Example Document

\documentclass{ueaassig}
\begin{document}
% Title page information:
\begin{titleinfo}
   \unit{CMPS-1A4Y}
   \title{Laboratory Exercise 1 --- Getting Started}
   \date{Monday of week 2}
   \submissiondate{Friday of week 3}
   \returndate{Friday of week 4}
   \setby{Dr Some One}
   \checkedby{Dr Ann Other}
   \assignvalue{20}
  % Assignment aim
  \aim{%
    \subjectspecific{Gain experience doing something or other}
    \transferable{Some skill or other}
  }
  % What the student will have learnt by completing the exercise
  \learning{%
    \subjectspecific{%
      The ability to do something.
      To gain experience doing something else}
  }
  % The assessment criteria
  \criteria{%
    A working solution.
    The use of clear, readable code.
  }
\end{titleinfo}
% Description of the assignment:
\begin{assignment}
  This is the description of the assignment.
  Your task is to write an application that’s rather clever and
  requires a lot of imagination and talent.
\end{assignment}
% General guidelines
\begin{guidelines}
  The application must be:
  \begin{itemize}
    \item Clever
    \item Imaginative
  \end{itemize}
  Please read carefully the submission guidelines below.
\end{guidelines}
% Assessment
\begin{assessment}
% Breakdown of how marks are awarded:
  \begin{marksawarded}
    \submark{10}{Including comments in the code}
    \submark{80}{Writing working code}
    \submark{10}{Writing documentation}
  \end{marksawarded}
\end{assessment}
% Submission procedure, deadlines and plagiarism:
\begin{submission}
  Write all the files comprising the application to a CD or DVD and
  test that it works on one of the PC lab computers. Write your
  student number on the CD or DVD.
  Print an assignment cover sheet from your portal.
  Attach your written work and the CD or DVD (in a suitable cover)
  to the cover sheet.
\end{submission}
\end{document}

Index

\aim  1
article class  2, 3
assessment (environment)  4
assignment (environment)  5
\assignvalue  6

C \checkedby  7
class options:
    12pt  8
    14pt  9, 10
    17pt  11, 12
    20pt  13, 14
    a4paper  15
    notimes  16
    times  17, 18
\criteria  19

D \date 20

E environments:
    assessment  21
    assignment  22
    guidelines  23
    marksawarded  24
    submission  25
    titleinfo  26, 27
extarticle class  28

G guidelines (environment) 29

L \learning 30

M marksawarded (environment) 31

S \setby  32
\subjectspecific  33
\submark  34
submission (environment)  35

T \title  36
titleinfo (environment)  37, 38
\transferable  39

U ueaassig class 40
\unit 41