BookML is an open-source software tool designed to convert LaTeX documents into accessible digital learning materials. Created and maintained for mathematics lecturers at the University of Leeds, it helps educators transform technical documents, lecture notes, and mathematical content into formats suitable for online learning.
LaTeX is widely used in mathematics, physics, engineering, and other academic disciplines because it provides precise control over equations, symbols, references, and document structure. However, traditional LaTeX documents are often distributed as PDFs, which can present accessibility and usability challenges for students using mobile devices or assistive technologies.
BookML addresses this challenge by automating the conversion of LaTeX source files into modern HTML content and other distribution formats. It uses LaTeXML to process LaTeX documents and supports the creation of PDF files and SCORM packages for learning management systems.
The tool is particularly relevant to higher education, where lecturers need to distribute complex mathematical material in formats that are easier to navigate, access, and integrate into digital learning environments.
How Does BookML Work?
BookML uses LaTeXML as its underlying conversion engine. LaTeXML processes LaTeX source files and converts their content into structured representations that can be transformed into HTML and other outputs.
BookML builds on this functionality by providing a workflow for producing modern, book-style HTML content, alongside PDF documents and packaged learning materials.
The process begins with a lecturer’s existing LaTeX files. Rather than manually recreating the material in a web publishing platform, the lecturer can use BookML to automate much of the conversion and compilation process.
The resulting content can preserve important elements of academic documents, including mathematical expressions, headings, references, illustrations, and structured sections, depending on the source document and the compatibility of the packages it uses.
BookML also uses GNU Make to manage compilation tasks and dependencies. When source files change, the build system can determine which outputs need to be regenerated. This helps reduce repetitive work when maintaining lecture notes or other educational resources.
Although the workflow is automated, some LaTeX packages and complex document constructions may require adjustments. Reviewing the converted material remains important to ensure that equations, diagrams, references, and page layouts behave as intended.
Key Features of BookML
BookML combines document conversion, accessible web publishing, and learning-platform integration in one workflow.
Automated LaTeX Conversion
One of BookML’s principal advantages is its ability to automate the conversion of LaTeX source files into digital outputs.
Mathematics lecturers often maintain extensive collections of lecture notes, worked examples, proofs, and exercise sheets. Recreating these materials manually in HTML can be time-consuming and may introduce inconsistencies between the original documents and their online versions.
BookML helps reduce this workload by using LaTeXML to process existing LaTeX source files. Its build system can generate HTML and other outputs from the same source material, helping lecturers maintain a consistent set of resources.
Automation is especially useful when teaching materials change regularly. Once a document has been configured for the workflow, updates can be compiled without manually rebuilding every output format.
Accessible and Mobile-Friendly HTML
BookML produces HTML content with a modern, responsive design intended to make educational resources easier to use on different screen sizes.
HTML can offer important advantages over PDF-only distribution. Students can view content directly in a browser, navigate sections using web-based structures, and use browser accessibility features and assistive technologies.
BookML’s design is based on the bookdown-style GitBook presentation, adapted to support accessibility and readability. Its documented features include font selection and dark-mode support.
The project states that its output has been designed to meet Web Content Accessibility Guidelines (WCAG) 2.1 Level AA. However, accessibility depends on the source material and the resulting output, so lecturers should still test their documents, particularly mathematical expressions, figures, diagrams, and alternative text.
This distinction is important: automated conversion can provide a strong foundation for accessibility, but it cannot guarantee that every document will be fully accessible without review.
PDF Document Generation
BookML also supports PDF output. PDFs remain useful in academic environments because students may want to download lecture notes, print materials, annotate documents, or study offline.
By generating PDF and HTML versions from a shared LaTeX source, BookML can help educators maintain consistency between printed and online materials.
The two formats serve different purposes. HTML is generally better suited to responsive browsing and many accessibility workflows, while PDF can be convenient for downloading and printing.
Providing both formats gives students more flexibility in how they access course content.
SCORM Package Creation
Another important feature is support for SCORM, which stands for Sharable Content Object Reference Model.
SCORM is a collection of technical standards used to package digital learning content for compatible learning management systems. It provides a recognised structure for delivering learning materials within supported educational platforms.
BookML can package converted HTML content as SCORM files, allowing lecturers to distribute resources through learning management systems without having to create the entire package manually.
At the University of Leeds, the tool is used in workflows involving Minerva, the university’s learning management system. The generated SCORM packages can be uploaded through the platform’s supported content-upload process.
This functionality is valuable for institutions that want to integrate existing LaTeX materials into their digital teaching environments.
Overleaf and GitHub Integration
BookML supports workflows involving Overleaf and GitHub, making it easier for lecturers to maintain and publish teaching materials.
Overleaf is an online LaTeX editor that allows users to write and collaborate on LaTeX documents. GitHub provides version control and a platform for storing and managing source code and project files.
BookML can be integrated into an Overleaf project connected to GitHub, or used directly with files maintained in a GitHub repository. Its documentation describes a workflow that can automate compilation through GitHub Actions.
This integration can be useful for teaching teams that collaborate on lecture notes or maintain resources across multiple academic terms. Changes to the source files can be incorporated into a repeatable publishing process rather than requiring every output to be prepared independently.
Why Is BookML Useful for Mathematics Education?
Mathematical content presents particular challenges for digital publishing. Documents frequently contain complex equations, specialised notation, diagrams, matrices, proofs, and references that need to retain their meaning when converted into another format.
A conventional document-conversion process may struggle with these elements or represent mathematical expressions in ways that are difficult for assistive technologies to interpret.
BookML is designed specifically around a LaTeX-based workflow, making it relevant to lecturers who already use LaTeX to prepare mathematical teaching materials.
Its HTML output can make course notes easier to navigate and view on mobile devices. SCORM support helps educators distribute resources through compatible learning management systems, while PDF generation provides a familiar downloadable format.
The workflow can also reduce duplication. Instead of maintaining separate documents for print, web publishing, and online learning platforms, lecturers can work primarily from their LaTeX source and generate the required outputs.
These capabilities can be particularly valuable for large collections of lecture notes, where consistency and maintainability matter as much as the appearance of an individual document.
How to Get Started with BookML
Getting started with BookML requires more than copying the project files into a directory. The software relies on LaTeXML and several supporting tools, so users should first review the official installation documentation.
A typical workflow includes the following steps.
1. Prepare the LaTeX source files. Organise the lecture notes or other educational documents that need to be converted. Check the source files for dependencies, graphics, and custom LaTeX packages.
2. Install the required software. Follow the BookML documentation to install LaTeXML and the relevant supporting tools for the operating system being used.
3. Configure the BookML files. Add the required BookML project files and build configuration to the document directory. The exact setup depends on the intended workflow.
4. Compile the documents. Use the provided GNU Make workflow to generate the selected outputs. BookML supports HTML generation, PDF production, and SCORM packaging.
5. Review the results. Check equations, diagrams, hyperlinks, references, and the layout of the converted document. Test the HTML using a browser and, where appropriate, a screen reader or accessibility evaluation tool.
6. Publish the material. Distribute the HTML or PDF files through the desired platform, or upload the SCORM package to a compatible learning management system.
The official BookML documentation provides more detailed installation instructions, examples, and troubleshooting guidance.
Limitations and Considerations
Although BookML automates much of the publishing process, its effectiveness depends on the structure of the original LaTeX document and the tools available in the conversion environment.
Some specialised packages, custom macros, or complex diagrams may not convert exactly as expected. Documents containing TikZ illustrations, animations, or unusual formatting may need additional configuration.
Accessibility also requires careful review. A document can be converted into HTML without every mathematical expression, diagram, or image automatically receiving an appropriate accessible representation. Adding alternative text and testing the final output are important steps.
Users should also account for software dependencies and installation requirements. BookML relies on LaTeXML and other tools for tasks such as document compilation and image conversion. These dependencies must be installed and configured correctly.
Despite these considerations, BookML offers a structured approach to producing multiple digital formats from LaTeX source files, reducing the amount of manual work involved in preparing educational materials for online distribution.
Conclusion
BookML is an open-source publishing tool developed for mathematics lecturers at the University of Leeds. By combining LaTeXML-based conversion, responsive HTML output, PDF generation, and SCORM packaging, it helps educators transform LaTeX documents into digital learning resources.
Its accessibility-focused design, support for Overleaf and GitHub workflows, and integration with learning management systems make it particularly relevant to higher education.
While converted documents still require testing and occasional adjustments, BookML provides a practical way to maintain existing LaTeX materials while making them available in formats suited to modern digital learning environments.