RSE 0004

A Redesigned Progress tracking system

• This should be driven from the browser and book source in two primary ways:

  1. Metadata information
  2. Javascript

• Each page (subchapter) must have a metadata tag to indicate a unique identifier for the page.

• Each page must have a tag that contains the identifier of its parent

• Each page should have a metadata tag to indicate prerequisites

• Each page should have a metadata tag to indicate prev -- The page before it in the sequence of the book

• Each page should have a metadata tag to indicate next -- The page that comes after it

Marking a Page as Complete

• Create a new component for a completion button. Make it explicit in the source for each page that we want to show this button. This gives us control over the placement.

Showing Progress in the TOC

• Currently we hack the table of contents generated by Sphinx adding in our own symbols.
  This seems risky in that if a new version of sphinx changes the table of contents somehow our code will break.
• We should consider whether generating our own TOC would be easy enough

Instructor Dashboard Report