Various support files (makefile templates, makefile includes, configuration scripts) for building course handbooks

.vscode Fixed unresolved imports 2 years ago
calendar Finised refactoring error reporting 10 months ago
configuration Added check for sassc as alternative to sass 2 years ago
make-includes Added “handout” as a target alias for “combined” 1 year ago
makefile-templates • Moved commonly-used LaTeX flags into central infrastructure. 4 years ago Updated README 2 years ago

Handbook related infrastructure

This repository contains various tools and infrastructure related to the production of teaching materials. The contents include:

  • Scripts to generate dates for lectures, etc.
  • Autoconf configuration scripts for required tools.
  • Various include files and templates for make.

Required environment variables


This variable specifies the path to the top level of the teaching shared directory hierarchy, wherever you happen to have put it (e.g., on my machine this is set to /Users/nstanger/Documents/Teaching/Shared).


This variable specifies the path to the top level directory for all papers taught, i.e., the directory that contains the individual paper directory hierarchies. This assumes that you have all your current paper directories contained within a single hierarchy. If you don’t, you’re in trouble ☺. For example, on my machine this is set to /Users/nstanger/Documents/Teaching (which contains symbolic links to the current directories for INFO212, INFO321, ...).


This variable specifies the path to the top level directory on the web/deployment server, under which the files for this paper will be installed (that is, the directory that contains the individual paper directory hierarchies). On my machine this is set to /Volumes/SHARED/Teaching/DatabaseCourses/Web_Deployment, as the share gets mounted under /Volumes/SHARED. Under Windows this will be a UNC path which may require munging.


This variable specifies the path to the top level directory of the Web server (e.g. /mnt/info-nts-12/dbcourses) being used to serve dynamic content (e.g. PHP scripts). Currently this is limited to the timetable.php script.


This variable specifies your preferred XSLT processor. Currently the valid options are saxon for SAXON 6.5.x, saxon-b for SAXON-B, xalan-c for the C++ implementation of Xalan and xalan-j for the Java implementation of Xalan (weirdly, the latter two have different command line options). For example, on my machine this is set to saxon-b (this is also the recommended setting, as the others don’t support XSLT 2.0 as well, if at all).


Once the variables above have been defined:

cd configuration
make                # assumes GNU make

Check for missing items in the configure script output. Some will raise a fatal error if missing, some won’t. Install any tools that are missing. Some will require a bit more work, especially the XML-related tools like the entity resolver. (This latter requires catalog and properties files to be set up—see the instructions in the XML repository.)

If all looks OK, then everything should just work from this point on! (fingers crossed)

Including content fragments (XML)

Content fragment files can be included using XML includes. Source files are processed by xmllint (a utility that comes with libxml) to produce an intermediate XML file that contains all of the included fragments. This is then processed normally. Paths in XML includes should always be relative to the current directory, since we can’t predict where in the file system hierarchy the source will be.

A typical include might looks something like this:

<xi:include href="../../../Tutorials/Foo/Bar.xml" xpointer="xpointer(/document/*)" />

All fragments are represented by an XML document of class “fragment”. The outermost <document> element is stripped off by the XPath expression in the xpointer attribute.