exam-n class – full release notes

# The exam-n class – release notes

1.4.0, 2022 October 10

- The [siunitx] option is now on by default, and the `\units` macro produces a one-time-per-document warning that it will be removed in the next version.
- Having two `\partmarks` commands in an environment is now detected as an error (it was documented as an error, but not checked, so the extra `\partmarks` commands were simply ignored).

1.4.0-b1, 2022 August 7

- The class file now depends on a version of LaTeX which is at least the 2020/10/01 release. This is so that we can use the current LaTeX hooks mechanism.
- Rework `\partmarks`: the `\partmarks` indicator can now go inside most environments, including list, quotes, unnumbered equations, and the various amsmath displays. In these cases, the indicator will automatically appear at the end of the environment. The starred variant of the command still exists, but should rarely be necessary.

1.3.5-b1, 2022 July 11

- Fix erroneous broken line before `\partmarks`, in compose mode, when a paragraph fills the last line.
- Fix support for STIX2 fonts in XeLaTeX and LuaLaTeX (it was working inaccurately before).
- Add an optional argument for `\part` to override part numbering.
- Use the `xcolor` package for colour management, instead of the core `color` package (the `xcolor` package is well-known and stable, and this means that we are compatible with TikZ).
- `\partmarks` in solutions no longer gobble trailing space (doing so is probably right in questions, and is still the case, but `\partmarks` in solutions tend to be more interspersed with text).
- `\label` within a `\part` now refers to the part number (as opposed to the question number).
- Avoid a ‘You can't use `\unskip' in vertical mode’ error, in certain circumstances.
- Add the `[siunitx]` option, indicating that we should load the siunitx package (default no). This is now preferred to the `\units` macro, and the latter will be removed in a forthcoming release.
- Renamed `A1.clo` to clearer `myclass.clo`
- Repository moved from bitbucket to https://heptapod.host/nxg/exam-n, when bitbucket dropped support for Mercurial. This means, incidentally, that links to specific issues at bitbucket are now broken.
- Bold-italic maths should now work correctly with STIX.
- Long `\partmarks` comments now appear as footnotes.
- Solutions are now set `\normalsize`.
- Bugfix: move definition of `\defaultpartmarkscategory` so it can be invoked within a `.clo` file straightforwardly.
- Define the `[uprightpi]` option to set `\pi` as an upright character, as appropriate for a constant (this is implemented fully only for the `[mtpro2]` and `[stix2]` options)..
- Note that the `\units` macro is likely to be deprecated in a forthcoming version, and replaced by a recommendation to use the standard `[siunitx]` package.

1.3, 2018 November 21

- Add a ‘category’ optional argument to `\partmarks`, and add `\defaultpartmarkscategory`.

1.2.1, 2018 July 2

- Bugfix: ignore any content which appears after `\end{document}`, in `\includequestion` (author) files (fixes issue 6).
- The environments `{figure*}` and `{table*}` now produce an error.
- The macro `\vec` now produces correct greek bold maths.
- Docmentation: notes on unit formatting.

1.2, 2017 December 1

- Use serif STIX2 fonts for sans and monospace cases, when using Lua- or XeLaTeX (the style doesn't use/encourage any sans-serif text, so this shouldn't matter).
- Fix font sizes in solutions.
- Adjustments to font-handling, which appear to have fixed LuaLaTeX differences.
- Add the `stix2` option, to use the STIX2 font set.
- Make it possible to use `\rubric` and `\baserubric` within a `.clo` file. This was advertised as being possible, but it seems it had never been tested!

1.1.5, 2016 December 22

- Make `\schoolcoursecode` optional exam metadata. Rework how this is checked, and support customising this in a `.clo` file.

1.1.4, 2016 December 19

- Documentation: add notes about use of pdfpages.
- Added `[largefont]` option. Note: option `[hugefont]` has replaced `[bigfont]`; the latter is now deprecated, and may be removed in v1.2.
- Use of the `\part` macro is now supported within solutions (it produced the wrong numbers before), and there is a new `\StylePartNumber` customisation macro.

1.1.3, n/d

- Version 1.1.3 was never released

1.1.2, 2015 November 26

- Handled trailing floats at end of document (generated by packages such as `rotating`.
- `\label` within question environment now refers to the question number.
- Work around a problem when a paragraph starts with `{\bf ...}` rather than (post-1995) `\textbf{...}`.
- `\begin{questiondata}` now starts a new paragraph.
- Some documentation adjustments.

1.1.1, 2014 November 27

- Adjust `\partmarks*` behaviour; now behaves differently within display maths (addresses issue 1).
- Various documentation and release fixes.

1.1, 2014 May 3

Converted to a generic class, `exam-n`, ready for wider distribution. Available on bitbucket and at CTAN.

1.0.16, 2014 February 28

- Option mtpro2 now switches to times (this fixes a pre-existing bug exposed by the [sansserif] option).
- The [bigfont] option now works (this fixes a pre-existing bug, to do with `\subsections`, which was exposed by the addition of the [bigfont] option).
- Added the [bigfont] option
- Fixed 'shouts' warning at start (again)
- Forbid *section commands inside questions (and don't freak out)
- Rename `\questiontrailer` to `\questionpreamble` (more logical)
- Fixed mcq warnings, and 'question continued' errors.
- Renamed `\multiplechoicequestions` to more logical `\multiplechoiceanswers`
- Various (further) spacing changes
- Added `\subsection`
- Release includes 1.0.16b1 (2014 January 20); 1.0.16b2 (20 January); 1.0.16b3 (22 January); 1.0.16b4 (14 February).

1.0.15, 2014 January 19

- Fixed mcq and showsolutions, to suppress incorrect warning of missing answers.

1.0.14, 2014 January 10

- pdfpages content now appears in draft mode.
- The `[draft]` option now implies [showsolutions] (so if you want to suppress the solutions in this mode, you must now follow `[draft]` with `[noshowsolutions]`).
- Showing missing information: shouts and missing exam date/time are now highlighted.
- Fixed bug where excess `\QuestionNumberChecksOff` caused question numbers to disappear.
- Remove indent at start of question.

1.0.13, 2013 December 4

- Added a `[sansserif]` class option.
- Improved spacing and linebreaking; there are now fewer bad page-breaks.
- Added the `{mcq}` environment.
- Changed the distribution licence from GPL to LPPL.

1.0.12, 2013 November 11

- Adjustments to banner text and base rubric (consulting with Morag Casey).
- Added notes about `\includepdf` in ‘notes for authors’.
- Adjustments to the distributed example files.

1.0.11, 2013 July 18

Adjustments to question data: k_B, etc, should have roman subscripts.

1.0.10, 2013 June 27

Minor documentation and distribution fixes

1.0.9, 2013 March 22

Remove leftover debugging code (garhhh)

1.0.8, 2013 March 14

Add the `mono` and `colour` options.

1.0.7, 2013 March 14

- pdfpages is now disabled only in solutions
- Minor layout changes (exam title adjusts size for long titles)

1.0.6, 2013 March 13

- Avoid tables and figures in solutions incrementing the float counter.
- Layout changes; adjustment to default base rubric; A345 rubric change
- Some documentation changes

1.0.4-1, 2013 March 8

This is a bugfix release: it's a re-release of now-deprecated 1.0.5 minus a breaking change.

- Add `{table}` support, paralleling existing `{figure}` support (ie tables don't float, but captions work as expected).
- Blank lines after a `\begin{question}` no longer result in extra space.
- Adjust spacing and layout of front page (again); various other cosmetic changes.
- A document identifier appears at the bottom of each page, corroborating the exam the page is for (to avoid photocopier collation accidents), and giving a numeric identifier which increases with time (allowing you to identify which of two printouts is later).

1.0.4, 2013 March 6

Adjust base rubric; assorted distribution and detail fixes.

1.0.3, 2013 January 25

Added `[A2]` class option.

1.0.2, 2013 January 25

- The `pdfpages' package wasn't working when the `noshowsolutions' option was present. Fixed, by special-casing, specifically disabling the `\includepdf` command in this case.
- Adjust display of `\partmarks` (no need for extra space, since `\partmarks` is now fully in the margin).
- Adjusting the front-page layout. Again.

1.0.1, 2013 January 18

- `{figure}` now works, because it's explicitly supported (`{figure}` inside solutions could cause problems before). The contents don't float.
- Layout adjustments.
- Graphics now appear in draft mode.

1.0, 2012 December 11

This is the nominal version 1.0 release, and will be used for the 2012-13 Honours Astronomy exams (it might get further tweaks along the way, but we believe this is a complete distribution set).

- More adjustments to notes-for-authors, now showing example LaTeX results.
- Addition of template-question.tex
- Adjustments to base rubric.

1.0b5, 2012 December 3

- Fine formatting adjustments: occasional `\nobreak` and rationalisation of `\maketitle`.
- Improvements to notes-for-authors.

1.0b4, 2012 November 30

- Improve generation of PDF metadata.
- Add macro `\shout`, for highlighted `FIXME' comments.
- Add showmarktotals option.
- Permit `\partmarks` in solutions, without it adding to the marks added up for the question (at the same time, forbid having a solution within a solution).
- Various formatting adjustments.

1.0b3, 2012 November 8

- Add [A345] option.
- Make compose/draft material appear in red.
- Some packaging changes and bugfixes.

1.0b2, 2012 November 6

Mild formatting adjustments.

1.0rc1, 2012 November 2

- Significant rewrite of formatting, producing a consensus AandA/PhysHons style, and renaming some confusingly named commands.
- Consequently, the AandA.clo and PhysHons.clo options have disappeared.
- The `\constantssheet` macro has appeared, and setting this is now the principal function of per-class `.clo` files. See the new `A1.clo` and modified `P2.clo` option files.

0.17.1, 2012 September 21

Fix packaging infelicity

0.17, 2012 September 21

- Rework `solutions` environment to make it a little more robust.
- Add `\MSc` degree shorthand.
- Bugfix: continuation headers now appear if a question starts on page 1.
- Bugfix: fix wrong syntax in draft+showsolutions mode -- now works again

0.16, 2012 July 26

- Renamed the [showmarks] option to more rational [perquestionmarks] (because the option doesn't control whether per-question marks are displayed, but whether they're tracked at all). Slightly improved the documentation of this at the same time.
- Added `\lambdabar` macro
- Fix long-standing problem with continuation lines -- these should now be robust.

0.15, 2011 November 23

Avoid conflict with `ifpdf` package. Now depends on `ifpdf`.

0.14, 2010 August 6

- Fixed the problem where the question-continuation marks would be messed up by the presence of floats.
- Added P2.clo; adjust 'showing solutions' banner to avoid collision with other headers (thanks to Morag Casey for the .clo file and the report).
- Changed the name of the class to 'guexam', from potentially confusing 'exam'. Support guexam.config for forcing options (for example).

0.13-1, 2008 November 21

Make the gulogo style optional, so that question authors don't have to download and install that before they can draft a question. Also adjust the logo size.

0.13, 2008 November 11

Add university logo, and slightly rearrange the header. Add `{questiondata}` environment.

0.12-2, 2008 April 14

...keep on truckin'. Further changes to the `\partmarks*` spacing code, still largely unprincipled, but looking closer to what's required.

0.12-1, 2008 April 3

...and again. This time, I think I actually see what the problem was. Macro `\partmarks` now forces a new paragraph (it was documented to be usable at the end of a paragraph, so this is again forced, and the documentation made more explicit), this makes what I thought was the solution actually work. Which is nice. Redefined `enumerate` and `itemize` environments, to improve spacing somewhat.

0.12, 2008 April 3

Further adjustments to `\partmarks`: again, it should be more consistent without necessarily being more principled, alas.

0.11, 2008 March 30

Minor fixes: Adjust display of partmarks -- should now be more consistent; option [showsolutions] no longer defaults [{no,}pageperquestion]; add macro `\e` to format roman exponential.

0.10, 2008 January 17

Fix `\vec` when it appears in sub- or superscript position. Add `\paperident` command.

0.9, 2007 December 10

Various formatting changes. Added optional argument to `\includequestion` overriding question number.

0.8, 2007 November 25

You can now use `\usepackage` within `[compose]` mode.

0.7, 2007 November 20

Make changes to the display of the 'University of Glasgow' banner at the top: resolves some font problems. Other minor layout tweaks.

0.6, 2007 November 18

Fixed bold maths problems: `\vec` now works with greek letters, too. Support MTpro2 (mathtime maths fonts) with the new `[mtpro2]` class option. The `{solution}` environment can appear multiple times within a question. Question numbers now appear correctly in 'final' mode.

0.5, 2007 October 30

Fix collision with LaTeX internal: a `\comment` at the start of a `{question}` now works.