Expand description
The course tree the structure tools read and edit, and the paths that address it.
Structs§
- Course
Structure - The course tree as agents read and edit it. Children arrays are in display order.
- Loc 🔒
- Where an entity is: its list and its index there.
- Structure
Chapter - A chapter and its pages in order.
- Structure
Module - A module and its chapters in order.
- Structure
Page - A page’s own fields with counts of its content; the blocks are the page tool’s.
- Structure
Path 🔒 - A structure path split into its parts, before its ids and labels are resolved:
/<root>/<child>/….
Enums§
- Entity 🔒
- Entity
Ref 🔒 - A module, chapter or page of a
CourseStructure. Serializes as the entity itself. - Kind 🔒
- What a course tree entity is.
- ListRef 🔒
- One of the course tree’s ordered lists.
Constants§
- RENDERED_
KEYS 🔒 - Keys a read adds to an entity besides its fields. Writes ignore them, so an entity read back can be written again.
Functions§
- entity_
ids 🔒 - parse_
structure_ 🔒path - Splits a structure path into its parts;
Nonewhen it doesn’t start with/.