Template syntax¶
This template extends TeXSmith with a few exam-specific Markdown helpers.
Headings¶
Because exams are structured as questions and parts, the usual Markdown
headings map to question, part, and subpart entries in the LATEX output.
In Markdown, you just use headings as usual. Example:
# Exam Title
## Question 1
### Part 1.1
#### Subpart 1.1.1
### Part 1.2
## Question 2
Often you need a part or subpart with no visible title. Use - as the heading
text to keep the structure while hiding the title:
## Question
### -
Text for part 1
### -
Text for part 2
#### -
Text for subpart 1 of part 2
Info
The - label resembles a list marker and keeps Markdown headings
non-empty, so they still parse correctly.
If you need plain LATEX sectioning (instead of exam questions/parts), mark a
heading with {heading=true}. The marked heading and its subheadings are
rendered with TeXSmith's standard \section, \subsection, etc.
## Context {heading=true}
### Model
### Variables
Points and answer lines¶
Attach an attribute block in braces to a heading to set the points awarded for a question or part and, optionally, a short expected answer:
## Capitals { points=2 answer="Bern" }
What is the capital of Switzerland?
points=sets the marks for the question or part. Point display is controlled globally by theexam.pointssetting; per-question values are only shown when it is enabled.answer=provides a short answer. It is rendered as an answer line on the student copy and filled in on the answer key.
The attribute block works on any heading level, so questions, parts, and
subparts can all carry points and answers. It combines with the - empty title:
### - { points=2 answer="42" }
What is the answer to the ultimate question?
Any text after the closing brace becomes the heading title:
### - { points=2 } Warm-up
A short introductory question.
Answer values may be wrapped in straight quotes, single quotes, French
guillemets «…», curly quotes, or backticks; the surrounding pair is stripped.
Quotes are only required when the value contains spaces — answer="Mont Blanc",
answer='Bern', answer=«oui», and answer=42 are all valid.
Info
Surrounding whitespace and quotes are trimmed. An empty answer
(answer="" or whitespace only) produces no answer line, whereas
answer="0" shows 0. Unrecognized attributes are ignored silently, so
watch for typos such as ponts=.
Multiple choice¶
Markdown (and TeXSmith) supports task lists like - [ ]. With this template,
task list items are rendered as multiple-choice answers.
## Volcanoes
Which volcanoes are located in Italy? (multiple answers)
- [x] Etna
- [ ] Krakatoa
- [x] Vesuvius
- [ ] Mauna Loa
- [ ] Fuji
- [x] Stromboli
- [ ] Kilauea
Checked entries are treated as correct answers. They appear only in the answer key, not on the student copy.
You do not need to manage layout manually: the columen LATEX package arranges answers into columns based on available space.
Fill-in blanks¶
Inline fill-ins turn into exam-style answer blanks:
The capital of Switzerland is [Bern]{w=30}.
The optional attribute block lets you specify the blank width. By default, the
width is computed from the answer text. If you want to avoid revealing the
expected length, set an explicit width (w=1cm, w=1in, or similar). Both
width and w are accepted.
In the front matter you can configure exam.char-width-scale to scale the
automatic width when no explicit size is provided.
Solution blocks¶
Use admonitions to provide solutions and mark answers.
!!! solution
Solution content appears only in the answer key
For short answers, you can request lined space. In the answer key the lines are replaced by the solution text.
!!! solution { lines=3 }
Solution text...
Use lines=fill instead of a number to stretch the answer space to the bottom
of the page. The line style (dotted, lined, or boxed) follows the style.text
setting.
Sometimes you need a grid instead of dotted lines.
## -
Draw an equilateral triangle
!!! solution { grid=3cm }
![Triangle]{triangle.svg}
Or you can reserve an empty box for drawings or other free-form answers.
## -
Draw a sheep:
!!! solution { box=5cm }
Here is an example of the expected drawing:
![Sheep]{sheep.svg}
The result should resemble a sheep with wool and four legs.
A single value makes a square box; use box=WxH (for example box=8cmx4cm) to
reserve a rectangle.