Switched README, etc., to Markdown.

nigel.stanger / ouexam

Browse code Switched README, etc., to Markdown. master OUEXAM_2_4_2 OUEXAM_2_4_1 OUEXAM_2_4 OUEXAM_2_3_2 OUEXAM_2_3_1
1 parent a23fdb4 commit 51fbb28d588bdd540a62e0d05fb8f670811fba93 Nigel Stanger authored on 28 May 2013

Patch

Showing 4 changed files

Show notes View README 100644 → 0
****************************************************************************** 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.

Show notes View

README 100644 → 0

********************************************************************************
**
** 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.

Ignore Space Show notes View README.md 0 → 100644
****************************************************************************** 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.

Ignore Space Show notes View

README.md 0 → 100644

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

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

ouexam document class v2.3, 4 September 2012

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

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.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)

Show notes View TODO 100644 → 0
****************************************************************************** File: $Id$ ******************************************************************************** THINGS TO DO ============ - ouexam appears to be incompatible with hyperref? Crashes during \maketitlepage. (Mark) - Specify questions with no marks attached. \question* perhaps? - Marks totalling currently doesn't work with sections where not all questions are to be answered (e.g., "Answer any 2 questions"). At the moment it totals up all the questions, when in fact the total should be less. Workaround: reset the counter to the correct total after the last question in the section. - Look at bundling all the various support files into the .dtx file? - Figure out how to gobble line breaks before a \end{subquestion} so that they don't screw up the positioning of the number of marks. A similar issue seems to arise with lgrind'ed listings that appear at the end of questions (but this actually causes things to break). - Some way of entering timings for questions (Andrew L.): > Further to our discussion on exam timings. Maybe it would be > useful to provide a way to show the timings for each question > using your LaTeX exam class? Perhaps they could appear in the > margin next to each question. - Add up marks for marking schedule and check they are the same as the total marks for a question (Richard?). - Generate marking sheets from the marking schedule info? (to appear at end of document) - Reinstate question mark subtotals as a class option (format [Question y total x marks]). - Options for positioning of mark amounts (end of question vs. in margin). - Styles for number of marks? - Options for positioning of page numbers (footer vs. header). - Different types of questions (e.g., multiple choice, fill in the blank, etc.). - Does the draft option need to be passed to the article class? - \questionskip: how much whitespace after a question (default \baselineskip). Turn this off when markingschedule is active?

Show notes View

TODO 100644 → 0

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

THINGS TO DO
============

- ouexam appears to be incompatible with hyperref? Crashes during
  \maketitlepage. (Mark)

- Specify questions with no marks attached. \question* perhaps?

- Marks totalling currently doesn't work with sections where not all
  questions are to be answered (e.g., "Answer any 2 questions"). At the
  moment it totals up all the questions, when in fact the total should be
  less. Workaround: reset the counter to the correct total after the last
  question in the section.

- Look at bundling all the various support files into the .dtx file?

- Figure out how to gobble line breaks before a \end{subquestion} so that they
  don't screw up the positioning of the number of marks. A similar issue seems
  to arise with lgrind'ed listings that appear at the end of questions (but
  this actually causes things to break).

- Some way of entering timings for questions (Andrew L.):

> Further to our discussion on exam timings. Maybe it would be 
> useful to provide a way to show the timings for each question
> using your LaTeX exam class? Perhaps they could appear in the 
> margin next to each question.

- Add up marks for marking schedule and check they are the same as the total
  marks for a question (Richard?).

- Generate marking sheets from the marking schedule info? (to appear at end
  of document)

- Reinstate question mark subtotals as a class option (format [Question y total
  x marks]).

- Options for positioning of mark amounts (end of question vs. in margin).

- Styles for number of marks?

- Options for positioning of page numbers (footer vs. header).

- Different types of questions (e.g., multiple choice, fill in the blank, etc.).

- Does the draft option need to be passed to the article class?

- \questionskip: how much whitespace after a question (default \baselineskip).
  Turn this off when markingschedule is active?

Ignore Space Show notes View TODO.md 0 → 100644
****************************************************************************** File: $Id$ ******************************************************************************** THINGS TO DO ============ - ouexam appears to be incompatible with hyperref? Crashes during \maketitlepage. (Mark) - Specify questions with no marks attached. \question* perhaps? - Marks totalling currently doesn't work with sections where not all questions are to be answered (e.g., "Answer any 2 questions"). At the moment it totals up all the questions, when in fact the total should be less. Workaround: reset the counter to the correct total after the last question in the section. - Look at bundling all the various support files into the .dtx file? - Figure out how to gobble line breaks before a \end{subquestion} so that they don't screw up the positioning of the number of marks. A similar issue seems to arise with lgrind'ed listings that appear at the end of questions (but this actually causes things to break). - Some way of entering timings for questions (Andrew L.): > Further to our discussion on exam timings. Maybe it would be > useful to provide a way to show the timings for each question > using your LaTeX exam class? Perhaps they could appear in the > margin next to each question. - Add up marks for marking schedule and check they are the same as the total marks for a question (Richard?). - Generate marking sheets from the marking schedule info? (to appear at end of document) - Reinstate question mark subtotals as a class option (format [Question y total x marks]). - Options for positioning of mark amounts (end of question vs. in margin). - Styles for number of marks? - Options for positioning of page numbers (footer vs. header). - Different types of questions (e.g., multiple choice, fill in the blank, etc.). - Does the draft option need to be passed to the article class? - \questionskip: how much whitespace after a question (default \baselineskip). Turn this off when markingschedule is active?