Isabelle_DOF/README_DEVELOPMENT.md

Isabelle/DOF: Instructions on Using the Development Version

Pre-requisites

Isabelle/DOF has three major prerequisites:

• Isabelle: Isabelle/DOF requires Isabelle 2023. Please download the Isabelle 2023 distribution for your operating system from the Isabelle website.
• AFP: Isabelle/DOF requires several entries from the Archive of Formal Proofs (AFP).
• LaTeX: Isabelle/DOF requires a modern LaTeX installation, i.e., at least TeX Live 2022 with all available updates applied.

Note on Installing the AFP

Depending on your personal preference, there are two alternative approaches to providing the necessary AFP entries for the latest official release of Isabelle. Both have their own advantages and disadvantages.

Variant 1: Installing the Complete AFP

If you use the AFP with other Isabelle projects, you might want to install the complete AFP. For this, please follow the instructions given at https://www.isa-afp.org/using.html.

For the development version of Isabelle, installing the complete AFP by cloning the afp-devel repository is the only supported installation method.

Variant 2: Installing Only the Required AFP Entries

The provided script install-afp tries to install the AFP entries that are required by Isabelle/DOF. Note that this script will only work, if the AFP is not registered as an Isabelle component. It can be executed as follows:

foo@bar:~$ isabelle env install-afp

Note that this option is not supported for the development version of Isabelle.

Installation

Isabelle/DOF is provided as an Isabelle component. After installing the prerequisites, change into the directory containing Isabelle/DOF (this should be the directory containing this README.md file) and execute (if you executed this command already during the installation of the prerequisites, you can skip it now):

foo@bar:~$ isabelle components -u .

The final step for the installation is:

foo@bar:~$ isabelle build -D . -x Isabelle_DOF-Proofs -x HOL-Proofs

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

Usage

Overall, the use of the development version follows the description available for the AFP version. Hence, for details please consult the Isabelle/DOF manual.

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 dof_mkroot

The dof_mkroot 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 dof_mkroot -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 dof_mkroot -h

Usage: isabelle dof_mkroot [OPTIONS] [DIRECTORY]

  Options are:
    -I           init Mercurial repository and add generated files
    -h           print help
    -n NAME      alternative session name (default: directory base name)
    -o NAMES     list of ontologies, separated by blanks
                 (default: "technical_report scholarly_paper")
    -q           quiet mode: less verbosity
    -t NAME      template (default: "scrreprt-modern")

  Create session root directory for Isabelle/DOF (default: current directory).