Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle. Isabelle/DOF allows for both conventional typesetting as well as formal development.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Simon Foster 4cba4bbdc8 Added some additional non-SI units 1 week ago
.ci Fixed manual generation. 7 months ago
examples various changes of the DOF-core interface: read_cid. Preparations for type_synonyms for cids. (unfinished). Updated scholarly_paper onto 1 month ago
src Added some additional non-SI units 1 week ago
.config Added version independent DOI. 7 months ago
.gitattributes Avoid line ending conversions for shell scripts, 1 year ago
.gitignore New command "reflect_ML_exports" for loading ML exported code into Isabelle's ML environment using the Isabelle's virtual file system. 7 months ago Re-set version to UNRELEASED. 7 months ago
CITATION Updated bibliographic information. 1 year ago
LICENSE Applied renaming: Paris-Sud to Paris-Saclay. 8 months ago Mentioned Isabelle/DOF manual in the first paragraph (instead of only in the release notes). 3 months ago
ROOTS Large directory restructuring. 8 months ago
install Added version independent DOI. 7 months ago

Isabelle/DOF: Document Preparation Setup

Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle. Isabelle/DOF allows for both conventional typesetting as well as formal development. The manual for Isabelle/DOF 1.0.0/Isabelle2019 is available online.

Running Isabelle/DOF using Docker

As an alternative to installing Isabelle/DOF locally, the latest official release Isabelle/DOF is also available on Docker Hub. Thus, if you have Docker installed and your installation of Docker supports X11 application, you can start Isabelle/DOF as follows:

foo@bar:~$ docker run -ti --rm -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \ 
           logicalhacking/isabelle_dof-1.0.0_isabelle2019 isabelle jedit


Isabelle/DOF has two major pre-requisites:

  • Isabelle: Isabelle/DOF requires Isabelle 2019. Please download the Isabelle 2019 distribution for your operating system from the Isabelle website.
  • LaTeX: Isabelle/DOF requires a modern pdfTeX-engine supporting the \expanded{}-primitive. This is, for example, included in the TeXLive 2019 (or later) distribution. Please follow the TeXLive installation instructions for installing TeXLive.


In most case, the DOF-plugin can be installed as follows:

foo@bar:~$ ./install

If a specific Isabelle version should be used (i.e., not the default one), the full path to the isabelle command needs to be passed as using the --isabelle command line argument of the install script:

foo@bar:~$ ./install --isabelle /usr/local/Isabelle2019/bin/isabelle

For further command line options of the installer, please use the built-in help:

foo@bar:~$ ./install --help

A final step for the installation is:

foo@bar:~$ isabelle build -D .

This will compile Isabelle/DOF and run the example suite.


Opening an Example

If you want to work with or extend one of the examples, e.g., you can open it similar to any standard Isabelle theory:

isabelle jedit -d . -l Isabelle_DOF examples/scholarly_paper/2018_cicm/IsaDofApplications.thy

This will open an example of a scientific paper using the pre-compiled session Isabelle_DOF, i.e., you will not be able to edit the ontology definitions. If you want to edit the ontology definition, just open the theory file with the default HOL session:

isabelle jedit -d . -l HOL examples/scholarly_paper/2018_cicm/IsaDofApplications.thy

While this gives you more flexibility, it might “clutter” your editing experience, as a lot of internal theories are loaded into Isabelle’s editor.

Creating a New Project

The DOF-plugin provides an alternative to Isabelle’s mkroot command. Isabelle projects that use DOF need to be created using

foo@bar:~$ isabelle mkroot_DOF

The mkroot_DOF command takes the same parameter as the standard mkroot command of Isabelle. Thereafter, the normal Isabelle command for building documents can be used.

Using the -o option, different ontology setups can be selected and using the -t option, different LaTeX setups can be selected. For example,

foo@bar:~$ isabelle mkroot_DOF -o scholarly_paper -t scrartcl

creates a setup using the scholarly_paper ontology and the article class from the KOMA-Script bundle.

The help (option -h) show a list of all supported ontologies and document templates:

foo@bar:~$ isabelle mkroot_DOF -h

Usage: isabelle mkroot_DOF [OPTIONS] [DIR]

  Options are:
    -h           print this help text and exit
    -n NAME      alternative session name (default: DIR base name)
    -o ONTOLOGY  (default: scholarly_paper)
       Available ontologies:
       * cenelec_50128
       * mathex
       * scholarly_paper
    -t TEMPLATE   (default: scrartcl)
       Available document templates:
       * lncs
       * scrartcl
       * scrreprt
       * scrreprt-modern

  Prepare session root DIR (default: current directory).


For releases, signed archives including a PDF version of the Isabelle/DOF manual are are available:


Main contacts:


  • Idir Ait-Sadoune
  • Paolo Crisafulli
  • Chantal Keller


This project is licensed under a 2-clause BSD license.

SPDX-License-Identifier: BSD-2-Clause


Master Repository

The master git repository for this project is hosted