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.
Achim D. Brucker c5413107af Added Isabelle/DOF logo. 6 hours ago
.ci Remove old output directories. 1 day ago
examples Added Isabelle/DOF logo. 6 hours ago
src Updted default layout for technical reports. 1 day ago
.gitattributes Avoid line ending conversions for shell scripts, 7 months ago
.gitignore Ignore local afp installation directory (.afp). 6 months ago
CHANGELOG.md Initial commit. 1 month ago
CITATION Updated bibliographic information. 6 months ago
LICENSE Updated copyright information. 1 month ago
README.md Improved markdown. 1 day ago
ROOTS Large directory restructuring. 2 days ago
install Improved help message. 1 day ago

README.md

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.

Prerequisites

Isabelle/DOF requires Isabelle 2019. Please download the Isabelle 2019 distribution for your operating system from the Isabelle website.

Installation

Quick Installation Guide

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 -i command line argument of the install script:

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

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

foo@bar:~$ ./install -h

What The Installer Actually Does

The installer will

  • apply a patch to Isabelle that is necessary to use Isabelle/DOF. If this patch installations fails, you need to manually replace the file Isabelle2019/src/Pure/Thy/thy_output.ML in the Isabelle distribution with the file src/patches/thy_output.ML from the
    Isabelle/DOF distribution:

    cp patches/thy_output.ML `isabelle getenv -b ISABELLE_HOME`/src/Pure/Thy/
    
  • install required entries from the AFP. If this installations fails, you need to manually install the AFP for Isabelle 2019 as follows: Download the AFP for Isabelle 2019 and follow the instructions for installing the AFP as Isabelle component. If you have extracted the AFP archive into the directory to /home/myself/afp, you should run the following command to make the AFP session ROOTS available to Isabelle:

    echo "/home/myself/afp/thys" >> ~/.isabelle/Isabelle2019/ROOTS
    
  • install the Isabelle/DOF-plugin into the Isabelle user directory (the exact location depends on the Isabelle version).

  • check that the AFP has been installed successfully.

Usage

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 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 (use -h to obtain a list of all installed setups):

foo@bar:~$ isabelle DOF_mkroot -h

Usage: isabelle DOF_mkroot [OPTIONS] [DIR]

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

  Prepare session root DIR (default: current directory).

For example,

foo@bar:~$ isabelle DOF_mkroot -o scholarly_paper -t lncs

creates a setup using the scholarly_paper ontology and Springer’s LNCS LaTeX class as document class. Note that the generated setup does not include the actual llncs.cls file. This is due to license restrictions. You need to obtain the file from Springer’s website and either copy it in you texmf directory or the root folder. In the latter case, you also need to add it in the ROOT file as dependency.

Team

Main contacts:

Contributors

  • Idir Ait-Sadoune
  • Paolo Crisafulli
  • Chantal Keller

License

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

SPDX-License-Identifier: BSD-2-Clause

Publications

Master Repository

The master git repository for this project is hosted https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF.