|
|
||
|---|---|---|
| .bin | ||
| .woodpecker | ||
| etc | ||
| examples/technical_report/UserManual | ||
| Isabelle_DOF-Example-I | ||
| Isabelle_DOF-Example-II | ||
| Isabelle_DOF-Example-III | ||
| Isabelle_DOF-Examples-Extra | ||
| Isabelle_DOF-Examples-Templates | ||
| Isabelle_DOF-Ontologies | ||
| Isabelle_DOF-Proofs | ||
| Isabelle_DOF-Scaffold | ||
| Isabelle_DOF-Unit-Tests | ||
| scala | ||
| upstream_afp | ||
| .envrc | ||
| .gitattributes | ||
| .gitignore | ||
| CITATION | ||
| install-afp | ||
| LICENSE | ||
| NEWS | ||
| README_DEVELOPMENT.md | ||
| 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 and formal development.
Pre-requisites
Isabelle/DOF has two major prerequisites:
- Isabelle 2026: Isabelle/DOF requires Isabelle and 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.
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_DOFsession. 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-Ontologiessession. - 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 intext* (in L) [...], such that the text can refer to the facts of a locale. - Grid tables: the antiquotation
\<^gridtbl>of the standard libraryIsa_COLtypesets 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
-
Achim D. Brucker, Idir Aït-Sadoune, Nicolas Méric, Burkhart Wolff: Parametric ontologies in formal software engineering. Sci. Comput. Program. 241: 103231 (2025). do:10.1016/j.scico.2024.103231
-
Nicolas Méric: An Ontology Framework for Formal Libraries: Doctoral Thesis at the University Pris-Saclay. (Conception et Implémentation d'un Environnement d'Ontologie pour des Bibliothèques Formelles). University of Paris-Saclay, France, 2024. https://tel.archives-ouvertes.fr/tel-04870527
-
Achim D. Brucker, Idir Aït-Sadoune, Nicolas Méric, Burkhart Wolff: Using Deep Ontologies in Formal Software Engineering. ABZ 2023: 15-32. doi:10.1007/978-3-031-33163-3_2
-
Achim D. Brucker, Idir Ait-Sadoune, Paolo Crisafulli, and Burkhart Wolff. Using The Isabelle Ontology Framework: Linking the Formal with the Informal. In Conference on Intelligent Computer Mathematics (CICM). Lecture Notes in Computer Science (11006), Springer-Verlag, 2018. doi:10.1007/978-3-319-96812-4_3.
-
Achim D. Brucker and Burkhart Wolff. Isabelle/DOF: Design and Implementation. In Software Engineering and Formal Methods (SEFM). Lecture Notes in Computer Science (11724), Springer-Verlag, 2019. doi:10.1007/978-3-030-30446-1_15.
-
Achim D. Brucker, Burkhart Wolff. Using Ontologies in Formal Developments Targeting Certification. In Integrated Formal Methods (IFM). Lecture Notes in Computer Science (11918). Springer-Verlag 2019. doi:10.1007/978-3-030-34968-4_4
-
Sergio Bezzecchi, Paolo Crisafulli, Charlotte Pichot, and Burkhart Wolff. Making Agile Development Processes fit for V-style Certification Procedures.. In ERTS 2018. https://hal.archives-ouvertes.fr/hal-01702815
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.