lms.djangoapps.staticbook package#
Submodules#
lms.djangoapps.staticbook.views module#
Views for serving static textbooks.
- lms.djangoapps.staticbook.views.html_index(request, course_id, book_index, chapter=None)#
Display an HTML textbook.
- course_id: course for which to display text. The course should have
“html_textbooks” property defined.
book index: zero-based index of which HTML textbook to display.
- chapter: (optional) one-based index into the chapter array of textbook HTML files to display.
Defaults to first chapter. Specifying this assumes that there are separate HTML files for each chapter in a textbook.
- lms.djangoapps.staticbook.views.index(request, course_id, book_index, page=None)#
Serve static image-based textbooks.
- lms.djangoapps.staticbook.views.pdf_index(request, course_id, book_index, chapter=None, page=None)#
Display a PDF textbook.
- course_id: course for which to display text. The course should have
“pdf_textbooks” property defined.
book index: zero-based index of which PDF textbook to display.
- chapter: (optional) one-based index into the chapter array of textbook PDFs to display.
Defaults to first chapter. Specifying this assumes that there are separate PDFs for each chapter in a textbook.
page: (optional) one-based page number to display within the PDF. Defaults to first page.
- lms.djangoapps.staticbook.views.remap_static_url(original_url, course)#
Remap a URL in the ways the course requires.