2.3 Using BookML

Now that BookML is installed, use the command prompt from the folder "template" and type

gmake

[Note: commands to compile from a makefile vary by operating system. If using a non-windows PC, check your operating system’s documentation.]

You may be asked to install new packages in your LaTeX compiler — do this when prompted to.

After a few minutes, you will have compiled the template for BookML! This file contains a short guide on using BookML and instructions on how to use it with Overleaf.

You can use BookML to compile any .tex file that you have. For BookML to work, you will need to include all BookML related non .tex files in your folder. Otherwise, your computer will try to read a file which is missing and cause an error.

2.3.1 Formatting your files for BookML

When using BookML, you should have your .tex file in the root folder. This means that your notes need to be in the same folder on your computer as the makefile (GNUmakefile) and the bookml folder.

Similarly, any imported files (i.e. images, bibliographies) must also be in the root folder. Note that BookML only supports the package natbib for referencing.

For correct BookML output, you will need to include the following files along with your MATHXXX.tex. The first of these files is MATHXXX-sans.tex. It should read

\renewcommand{\familydefault}{\sfdefault}
\input{MATHXXX.tex}

The second file is titled MATHXXX-sans-large.tex. It should read

\def\bmlCrop{}
\PassOptionsToPackage{b5,center,noinfo}{crop}
\input{template-sans.tex}

By including these .tex files, BookML will produce a sans-serif font .pdf and a large print sans-serif font .pdf. The first helps students with dyslexia, and the second can help some visually impaired students.

BookML will treat every .tex file in the root folder with the command \documentclass the same way MATHXXX is treated. Any additional LaTeX files you produce should have their own versions of MATHXXX-sans.tex and MATHXXX-sans-large.tex. If you only wish to compile your lecture notes, there are two solutions

  • •
    ​

    Remove the other LaTeX files from the folder

  • •
    ​

    Use gmake SCORM.MATHXXX.zip rather than just gmake.

2.3.2 If no SCORM is produced

If no SCORM file is produced, you can ask BookML to generate a new SCORM file by using the command

gmake SCORM.filename.zip

Similarly, you can ask BookML to generate any one file, rather than everything.