GitBucket
4.21.2
Toggle navigation
Snippets
Sign in
Files
Branches
1
Releases
19
Issues
Pull requests
Labels
Priorities
Milestones
Wiki
Forks
nigel.stanger
/
ouexam
Browse code
- Merged FAQ and INSTALL into README.
- Extracted version history into HISTORY. - Removed obsolete CVS headers.
master
OUEXAM_2_4_2
OUEXAM_2_4_1
OUEXAM_2_4
OUEXAM_2_3_2
OUEXAM_2_3_1
1 parent
51fbb28
commit
163f6ca0afa2bcc13563b9809f29cab68b88d4a3
Nigel Stanger
authored
on 28 May 2013
Patch
Showing
5 changed files
FAQ
HISTORY.md
INSTALL
README.md
TODO.md
Show notes
View
FAQ
100644 → 0
******************************************************************************** ** ** File: $Id$ ** ******************************************************************************** ouexam 2.1 FAQ ============== Q: The number of marks for my questions are not going at the end of the line even though there is plenty of room for them to fit. A: 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}.
Ignore Space
Show notes
View
HISTORY.md
0 → 100644
Version History =============== 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. Version 2.2 ----------- * Added time allocation macros. Version 2.1.3 ------------- * Changed the defaults for `\material`, `\copiesof` and `\otherinstructions` to “N/A”. 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. Version 2.1.1 ------------- * “END” is now printed at the bottom of the last page of the exam. 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`. 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. 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.
Show notes
View
INSTALL
100644 → 0
******************************************************************************** ** ** 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.
Ignore Space
Show notes
View
README.md
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. Requirements ------------ You will need the verbatim, fontenc, textcomp and lmodern 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 at least version 1.1 of the listings package, and pdfjam. Installing ---------- 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`, `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`. 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. 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}`.
******************************************************************************** ** ** 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
TODO.md
Things To Do ============ - ouexam appears to be incompatible with hyperref? Crashes during \maketitlepage. (Mark George) - 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 Long): > 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?
******************************************************************************** ** ** 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 line notes below