Skip to main content

Module instruction_lists

Module instruction_lists 

Source
Expand description

Exercise task and review instructions (own or course default’s) as block documents, edited by the engines like pages under an id of their own.

Structs§

ExerciseTextParts
Which exercise text text_documents includes.
InstructionsLocation
Where an instruction list is, for results: its exercise and the path patch_exercise takes.

Enums§

InstructionsList
One list of instruction blocks.

Statics§

MARKUP 🔒

Functions§

apply_documents
Writes documents a course-wide engine changed into after: page blocks, instruction lists and exercise names. Errors if a name would no longer be a valid one.
changed_lists
The instruction lists that differ from before, by exercise id and then the course default’s. Lists before lacks count as changed whole.
checked_name
The name as stored: trimmed, non-empty plain text on one line.
lists_of_pages
The instruction lists of the exercises on page_ids, in page and block order, and the course default’s when with_course_default or when one of those exercises uses it. Review instructions count only for exercises with reviews.
parse_blocks
The blocks of stored instructions; null is no blocks. Errors if they aren’t blocks.
review_list
The review instructions an exercise shows: its own, or the course default’s. None when it has no peer or self reviews.
text_documents
Exercise text on page_ids for the course-wide engines: instruction lists (the course default’s too when an exercise uses it; unparseable lists skipped) and names, as parts picks. Names are one paragraph each, escaped like rich text so entities read as on pages.