Input Document Structure

Input documents are written in markdown The standard markdown formatting is supported, as well as extras such as Maths and Code blocks.

You can find more information on markdown in the Markdown Quickstart

Regardless of the template used the input files have a similar format

Header Section

The header section is used to supply document wide metadata to the template. This will usually be things like the students name, or markers details.

The header is represented by a set of key:value pairs surrounded by triple dashses

---
mod_title: Coursework Demo
mod_code: NCC-1701
cw: "CW1: Report"
student: A. Student
sid: Stu-001
---

In some templates the header can also include the marks awarded (this is usually) where marks and the required feedback section differ.

Content Section

The content section includes the feedback for the student. Here we have standard markdown blocks.

The first level headings (prefixed with a single hash), represent the different sections in the report. Depending on the template headings may be required, as they map across to sections in the template.

# First Task [10/20]

We can then provide whatever feedback we want. For example

 - On the whole a well written report
 - Consider making use of in-text citations and correct referencing

# Second Task [5/20]

Text that will go into the "Second Task" section of the report.

You can also supply the marks here, using by including them in square brackets after the heading. Both marks awarded [10] or Marks From [10 / 10] are accepted.

Note

While the renderer will automatically summarise the marks, there is no sanity checking here. It is up to you to ensure the marks are correct.