Generic Feedback Template
These are instructions for the Generic feedback Template. It should be flexible enough to give feedback for most modules, although you may want to do some customisation
Features included are
- Markdown Rendering based on section headings
- Awarded Marks summary.
This template is used by Default, if no other options are supplied for example
$ remarkable input.md
Header Section
The header section contains has the following sections
---
mod_title: Coursework Demo
mod_code: NCC-1701
cw: "CW1: Report"
student: A. Student
sid: Stu-001
---
- mod_title: The Module Title
- mod_code: Module Code (optional)
- cw: Coursework title.
- student: Student Name
- sid: Student Id (optional)
Note
If we have characters like the : we need to
enclose the string in quotes, othewise the YAML parser gets confused.
Content Section
"Sections" of feedback are represented by a top level heading. You can include an optional mark for that section. Total Marks will be calculated and shown at the end of the report.
# Section Heading [ 10/20 ]
Markdown content goes here....
When rendering the report, the parser will keep track of the order of section headings.
Example Output
An Example of the output for this input file can be found [here]
We compile with
$ remarkable generic.md
[MAIN] - INFO - Converting File
[MAIN] - INFO - Done
Input file
---
mod_title: Coursework Demo
mod_code: NCC-1701
cw: "CW1: Report"
student: A. Student
sid: Stu-001
---
# 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]
> Here we use a blockquote to represent generic feedback
> In this section Marks Awarded for:
>
> - Completing the code example
> - Doing other things
We will also use a code block.
```.python
def theTask(x, y):
return x + y
```