Style Guide for Questions in Engineering Mechanics - mkraska/meclib GitHub Wiki
This guide summarizes conventions to be respected in STACK questions for Engineering Mechanics at THB.
The names of input and feedback nodes should be derived from the name of the model solution.
Advantages:
- In case of insertion of a new input, the naming scheme is not spoiled as in number based
Disadvantage:
- You always have to rename the default input field and prt fields either by deleting them or by using the "Tidy question tool".
If the correct solution is stored in a variable FA then the standard field specification would be:
[[input:S_FA]] [validation:S_FA]] [[feedback:FA]]
This creates the fields Input: S_FA and PRT: FA
Input: S_FA
- Model answer:
FA(can be guessed from the name of the PRT) - Insert stars: Insert stars for spaces only
- Syntax hint:
- expression (Ausdruck) for algebraic expressions
- number (Zahl) for numerical values
- number with unit (Zahl mit Einheit) for numerical values with unit
- Hint attribute: Placeholder
- Show the validation: Yes, compact
PRT: FA
- PRT Feedback style: compact
- PRT node:
- SAns:
S_FA(can be guessed from the name of the PRT) - TAns:
FA(can be guessed from the name of the PRT)
- SAns:
Set the feedback style in the PRTs to compact. This avoids spurious line breaks and saves space (important for long multi-input questions).
Don't use any HTML blocks like <p>, <div>, <ol>, <ul> in the feedback text, otherwise the text will go outside the light yellow feedback background and can easily be missed by the student.
If such structures are required, then use standard feedback. This, however will use the text from the question options for correct, partially correct and incorrect.
To display the symbols as in compact feedback, replace the texts in the question options by
<span class="correct"><span style="font-size: 1.5em; color:green;"><i class="fa fa-check"></i></span></span>
<span class="incorrect"><span style="font-size: 1.5em; color:red;"><i class="fa fa-times"></i></span></span>