GitBucket
4.21.2
Toggle navigation
Snippets
Sign in
Files
Branches
1
Releases
Issues
Pull requests
Labels
Priorities
Milestones
Wiki
Forks
nigel.stanger
/
LaTeX
Browse code
Merge commit '
4a44d30
'
master
commit
4314c074deb74d65094bd509b0e37b858e11752e
2 parents
8bc2247
+
4a44d30
Nigel Stanger
authored
on 21 May 2021
Patch
Showing
2 changed files
ouexam/HISTORY.md
ouexam/README.md
Ignore Space
Show notes
View
ouexam/HISTORY.md
# Version History ## Version 2.4.2 (2019-08-30) ### New features * Added some Visual Studio Code support infrastructure. ### Updates * Internal code refactoring. ## Version 2.4.1 (2017-08-30) ### Updates * Added a little more detail to the automatically generated instructions for embargoed exams. ## Version 2.4 (2016-08-27) ### New features * Key-value options for the `examsection`, `question`, `subquestion`, and `subsubquestion` environments. These let you control things like whether marks and section titles are printed, and whether or not to compute and verify marks totals for sub-components of sections and questions. * A `\questionskip` length to let you adjust the spacing between top-level questions. * Optional questions—e.g., answer any three of five, where each question is worth 20 marks each, for a total of 60—freaked out the automatic total verification. The totalling can now be disabled for a section using the `don't verify total` option (see above). * Added new `embargo` class option for embargoed exam papers, which have somewhat different title page formatting requirements. ### Fixes * The various question environments must now be correctly nested (i.e., sub-sub-questions within sub-questions within questions). [Stephen Cranefield] * The `draft` class option now has the full functionality you would expect (change bars, etc.). * Disabled the `twocolumn` class option. * Obsoleted the `\newsection` macro, which has been deprecated for ten years! * `ouexam` was incompatible with the `hyperref` package. Fixed. [Mark George] * Float pages on the last page of the document messed up both the page count and the “TURN OVER”/“END” sequencing. Fixed. (Also removed the `lastpage` page style as part of this fix.) [Stephen Cranefield] * Fixed bug that caused a crash when there was a `verbatim` environment followed by a blank line at the end of a question. [Mark George] * Updated to latest 2016 calculator rules. ## Version 2.3.1 (2014-09-15) * Removed “Paper” from the title box to conform to University standards. ## Version 2.3 (2012-09-04) * Updated exam paper formatting to conform to latest University standards. * Added `times` class option. * Disabled `10pt` and `11pt` class options. * `ouexam` now requires the `fontenc`, `textcomp` and `lmodern` packages. * Generating the class documentation now requires PDFLaTeX. ## Version 2.2 (2010-04-26) * Added time allocation macros. ## Version 2.1.3 (2009-04-28) * Changed the defaults for `\material`, `\copiesof` and `\otherinstructions` to “N/A”. * Fixed vertical spacing of title page. ## Version 2.1.2 (2008-08-14) * 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. ## Version 2.1.1 (2006-08-21) * “END” is now printed at the bottom of the last page of the exam. ## Version 2.1 (2004-04-16) * 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`. * Removed the `\marks` macro because it conflicts with a macro in e-TeX. ## Version 2.0.2 (2002-08-22) * 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. ## Version 2.0.1 (2002-04-30) * 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. ## Version 2.0 (2002-01-30) A complete rewrite from scratch. **This version is not backwards compatible with earlier versions!** However, the class will detect attempts to use obsolete features. * Added `draft` and `markingschedule` class options. * Added checking for the correct number of marks. * Added support for summer school exams. * Fixed headers so that the page number is always centered. * Removed `multichoice` class option and all associated macros and environments. * Disabled `twoside` class option, as exam papers are always printed single-sided. ## Version 1.2 (2000-04-14) * Added support for marking schedule information. ## Version 1.1 (1999-04-20) * Added `multichoice` class option. * Added automatic calculation of marks totals for questions. * Added tracking of the number of questions in an exam. * The `subquestions` and `subsubquestions` environment are now disabled when the `multichoice` class option is specified. * Changed default font size to 12pt. * Removed dependence on `calc` and `ifthen` packages. ## Version 1.0 (1999-04-15) Initial release.
Version History =============== Version 2.4.1 (2017-08-30) -------------------------- ### Updates ### * Added a little more detail to the automatically generated instructions for embargoed exams. Version 2.4 (2016-08-27) ------------------------ ### New features ### * Key-value options for the `examsection`, `question`, `subquestion`, and `subsubquestion` environments. These let you control things like whether marks and section titles are printed, and whether or not to compute and verify marks totals for sub-components of sections and questions. * A `\questionskip` length to let you adjust the spacing between top-level questions. * Optional questions—e.g., answer any three of five, where each question is worth 20 marks each, for a total of 60—freaked out the automatic total verification. The totalling can now be disabled for a section using the `don't verify total` option (see above). * Added new `embargo` class option for embargoed exam papers, which have somewhat different title page formatting requirements. ### Fixes ### * The various question environments must now be correctly nested (i.e., sub-sub-questions within sub-questions within questions). [Stephen Cranefield] * The `draft` class option now has the full functionality you would expect (change bars, etc.). * Disabled the `twocolumn` class option. * Obsoleted the `\newsection` macro, which has been deprecated for ten years! * `ouexam` was incompatible with the `hyperref` package. Fixed. [Mark George] * Float pages on the last page of the document messed up both the page count and the “TURN OVER”/“END” sequencing. Fixed. (Also removed the `lastpage` page style as part of this fix.) [Stephen Cranefield] * Fixed bug that caused a crash when there was a `verbatim` environment followed by a blank line at the end of a question. [Mark George] * Updated to latest 2016 calculator rules. Version 2.3.1 (2014-09-15) -------------------------- * Removed “Paper” from the title box to conform to University standards. Version 2.3 (2012-09-04) ------------------------ * Updated exam paper formatting to conform to latest University standards. * Added `times` class option. * Disabled `10pt` and `11pt` class options. * `ouexam` now requires the `fontenc`, `textcomp` and `lmodern` packages. * Generating the class documentation now requires PDFLaTeX. Version 2.2 (2010-04-26) ------------------------ * Added time allocation macros. Version 2.1.3 (2009-04-28) -------------------------- * Changed the defaults for `\material`, `\copiesof` and `\otherinstructions` to “N/A”. * Fixed vertical spacing of title page. Version 2.1.2 (2008-08-14) -------------------------- * 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. Version 2.1.1 (2006-08-21) -------------------------- * “END” is now printed at the bottom of the last page of the exam. Version 2.1 (2004-04-16) ------------------------ * 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`. * Removed the `\marks` macro because it conflicts with a macro in e-TeX. Version 2.0.2 (2002-08-22) -------------------------- * 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. Version 2.0.1 (2002-04-30) -------------------------- * 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. Version 2.0 (2002-01-30) ------------------------ A complete rewrite from scratch. **This version is not backwards compatible with earlier versions!** However, the class will detect attempts to use obsolete features. * Added `draft` and `markingschedule` class options. * Added checking for the correct number of marks. * Added support for summer school exams. * Fixed headers so that the page number is always centered. * Removed `multichoice` class option and all associated macros and environments. * Disabled `twoside` class option, as exam papers are always printed single-sided. Version 1.2 (2000-04-14) ------------------------ * Added support for marking schedule information. Version 1.1 (1999-04-20) ------------------------ * Added `multichoice` class option. * Added automatic calculation of marks totals for questions. * Added tracking of the number of questions in an exam. * The `subquestions` and `subsubquestions` environment are now disabled when the `multichoice` class option is specified. * Changed default font size to 12pt. * Removed dependence on `calc` and `ifthen` packages. Version 1.0 (1999-04-15) ------------------------ Initial release.
Ignore Space
Show notes
View
ouexam/README.md
# ouexam v2.4.2 ouexam document class v2.4.2, 30 August 2019 Copyright 1999–2021 Nigel Stanger and University of Otago This LaTeX2ε 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. ## Requirements You will need the `verbatim`, `fontenc`, `textcomp`, `lmodern`, and `pgfkeys` packages in order to use `ouexam`. These should all come standard with most TeX installations. To build the documentation and example files, you will need `graphicx`, `hyperref`, at least version 1.1 of the `listings` package, and the `pdfjam` tool. ## Installing To install the easy way: 1 Unpack the distribution archive and `cd` to the distribution directory. 2 `make` 3 `make install TEXMFHOME=/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 `TEXMFHOME` 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 ☺). ```sh 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`, `HISTORY`, `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`. You can also build the examples using GUI tools such as TeXMaker, TeXShop, etc. (but see the FAQ below). ## FAQ ### The number of marks for my questions are not appearing at the end of the line even though there is plenty of room for them to fit. You probably have a blank line between the end of your question text and the `\end{question}` macro that actually generates the number of marks. The line break gets processed by TeX before the number of marks is generated and effectively generates a new paragraph. Until I figure out how to stop this from happening, the workaround is to not leave blank lines between the end of the question text and the `\end{question}`. ### I fixed that, but there’s still vertical space between the end of my question and the number of marks. This is almost certainly because the question text ends with a list-based environment of some sort (including `itemize`, `enumerate`, `description`, `list`, `quote`, `quotation`, `center`, `flushleft`, and `flushright`). I’m not convinced that this can be fixed in a general way, but a workaround is to subtract a negative multiple of `\lastskip` immediately before the `\end{question}` (or whatever), e.g., `\vskip-2\lastskip`. -2 is about right if you want the marks to appear on the line following the question text, while -4.75 is about right if you want the marks to be aligned with the final line of the question text. ### Why can’t I build content.tex? `content.tex` is an include file for both `example1.tex` and `example2.tex`. It doesn’t have a `\documentclass` and you therefore *can’t* `pdflatex` it! The only input files you should be building are `example1.tex` and `example2.tex`. ### How do I get rid of “(Subject to inspection by the examiners)”? Add this to the document preamble: ```tex \makeatletter \def\@copiesof{Blah blah blah.} \makeatother ``` **Do not use the `\copiesof` macro.** ### How do I change “N/A” to “NIL” (or or similar)? Add this to the document preamble, **before** you use any of `\material`, `\copiesof`, or `\otherinstructions`: ```tex \makeatletter % Replace "N/A" with "NIL" to keep exams office happy :P \def\@NA{NIL} \let\@material\@NA \let\@copiesof\@NA \let\@otherinst\@NA \makeatother ``` You can then use `\material`, `\copiesof`, or `\otherinstructions` as required. Unused options will print as “NIL”.
# ouexam v2.4.1 ouexam document class v2.4.1, 30 August 2017 Copyright 1999–2017 Nigel Stanger and University of Otago This LaTeX2ε 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. ## Requirements You will need the `verbatim`, `fontenc`, `textcomp`, `lmodern`, and `pgfkeys` packages in order to use `ouexam`. These should all come standard with most TeX installations. To build the documentation and example files, you will need `graphicx`, `hyperref`, at least version 1.1 of the `listings` package, and the `pdfjam` tool. ## Installing To install the easy way: 1 Unpack the distribution archive and `cd` to the distribution directory. 2 `make` 3 `make install TEXMFHOME=/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 `TEXMFHOME` 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 ☺). ```sh 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`, `HISTORY`, `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`. You can also build the examples using GUI tools such as TeXMaker, TeXShop, etc. (but see the FAQ below). ## FAQ ### The number of marks for my questions are not appearing at the end of the line even though there is plenty of room for them to fit. You probably have a blank line between the end of your question text and the `\end{question}` macro that actually generates the number of marks. The line break gets processed by TeX before the number of marks is generated and effectively generates a new paragraph. Until I figure out how to stop this from happening, the workaround is to not leave blank lines between the end of the question text and the `\end{question}`. ### I fixed that, but there’s still vertical space between the end of my question and the number of marks. This is almost certainly because the question text ends with a list-based environment of some sort (including `itemize`, `enumerate`, `description`, `list`, `quote`, `quotation`, `center`, `flushleft`, and `flushright`). I’m not convinced that this can be fixed in a general way, but a workaround is to subtract a negative multiple of `\lastskip` immediately before the `\end{question}` (or whatever), e.g., `\vskip-2\lastskip`. -2 is about right if you want the marks to appear on the line following the question text, while -4.75 is about right if you want the marks to be aligned with the final line of the question text. ### Why can’t I build content.tex? `content.tex` is an include file for both `example1.tex` and `example2.tex`. It doesn’t have a `\documentclass` and you therefore *can’t* `pdflatex` it! The only input files you should be building are `example1.tex` and `example2.tex`. ### How do I get rid of “(Subject to inspection by the examiners)”? Add this to the document preamble: ```tex \makeatletter \def\@copiesof{Blah blah blah.} \makeatother ``` **Do not use the `\copiesof` macro.** ### How do I change “N/A” to “NIL” (or or similar)? Add this to the document preamble, **before** you use any of `\material`, `\copiesof`, or `\otherinstructions`: ```tex \makeatletter % Replace "N/A" with "NIL" to keep exams office happy :P \def\@NA{NIL} \let\@material\@NA \let\@copiesof\@NA \let\@otherinst\@NA \makeatother ``` You can then use `\material`, `\copiesof`, or `\otherinstructions` as required. Unused options will print as “NIL”.
Show line notes below
GitBucket
4.21.2
GitBucket
4.21.2