- Updated ancillary documentation to reflect v2.3 changes.

nigel.stanger / ouexam

Browse code - Updated ancillary documentation to reflect v2.3 changes. master OUEXAM_2_4_2 OUEXAM_2_4_1 OUEXAM_2_4 OUEXAM_2_3_2 OUEXAM_2_3_1 OUEXAM_2_3
1 parent 0dae1e3 commit 98ce2fec5e82a2ddaedab3c7bca265978f01702c nstanger authored on 4 Sep 2012

Patch

Showing 3 changed files

Ignore Space Show notes View INSTALL
****************************************************************************** File: $Id$ ******************************************************************************** ouexam 2.3 Requirements and Installation ========================================== You will need the verbatim, fontenc, textcomp and lmodern packages in order to use ouexam. These should come standard with most TeX installations. To build the documentation and example files, you will need at least version 1.1 of the listings package, and pdfjam. To install the easy way: 1 Unpack the distribution archive and cd to the distribution directory. 2 make 3 make install TEXMF_INSTALL=/path/to/texmf. /path/to/texmf should be the root of your preferred texmf tree (e.g., /usr/share/texmf). You may need to do this as root depending on which texmf tree you are installing into. You can also define TEXMF_INSTALL as an environment variable then simply type make install. To install manually, unpack the distribution archive, cd to the distribution directory, and do the following (now you know why there's a Makefile :) latex ouexam.ins pdflatex example1.tex pdflatex example1.tex pdfjam --outfile eg1-1.pdf example1.pdf 1 pdfjam --outfile eg1-2.pdf example1.pdf 2 pdfjam --outfile eg1-3.pdf example1.pdf 3 pdflatex example2.tex pdflatex example2.tex pdfjam --outfile eg2-1.pdf example2.pdf 1 pdfjam --outfile eg2-2.pdf example2.pdf 2 pdfjam --outfile eg2-3.pdf example2.pdf 3 pdfjam --outfile eg2-4.pdf example2.pdf 4 pdflatex ouexam.dtx pdflatex ouexam.dtx pdflatex ouexam.dtx Put ouexam.cls in /path/to/texmf/tex/latex/ouexam. Put eg.pdf, ouexam.pdf, ouexam.dtx, ouexam.ins, FAQ, INSTALL, MANIFEST, README and TODO in /path/to/texmf/doc/latex/ouexam. Put Create.pdf, example.tex, example.pdf and lstlang0.sty in /path/to/texmf/doc/latex/ouexam/example. ****************************************************************************** File: $Id$ ******************************************************************************** ouexam 2.1.2 Requirements and Installation ========================================== You will need Rainer Schopf's verbatim package in order to use ouexam. This should come standard with most TeX installations. To build the documentation and example files, you will need at least version 1.1 of the listings package, and GhostScript. To install the easy way: 1 Unpack the distribution archive and cd to the distribution directory. 2 make 3 make install TEXMF_INSTALL=/path/to/texmf. /path/to/texmf should be the root of your preferred texmf tree (e.g., /usr/share/texmf). You may need to do this as root depending on which texmf tree you are installing into. You can also define TEXMF_INSTALL as an environment variable then simply type make install. To install manually, unpack the distribution archive, cd to the distribution directory, and do the following (now you know why there's a Makefile :) latex ouexam.ins latex example1.tex latex example1.tex dvips -pp 1 -E -o eg1-1.eps example1.dvi dvips -pp 2 -E -o eg1-2.eps example1.dvi dvips -pp 3 -E -o eg1-3.eps example1.dvi latex example2.tex latex example2.tex dvips -pp 2 -E -o eg2-2.eps example2.dvi dvips -pp 3 -E -o eg2-3.eps example2.dvi dvips -pp 4 -E -o eg2-4.eps example2.dvi dvips -pp 5 -E -o eg2-5.eps example2.dvi latex ouexam.dtx latex ouexam.dtx latex ouexam.dtx dvips -o ouexam.ps ouexam.dvi ps2pdf ouexam.ps dvips -o example1.ps example1.dvi ps2pdf example1.ps dvips -o example2.ps example2.dvi ps2pdf example2.ps Put ouexam.cls in /path/to/texmf/tex/latex/ouexam. Put eg.eps, ouexam.pdf, ouexam.dvi, ouexam.dtx, ouexam.ins, FAQ, INSTALL, MANIFEST, README and TODO in /path/to/texmf/doc/latex/ouexam. Put Create.eps, example.tex, example.dvi, example*.pdf and lstlang0.sty in /path/to/texmf/doc/latex/ouexam/example.

Ignore Space Show notes View

INSTALL

********************************************************************************
**
** File: $Id$
**
********************************************************************************

ouexam 2.3 Requirements and Installation
==========================================

You will need the verbatim, fontenc, textcomp and lmodern packages in
order to use ouexam. These should come standard with most TeX
installations. To build the documentation and example files, you will
need at least version 1.1 of the listings package, and pdfjam.

To install the easy way:

1 Unpack the distribution archive and cd to the distribution
	  directory.

2 make
	
	3 make install TEXMF_INSTALL=/path/to/texmf.
	  /path/to/texmf should be the root of your preferred texmf tree
	  (e.g., /usr/share/texmf). You may need to do this as root
	  depending on which texmf tree you are installing into. You can
	  also define TEXMF_INSTALL as an environment variable then simply
	  type make install.

To install manually, unpack the distribution archive, cd to the
distribution directory, and do the following (now you know why there's a
Makefile :)

latex ouexam.ins
pdflatex example1.tex
pdflatex example1.tex
pdfjam --outfile eg1-1.pdf example1.pdf 1
pdfjam --outfile eg1-2.pdf example1.pdf 2
pdfjam --outfile eg1-3.pdf example1.pdf 3
pdflatex example2.tex
pdflatex example2.tex
pdfjam --outfile eg2-1.pdf example2.pdf 1
pdfjam --outfile eg2-2.pdf example2.pdf 2
pdfjam --outfile eg2-3.pdf example2.pdf 3
pdfjam --outfile eg2-4.pdf example2.pdf 4
pdflatex ouexam.dtx
pdflatex ouexam.dtx
pdflatex ouexam.dtx

Put ouexam.cls in /path/to/texmf/tex/latex/ouexam.

Put eg*.pdf, ouexam.pdf, ouexam.dtx, ouexam.ins, FAQ,
INSTALL, MANIFEST, README and TODO in /path/to/texmf/doc/latex/ouexam.

Put Create*.pdf, example*.tex, example*.pdf and
lstlang0.sty in /path/to/texmf/doc/latex/ouexam/example.

********************************************************************************
**
** File: $Id$
**
********************************************************************************

ouexam 2.1.2 Requirements and Installation
==========================================

You will need Rainer Schopf's verbatim package in order to use ouexam.
This should come standard with most TeX installations. To build the
documentation and example files, you will need at least version 1.1 of
the listings package, and GhostScript.

To install the easy way:

1 Unpack the distribution archive and cd to the distribution
	  directory.

To install manually, unpack the distribution archive, cd to the
distribution directory, and do the following (now you know why there's a
Makefile :)

latex ouexam.ins
latex example1.tex
latex example1.tex
dvips -pp 1 -E -o eg1-1.eps example1.dvi
dvips -pp 2 -E -o eg1-2.eps example1.dvi
dvips -pp 3 -E -o eg1-3.eps example1.dvi
latex example2.tex
latex example2.tex
dvips -pp 2 -E -o eg2-2.eps example2.dvi
dvips -pp 3 -E -o eg2-3.eps example2.dvi
dvips -pp 4 -E -o eg2-4.eps example2.dvi
dvips -pp 5 -E -o eg2-5.eps example2.dvi
latex ouexam.dtx
latex ouexam.dtx
latex ouexam.dtx
dvips -o ouexam.ps ouexam.dvi
ps2pdf ouexam.ps
dvips -o example1.ps example1.dvi
ps2pdf example1.ps
dvips -o example2.ps example2.dvi
ps2pdf example2.ps

Put ouexam.cls in /path/to/texmf/tex/latex/ouexam.

Put eg*.eps, ouexam.pdf, ouexam.dvi, ouexam.dtx, ouexam.ins, FAQ,
INSTALL, MANIFEST, README and TODO in /path/to/texmf/doc/latex/ouexam.

Put Create*.eps, example*.tex, example*.dvi, example*.pdf and
lstlang0.sty in /path/to/texmf/doc/latex/ouexam/example.

Ignore Space Show notes View MANIFEST
****************************************************************************** File: $Id$ ****************************************************************************** CreateCluster.pdf - images for the example document CreateIndex.pdf CreateObjectType.pdf CreateTable1.pdf CreateTable2.pdf FAQ INSTALL MANIFEST Makefile README TODO example.tex - example document source files example1.tex example2.tex lstlang0.sty - listings language definitions for the example ouexam.dtx - ouexam class and documentation ouexam.ins - ouexam installation driver **************************************************************************** File: $Id$ ******************************************************************************** CreateCluster.eps - images for the example document CreateIndex.eps CreateObjectType.eps CreateTable1.eps CreateTable2.eps FAQ INSTALL MANIFEST Makefile README TODO example.tex - example document source files example1.tex example2.tex lstlang0.sty - listings language definitions for the example ouexam.dtx - ouexam class and documentation ouexam.ins - ouexam installation driver

Ignore Space Show notes View

MANIFEST

Ignore Space Show notes View README
****************************************************************************** File: $Id$ ******************************************************************************** ouexam v2.3 ============= ouexam document class v2.3, 4 September 2012 Copyright 1999--2012 Nigel Stanger and University of Otago This LaTeX2e document class enables the production of University of Otago formatted examination papers. It handles all the fiddly layout requirements (such as printing `TURN OVER' at the bottom of every page except the last), and also ensures that the actual number of marks for questions in the examination add up to the expected number of marks. WHAT'S NEW IN VERSION 2.3 * Updated exam paper formatting to conform to latest University standards. * Added "times" class option. * ouexam now requires the fontenc, textcomp and lmodern packages. * Generating the class documentation now required PDFLaTeX. WHAT'S NEW IN VERSION 2.2 * Added time allocation macros. WHAT'S NEW IN VERSION 2.1.3 * Changed the defaults for \material, \copiesof and \otherinstructions to "N/A". WHAT'S NEW IN VERSION 2.1.2 * The "subject to inspection" messages that appear in the calculators and permitted material sections of the title page now only appear when calculators are allowed or there actually is additional permitted material, respectively. WHAT'S NEW IN VERSION 2.1.1 * "END" is now printed at the bottom of the last page of the exam. WHAT'S NEW IN VERSION 2.1 * Updated the calculators macro to conform to the new University calculator regulations. \allowcalculators now has an optional argument to specify the kinds of calculators permitted. * \permitcalculators has been added as a synonym for \allowcalculators. WHAT'S NEW IN VERSION 2.0.2 * If you omitted any of the required title page macros (\examyear, \papernumber, \papertitle or \department), ouexam crashed when trying to report the error. Fixed. * Added the ability to specify "FY" (full-year) as a semester type in the \semester macro. WHAT'S NEW IN VERSION 2.0.1 * There was a bug in the definition of the macros for numbering sub-sub-questions that meant they were numbered as "(a)" instead of the correct "(i)". Fixed. * When referencing sub-questions or sub-sub-questions, the entire question number was included (that is, "1(b)(iii)" instead of just "(iii)"). This made it difficult to sensibly reference these items, so the relevant macros have been changed to omit this prefixed information. References to questions now print as "1", sub-questions as "(b)" and sub-sub-questions as "(iii)". If this does not suit your requirements, change the \labelquestion, \labelsubquestion or \labelsubsubquestion macros. REQUIREMENTS ouexam requires the verbatim class, which should be standard on most LaTeX installations. The class documentation uses the graphicx and hyperref packages, so you will have to install these first if you don't have them already. INSTALLING (UNIX OR SIMILAR) A makefile is provided: * "make" will produce both ouexam.cls and ouexam.pdf. * "make class" will produce ouexam.cls. Place this file in a directory somewhere in your TeX search path (e.g., if you use teTeX, put it in texmf/tex/latex/ouexam or somewhere similar). * "make doc" will produce ouexam.pdf. INSTALLING (EVERYTHING ELSE) Run ouexam.ins through LaTeX to produce ouexam.cls. Place this file in a directory somewhere in your LaTeX search path. Then run ouexam.dtx through PDFLaTeX _three_ (yes, three) times to produce the documentation. ****************************************************************************** File: $Id$ ******************************************************************************** ouexam v2.1.2 ============= ouexam document class v2.1.2, 14 August 2008 Copyright 1999--2008 Nigel Stanger and University of Otago This LaTeX2e document class enables the production of University of Otago formatted examination papers. It handles all the fiddly layout requirements (such as printing `TURN OVER' at the bottom of every page except the last), and also ensures that the actual number of marks for questions in the examination add up to the expected number of marks. WHAT'S NEW IN VERSION 2.1.2 * The "subject to inspection" messages that appear in the calculators and permitted material sections of the title page now only appear when calculators are allowed or there actually is additional permitted material, respectively. WHAT'S NEW IN VERSION 2.1.1 * "END" is now printed at the bottom of the last page of the exam. WHAT'S NEW IN VERSION 2.1 * Updated the calculators macro to conform to the new University calculator regulations. \allowcalculators now has an optional argument to specify the kinds of calculators permitted. * \permitcalculators has been added as a synonym for \allowcalculators. WHAT'S NEW IN VERSION 2.0.2 * If you omitted any of the required title page macros (\examyear, \papernumber, \papertitle or \department), ouexam crashed when trying to report the error. Fixed. * Added the ability to specify "FY" (full-year) as a semester type in the \semester macro. WHAT'S NEW IN VERSION 2.0.1 * There was a bug in the definition of the macros for numbering sub-sub-questions that meant they were numbered as "(a)" instead of the correct "(i)". Fixed. * When referencing sub-questions or sub-sub-questions, the entire question number was included (that is, "1(b)(iii)" instead of just "(iii)"). This made it difficult to sensibly reference these items, so the relevant macros have been changed to omit this prefixed information. References to questions now print as "1", sub-questions as "(b)" and sub-sub-questions as "(iii)". If this does not suit your requirements, change the \labelquestion, \labelsubquestion or \labelsubsubquestion macros. REQUIREMENTS ouexam requires the verbatim class, which should be standard on most LaTeX installations. The class documentation uses the graphicx and hyperref packages, so you will have to install these first if you don't have them already. INSTALLING (UNIX OR SIMILAR) A makefile is provided: * `make' will produce both ouexam.cls and ouexam.dvi (see below). * `make class' will produce ouexam.cls. Place this file in a directory somewhere in your TeX search path (e.g., if you use teTeX, put it in texmf/tex/latex/ouexam or somewhere similar). * `make doc' will produce ouexam.dvi. * If you have GhostScript and the dvipdf command, `make pdfdoc' will produce PDF documentation. INSTALLING (EVERYTHING ELSE) Run ouexam.ins through LaTeX to produce ouexam.cls. Place this file in a directory somewhere in your LaTeX search path. Then run ouexam.dtx through LaTeX _three_ (yes, three) times to produce the documentation (ouexam.dvi). PDF documentation can be produced from the DVI by whatever means you normally use to do so.

Ignore Space Show notes View

README

********************************************************************************
**
** File: $Id$
**
********************************************************************************

ouexam v2.3
=============

ouexam document class v2.3, 4 September 2012

This LaTeX2e document class enables the production of University of Otago
formatted examination papers. It handles all the fiddly layout requirements
(such as printing `TURN OVER' at the bottom of every page except the last),
and also ensures that the actual number of marks for questions in the
examination add up to the expected number of marks.

WHAT'S NEW IN VERSION 2.3

* Updated exam paper formatting to conform to latest University standards.

* Added "times" class option.

* ouexam now requires the fontenc, textcomp and lmodern packages.

* Generating the class documentation now required PDFLaTeX.

WHAT'S NEW IN VERSION 2.2

* Added time allocation macros.

WHAT'S NEW IN VERSION 2.1.3

* Changed the defaults for \material, \copiesof and \otherinstructions to
  "N/A".

WHAT'S NEW IN VERSION 2.1.2

* The "subject to inspection" messages that appear in the calculators and
  permitted material sections of the title page now only appear when
  calculators are allowed or there actually is additional permitted
  material, respectively.

WHAT'S NEW IN VERSION 2.1.1

* "END" is now printed at the bottom of the last page of the exam.

WHAT'S NEW IN VERSION 2.1

* Updated the calculators macro to conform to the new University calculator
  regulations. \allowcalculators now has an optional argument to specify
  the kinds of calculators permitted.

* \permitcalculators has been added as a synonym for \allowcalculators.

WHAT'S NEW IN VERSION 2.0.2

* If you omitted any of the required title page macros (\examyear,
  \papernumber, \papertitle or \department), ouexam crashed when trying
  to report the error. Fixed.

* Added the ability to specify "FY" (full-year) as a semester type in the
  \semester macro.

WHAT'S NEW IN VERSION 2.0.1

* There was a bug in the definition of the macros for numbering
  sub-sub-questions that meant they were numbered as "(a)" instead of the
  correct "(i)". Fixed.

* When referencing sub-questions or sub-sub-questions, the entire question
  number was included (that is, "1(b)(iii)" instead of just "(iii)"). This
  made it difficult to sensibly reference these items, so the relevant
  macros have been changed to omit this prefixed information. References to
  questions now print as "1", sub-questions as "(b)" and sub-sub-questions
  as "(iii)". If this does not suit your requirements, change the
  \labelquestion, \labelsubquestion or \labelsubsubquestion macros.

REQUIREMENTS

ouexam requires the verbatim class, which should be standard on most LaTeX
installations. The class documentation uses the graphicx and hyperref
packages, so you will have to install these first if you don't have them
already.

INSTALLING (UNIX OR SIMILAR)

A makefile is provided:

* "make" will produce both ouexam.cls and ouexam.pdf.

* "make class" will produce ouexam.cls. Place this file in a directory
	  somewhere in your TeX search path (e.g., if you use teTeX, put it in
	  texmf/tex/latex/ouexam or somewhere similar).

* "make doc" will produce ouexam.pdf.

INSTALLING (EVERYTHING ELSE)

Run ouexam.ins through LaTeX to produce ouexam.cls. Place this file in a
directory somewhere in your LaTeX search path. Then run ouexam.dtx through
PDFLaTeX _three_ (yes, three) times to produce the documentation.

********************************************************************************
**
** File: $Id$
**
********************************************************************************

ouexam v2.1.2
=============

ouexam document class v2.1.2, 14 August 2008

WHAT'S NEW IN VERSION 2.1.2

WHAT'S NEW IN VERSION 2.1.1

* "END" is now printed at the bottom of the last page of the exam.

WHAT'S NEW IN VERSION 2.1

* Updated the calculators macro to conform to the new University calculator
  regulations. \allowcalculators now has an optional argument to specify
  the kinds of calculators permitted.

* \permitcalculators has been added as a synonym for \allowcalculators.

WHAT'S NEW IN VERSION 2.0.2

* If you omitted any of the required title page macros (\examyear,
  \papernumber, \papertitle or \department), ouexam crashed when trying
  to report the error. Fixed.

* Added the ability to specify "FY" (full-year) as a semester type in the
  \semester macro.

WHAT'S NEW IN VERSION 2.0.1

* There was a bug in the definition of the macros for numbering
  sub-sub-questions that meant they were numbered as "(a)" instead of the
  correct "(i)". Fixed.

REQUIREMENTS

INSTALLING (UNIX OR SIMILAR)

A makefile is provided:

* `make' will produce both ouexam.cls and ouexam.dvi (see below).

* `make class' will produce ouexam.cls. Place this file in a directory
	  somewhere in your TeX search path (e.g., if you use teTeX, put it in
	  texmf/tex/latex/ouexam or somewhere similar).

* `make doc' will produce ouexam.dvi.
	
	* If you have GhostScript and the dvipdf command, `make pdfdoc' will
	  produce PDF documentation.

INSTALLING (EVERYTHING ELSE)

Run ouexam.ins through LaTeX to produce ouexam.cls. Place this file in a
directory somewhere in your LaTeX search path. Then run ouexam.dtx through
LaTeX _three_ (yes, three) times to produce the documentation (ouexam.dvi).
PDF documentation can be produced from the DVI by whatever means you
normally use to do so.

Show line notes below