Isabelle_DOF
/
Isabelle_DOF
1
0
Fork 2
Code Issues 1 Pull Requests Releases Wiki Activity

Improved usage description and overall improvements.
Isabelle_DOF/Isabelle_DOF/master This commit looks good Details

This commit is contained in:
Achim D. Brucker 2019-08-11 22:26:43 +01:00
parent 332daa1ebb
commit 4ae8b281f5
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,8 +1,8 @@
# [Isabelle/DOF](https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF): Document Preparation Setup # [Isabelle/DOF](https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF): Document Preparation Setup
Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle/DOF is a novel Document Ontology Framework on top of Isabelle.
Isabelle. Isabelle/DOF allows for both conventional typesetting as Isabelle/DOF allows for both conventional typesetting as well as formal
well as formal development. development.
## Pre-requisites ## Pre-requisites
@ -18,8 +18,6 @@ Isabelle/DOF has two major pre-requisites:
## Installation ## Installation
### Quick Installation Guide
In most case, the DOF-plugin can be installed as follows: In most case, the DOF-plugin can be installed as follows:
```console ```console
@ -69,16 +67,29 @@ editor.
The DOF-plugin provides an alternative to Isabelle's ``mkroot`` command. The DOF-plugin provides an alternative to Isabelle's ``mkroot`` command.
Isabelle projects that use DOF need to be created using Isabelle projects that use DOF need to be created using
```console ```console
foo@bar:~$ isabelle mkroot_DOF foo@bar:~$ isabelle mkroot_DOF
``` ```
The ``mkroot_DOF`` command takes the same parameter as the standard The ``mkroot_DOF`` command takes the same parameter as the standard
``mkroot`` command of Isabelle. Thereafter, the normal Isabelle ``mkroot`` command of Isabelle. Thereafter, the normal Isabelle
command for building documents can be used. command for building documents can be used.
Using the ``-o`` option, different ontology setups can be Using the ``-o`` option, different ontology setups can be
selected and using the ``-t`` option, different LaTeX setups selected and using the ``-t`` option, different LaTeX setups
can be selected (use ``-h`` to obtain a list of all installed setups): can be selected. For example,
```console
foo@bar:~$ isabelle mkroot_DOF -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:
```console ```console
foo@bar:~$ isabelle mkroot_DOF -h foo@bar:~$ isabelle mkroot_DOF -h
@ -102,12 +113,6 @@ Usage: isabelle mkroot_DOF [OPTIONS] [DIR]
Prepare session root DIR (default: current directory). Prepare session root DIR (default: current directory).
``` ```
For example,
```console
foo@bar:~$ isabelle mkroot_DOF -o scholarly_paper -t scrartcl
```
creates a setup using the scholarly_paper ontology and the article
class from the KOMA-Script bundle.
## Team ## Team
@ -145,4 +150,3 @@ SPDX-License-Identifier: BSD-2-Clause
The master git repository for this project is hosted The master git repository for this project is hosted
<https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF>. <https://git.logicalhacking.com/Isabelle_DOF/Isabelle_DOF>.