Skip to main content

Module patches

Module patches 

Source
Expand description

The four patch tools: page content, course structure, settings, glossary and references.

StructsΒ§

CreatedStructure πŸ”’
Ids an op created, with the blocks the server added to its new pages.
CreatedSummary πŸ”’
GlossarySummary πŸ”’
PageContentSummary πŸ”’
PatchCourseSettings
Handler of the patch_course_settings tool.
PatchCourseStructure
Handler of the patch_course_structure tool.
PatchGlossaryAndReferences
Handler of the patch_course_glossary_and_references tool.
PatchPageContent
Handler of the patch_page_content tool.
StructureSummary πŸ”’
TemplateBlock πŸ”’
A top-level block the server added to a new page: its hero section, or a chapter front page’s standard blocks.

EnumsΒ§

ReadBack πŸ”’
The read-back, or why it failed. The write is staged by then, so a failed read mustn’t turn the result into an error.

FunctionsΒ§

check_read_back πŸ”’
read_back reads the result of the write, never another state.
pair_pages πŸ”’
Puts each new page of pairings (new page id to the page it translates) into the page language group of the page it translates, which publishing joins. Refuses a page of a course outside this course’s language group, one not published yet, and a group that already has a page in this course.
pairing_refused πŸ”’
read_back_options πŸ”’
resolve_read_back πŸ”’