@jutge.org/toolkit 4.4.19 → 4.4.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/quiz-anatomy.md
CHANGED
|
@@ -39,8 +39,6 @@ You run or lint the quiz from the directory that contains `quiz.yml` (e.g. `jtk
|
|
|
39
39
|
|
|
40
40
|
`yml` files are YAML (YAML Ain't Markup Language) files. YAML is a human-readable data-serialization language; see [YAML documentation](https://yaml.org/) for more details. Also, see [YAML multiline info](https://yaml-multiline.info/) for more details on how to write multiline strings in YAML.
|
|
41
41
|
|
|
42
|
-
Many items are written in Markdown. See [Markdown documentation](https://www.markdownguide.org/) for more details. In addition, you can use a small subset of LaTeX for mathematical expressions but these have to be enclosed between `·` signs, not standard `$` signs.
|
|
43
|
-
|
|
44
42
|
## The `quiz.yml` file
|
|
45
43
|
|
|
46
44
|
The file `quiz.yml` defines the quiz root.
|
|
@@ -307,6 +305,25 @@ placeholder: 'My name is **$name** and I want to pass this course.'
|
|
|
307
305
|
|
|
308
306
|
The variable `name` can be set by an optional `open-ended.py` (or the same base name as the question file) in the same directory.
|
|
309
307
|
|
|
308
|
+
## Markdown usage
|
|
309
|
+
|
|
310
|
+
Markdown is supported in most fields. See [Markdown documentation](https://www.markdownguide.org/) for more details.
|
|
311
|
+
|
|
312
|
+
For quizzes, you may use:
|
|
313
|
+
|
|
314
|
+
- Lists (e.g. `- Item 1`, `- Item 2`, `- Item 3`)
|
|
315
|
+
- Italic text (e.g. `*italic text*`)
|
|
316
|
+
- Bold text (e.g. `**bold text**`)
|
|
317
|
+
- Underline text (e.g. `__underline text__`)
|
|
318
|
+
- Code (with backticks, e.g. `` `code` ``)
|
|
319
|
+
- Code blocks (with triple backticks and a programming language specifier)
|
|
320
|
+
|
|
321
|
+
Avoid sections, links, and tables. HTML is not supported.
|
|
322
|
+
|
|
323
|
+
In order to include images, you can use the `` syntax. The `FIG_DIR` variable will be replaced by the URL where the images are stored. PNG and SVG images are supported.
|
|
324
|
+
|
|
325
|
+
In addition, you can use a small subset of LaTeX for mathematical expressions but these have to be enclosed between `·` signs, not standard `$` signs. Take into account that math in quizzes is fragile, as it conflicts with Markdown and other features.
|
|
326
|
+
|
|
310
327
|
## Variable substitution (`.py` files)
|
|
311
328
|
|
|
312
329
|
If a question file is named `example.yml`, the toolkit looks for `example.py` in the same directory. When present:
|