Achim D. Brucker 1c558f89a3 | ||
---|---|---|
.. | ||
Tools | ||
converter | ||
document-template | ||
example | ||
latex | ||
README.md | ||
install |
README.md
Isabelle_DOF: Document Preparation Setup
This directory contains the DOF-plugin for Isabelle's document generation system.
Installation
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
argument to the install
script:
foo@bar:~$ ./install /usr/local/Isabelle2016-1/bin/isabelle
The DOF-plugin will be installed in the Isabelle user directory (the exact location depends on the Isabelle version).
Usage
The DOF-plugin provides an alternative to Isabelle's mkroot
command.
Isabelle projects that use DOF need to be created using
isabelle DOF_mkroot -d
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.
Development Setup
Compilation using the provided build
script, e.g.:
cd converter
./build
This build script requires a basic Unix-environment as, e.g., provided by Isabelle as well as a running Isabelle installation.
In addition, a maven setup is maintained that, e.g., can be imported into Eclipse. This results in an Scala development environment that supports the usual features of a modern IDE, e.g., Intellisense.
Prerequisites (Eclipse Setup)
- Java 8
- Eclipse Oxygen, including
Checkout
The converter is part of the Isabelle DOF repository:
git clone https://git.logicalhacking.com/HOL-OCL/Isabelle_DOF.git
Importing the Project into Eclipse
The project can be imported into a fresh Eclipse workspace using
File -> Import -> Maven -> Existing Maven Projects
. Please select
the converter
directory as parent directory. After the import, you
might need to resolve the dependencies using the maven integration of
Eclipse.
Team
Main contacts:
License
This project is licensed under a 2-clause BSD license.
SPDX-License-Identifier: BSD-2-Clause