Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle. Isabelle/DOF allows for both conventional typesetting as well as formal development.
Go to file
2026-11-13 14:47:57 +01:00
.bin Upgrade to Isabelle 2025-1. 2025-12-20 23:24:54 +00:00
.woodpecker Revert "Test with Isabelle 2023." - switching back to Isabelle nightly. 2023-09-14 06:31:12 +01:00
etc Fixed scala build path. 2024-05-27 12:22:41 +01:00
examples/technical_report/UserManual Move framework shortcuts and macros from the manual into the COL 2026-10-09 15:37:24 +02:00
Isabelle_DOF-Example-I Release 2026: grid table and macros (isabelle, eg, etc, center) in the examples; gridtbl: symbols in cells; Isa_COL: isabelle shortcut; README, README_DEVELOPMENT, CITATION updated 2026-10-23 17:57:02 +02:00
Isabelle_DOF-Example-II Example-II: citations as cartouche antiquotations; dof_mkroot: Scala explicit nulls 2026-11-13 12:58:36 +01:00
Isabelle_DOF-Example-III Example-III: no link to the HOL-CSP developer version; HOL-CSP is taken from the AFP 2026-11-13 11:22:40 +01:00
Isabelle_DOF-Examples-Extra TR_MyCommentedIsabelle: prose and quoted code updated for Isabelle 2026; citations as cartouche antiquotations 2026-11-13 14:04:46 +01:00
Isabelle_DOF-Examples-Templates Added svglov3.clo. 2024-04-02 08:33:55 +01:00
Isabelle_DOF-Ontologies Exercise_Example: a worked exercise sheet in three variants (student, professor, examiner) 2026-10-23 18:54:03 +02:00
Isabelle_DOF-Proofs Update to latest development version of Isabelle. 2025-03-13 14:45:00 +00:00
Isabelle_DOF-Scaffold Initial commit. 2025-03-12 09:18:43 +00:00
Isabelle_DOF-Unit-Tests Examples-Extra/Templates ported to Isabelle 2026; attribute names may be keywords (options); test 2026-10-23 18:34:53 +02:00
scala Example-II: citations as cartouche antiquotations; dof_mkroot: Scala explicit nulls 2026-11-13 12:58:36 +01:00
upstream_afp Version parameters: DOF.version Isabelle2026, release 1, afp-2026-branch-default; latest_version 2026 - 1.6 2026-11-13 13:53:13 +01:00
.envrc Update. 2026-02-01 18:44:57 +00:00
.gitattributes Initial commit. 2022-07-07 22:43:25 +01:00
.gitignore Exercise ontology: sheets, exercises, parts, tasks, subtasks, solutions and remarks, with audiences (student, professor, examiner), sheet categories, exercise_role command and DOF-Exercise.sty; do not track the examples 2026-10-22 05:18:37 +02:00
CITATION Release 2026: grid table and macros (isabelle, eg, etc, center) in the examples; gridtbl: symbols in cells; Isa_COL: isabelle shortcut; README, README_DEVELOPMENT, CITATION updated 2026-10-23 17:57:02 +02:00
install-afp Added new dependency: Metalogic_ProofChecker 2023-03-01 10:19:29 +00:00
LICENSE Fixed file attributes. 2022-04-18 09:44:44 +01:00
NEWS README, NEWS: release tag Isabelle_DOF_2026; Example III and Document panel in the usage section 2026-11-13 14:47:57 +01:00
README_DEVELOPMENT.md Release 2026: grid table and macros (isabelle, eg, etc, center) in the examples; gridtbl: symbols in cells; Isa_COL: isabelle shortcut; README, README_DEVELOPMENT, CITATION updated 2026-10-23 17:57:02 +02:00
README.md README, NEWS: release tag Isabelle_DOF_2026; Example III and Document panel in the usage section 2026-11-13 14:47:57 +01:00

Isabelle/DOF: Document Preparation Setup

Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle. Isabelle/DOF allows for both conventional typesetting and formal development.

Pre-requisites

Isabelle/DOF has two major prerequisites:

Installation

Isabelle/DOF is available as part of the Archive of Formal Proofs (AFP). This is the most convenient way to install Isabelle/DOF for the latest official release of Isabelle.

Installation from the Archive of Formal Proofs (AFP)

Isabelle/DOF is available in the AFP. Hence, for using Isabelle/DOF with the latest official released version of Isabelle, please download the Isabelle distribution for your operating system from the Isabelle website. Furthermore, please install the AFP following the instructions given at https://www.isa-afp.org/help.html.

Isabelle/DOF is provided as one AFP entry:

  • Isabelle_DOF: This entry contains the Isabelle/DOF system itself, including the Isabelle/DOF manual.

Installation of Add-On Packages and Examples

Add-ons to Isabelle/DOF, in particular, additional ontologies, document templates, and examples, are provided on Zenodo.

Installation of the Development Version (Git Repository)

The development version of Isabelle/DOF that is available in this Git repository provides, over the AFP version, additional ontologies, document templates, and examples that might not yet “ready for general use”. Furthermore, as it is provided as an Isabelle component, it can also provide additional tools that cannot be distributed via the AFP. As this repository provides a (potentially) updated version of Isabelle/DOF, it conflicts with a complete installation of the AFP. For more details on installing the development version, please consult the README_DEVELOPMENT.md file.

After installing the prerequisites, change into the directory containing Isabelle/DOF (this should be the directory containing this README.md file) and execute the following command for building the standard sessions of Isabelle/DOF:

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

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

For building the session Isabelle_DOF-Proofs, the timeout might need to increased to avoid timeouts during building the dependencies:

foo@bar:~$ isabelle build -d . -o 'timeout_scale=2' Isabelle_DOF-Proofs

Usage

In the following, we assume that you installed Isabelle/DOF either from the AFP (adding the AFP as a component to your Isabelle system) with the add-ons available on Zenodo (or from the Git repository of Isabelle/DOF).

Assuming that your current directory contains the example academic paper in the subdirectory Isabelle_DOF-Example-I/, you can open it similar to any standard Isabelle theory:

isabelle jedit -l Isabelle_DOF Isabelle_DOF-Example-I/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 default ontologies defined in the Isabelle_DOF session. If you want to edit the ontology definition, just open the theory file with the session Functional-Automata:

isabelle jedit -l Functional-Automata Isabelle_DOF-Example-I/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.

An impression of what Isabelle/DOF can do is given by the example Isabelle_DOF-Example-III: a paper about an operational semantics of CSP, based on the theories HOL-CSP and HOL-CSPM, which uses a different notation in the document than in the underlying theories, while maintaining the full formal consistency. With Isabelle 2026 and the corresponding version of the AFP (registered as an Isabelle component, so that the sessions of the AFP are found), it can be opened in Isabelle/jEdit by the following command, executed in the directory that contains the directory Isabelle_DOF-Example-III (the first start takes some time, since the underlying theories have to be loaded):

isabelle jedit -d Isabelle_DOF-Example-III -l Isabelle_DOF Isabelle_DOF-Example-III/paper.thy

If you work with the Git repository of Isabelle/DOF (see below) instead of the AFP version of Isabelle/DOF, the kernel in the directory upstream_afp has to be added:

isabelle jedit -d upstream_afp -d Isabelle_DOF-Example-III -l Isabelle_DOF Isabelle_DOF-Example-III/paper.thy

If activate the Document-Panel and select Isabelle_DOF-Example-III, you can continuously build the .pdf while editing the document. Selecting the Input tabular allows for selecting individual parts of the overall document (always keeping the first part 'front' is recommended).

Repository Structure

The main branch of this repository is developed using the latest official release of Isabelle. This is also the main development branch. In addition, he [isabelle_nightly](https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF/src/branch/isabelle_nightly) branch is used for testing Isabelle/DOF with the latest development version of Isabelle.

This repository is structured into several Isabelle sessions, each of which is stored in a subdirectory:

  • Isabelle_DOF: This is the main session, providing the Isabelle/DOF system. Furthermore, this session is currently under consideration for a submission to the AFP.
  • Isabelle_DOF-Example-I: This session provides an example document written Isabelle/DOF. It only requires the core ontologies provided by the Isabelle_DOF session. Furthermore, this session is currently under consideration for a submission to the AFP.
  • Isabelle_DOF-Ontologies: This session provided additional ontologies and document templates.
  • Isabelle_DOF-Unit-Tests: This session includes various tests for the Isabelle/DOF system, partly depending on the ontologies provided by the Isabelle_DOF-Ontologies session.
  • Isabelle_DOF-Examples-Extra: This directory contains additional example documents written using the Isabelle/DOF systems, each of which is defined in an own subdirectory.
  • Isabelle_DOF-Proofs: This session provides the Isabelle/DOF systems with proof objects. This is required for the deep ontology embedding. This session will never be submitted to the AFP: it relies on features that are not necessarily maintained by the main development of Isabelle. It is maintained in this repository as long as possible. It is not part of the release checks of Isabelle/DOF 2026 (see the file NEWS).

Releases

Since Isabelle 2024, Isabelle/DOF synchronises its releases with the releases of Isabelle. The core of Isabelle/DOF is part of the Archive of Formal Proofs and several add-on packages are released on Zenodo. More precisely, the kernel of Isabelle/DOF (the directory upstream_afp) is part of the AFP, whereas the other parts (additional ontologies, document templates, examples) are maintained as a tarball on Zenodo.

Isabelle/DOF 2026

The release for Isabelle 2026 is marked by the git tag Isabelle_DOF_2026. The tag Isabelle_DOF2026RC2 marks the last release candidate, the tags Isabelle_DOF_RC0 and Isabelle_DOF_RC1 mark earlier release candidates, and the tag Isabelle2026 marks the preparation for Isabelle 2026. The release was checked with Isabelle 2026 and the 2026 version of the AFP. It comprises, among others, the following changes:

  • Faster checking: the core is split into several theories that are loaded in parallel, and the invariants of document instances are checked in parallel to the processing of the document.
  • Local theory targets: the document commands (text*, Theorem*, ...) accept a target as in text* (in L) [...], such that the text can refer to the facts of a locale.
  • Grid tables: the antiquotation \<^gridtbl> of the standard library Isa_COL typesets tables written in the style of reStructuredText grid tables.
  • Exercise ontology: a new ontology for exercise sheets (tutorials, practicals, lectures and exams) with a document template; one source can be typeset for students, professors and examiners using Isabelle's document variants.
  • Examples: the examples are revised, in particular a new example on the operational semantics of CSP (Isabelle_DOF-Example-III).
  • Manuals: the reference manual and the user manual are revised.

Older releases are available here.

Team

Main contacts:

Contributors

  • Idir Ait-Sadoune
  • Paolo Crisafulli
  • Chantal Keller
  • Nicolas Méric

License

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

SPDX-License-Identifier: BSD-2-Clause

Publications

Upstream Repository

The upstream git repository, i.e., the single source of truth, for this project is hosted at https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF.