Converted bash-environments to antiqotations.

This commit is contained in:
Achim D. Brucker 2021-01-31 16:54:22 +00:00
parent 243556467a
commit a1332ec9a4
1 changed files with 33 additions and 85 deletions

View File

@ -1,7 +1,7 @@
(************************************************************************* (*************************************************************************
* Copyright (C) * Copyright (C)
* 2019 The University of Exeter * 2019-2021 The University of Exeter
* 2018-2019 The University of Paris-Saclay * 2018-2021 The University of Paris-Saclay
* 2018 The University of Sheffield * 2018 The University of Sheffield
* *
* License: * License:
@ -35,12 +35,10 @@ available on \href{https://cloud.docker.com/u/logicalhacking/}{Docker Hub}. Thus
\href{https://www.docker.com}{Docker} installed and \href{https://www.docker.com}{Docker} installed and
your installation of Docker supports X11 application, you can start \<^isadof> as follows: your installation of Docker supports X11 application, you can start \<^isadof> as follows:
@{boxed_bash [display] @{boxed_bash [display] \<open>ë\prompt{}ë docker run -ti --rm -e DISPLAY=$DISPLAY \
\<open>ë\prompt{}ë docker run -ti --rm -e DISPLAY=$DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix \ -v /tmp/.X11-unix:/tmp/.X11-unix \
logicalhacking/isabelle_dof-ë\doflatestversionë_ë\MakeLowercase{\isabellelatestversion}ë \ logicalhacking/isabelle_dof-ë\doflatestversionë_ë\MakeLowercase{\isabellelatestversion}ë \
isabelle jedit isabelle jedit\<close>}
\<close>}
\<close> \<close>
subsection*[installation::technical]\<open>Installation\<close> subsection*[installation::technical]\<open>Installation\<close>
@ -57,41 +55,24 @@ text\<open>
of \<^isadof> (using semantic versioning) and the second part is the supported version of Isabelle. of \<^isadof> (using semantic versioning) and the second part is the supported version of Isabelle.
Thus, the same version of \<^isadof> might be available for different versions of Isabelle. Thus, the same version of \<^isadof> might be available for different versions of Isabelle.
\<^item> \<^bold>\<open>\<^TeXLive> 2020\<close>\<^bindex>\<open>TexLive@\<^TeXLive>\<close> (or any other modern \<^LaTeX>-distribution where \<^item> \<^bold>\<open>\<^TeXLive> 2020\<close>\<^bindex>\<open>TexLive@\<^TeXLive>\<close> (or any other modern \<^LaTeX>-distribution where
\<^pdftex> supports the \<^boxed_latex>\<open>\expanded\<close> primitive). \<^pdftex> supports the \<^boxed_latex>\<open>\expanded\<close>
\<^footnote>\<open>see \<^url>\<open>https://www.texdev.net/2018/12/06/a-new-primitive-expanded\<close>\<close> primitive).\<^footnote>\<open>see \<^url>\<open>https://www.texdev.net/2018/12/06/a-new-primitive-expanded\<close>\<close>
\<close> \<close>
paragraph\<open>Installing Isabelle\<close> paragraph\<open>Installing Isabelle\<close>
text\<open> text\<open>
%\enlargethispage{\baselineskip} Please download and install the Isabelle (version: \isabelleversion) distribution for your
Please download and install the Isabelle \isabelleversion distribution for your operating system operating system from the \href{\isabelleurl}{Isabelle website} (\url{\isabelleurl}). After the
from the \href{\isabelleurl}{Isabelle website} (\url{\isabelleurl}). After the successful successful installation of Isabelle, you should be able to call the \<^boxed_bash>\<open>isabelle\<close>
installation of Isabelle, you should be able to call the \<^boxed_bash>\<open>isabelle\<close> tool on the tool on the command line:
command line: @{boxed_bash [display]\<open>ë\prompt{}ë isabelle version
ë\isabellefullversionë\<close>}
\begin{bash}
ë\prompt{}ë isabelle version
ë\isabellefullversionë
\end{bash}
% bu : do not know why this does not work here ...
%@ {boxed_bash [display]\<open>
%ë\prompt{}ë isabelle version
%ë\isabellefullversionë
%\<close>}
Depending on your operating system and depending if you put Isabelle's \<^boxed_bash>\<open>bin\<close> directory Depending on your operating system and depending if you put Isabelle's \<^boxed_bash>\<open>bin\<close> directory
in your \<^boxed_bash>\<open>PATH\<close>, you will need to invoke \<^boxed_bash>\<open>isabelle\<close> using its in your \<^boxed_bash>\<open>PATH\<close>, you will need to invoke \<^boxed_bash>\<open>isabelle\<close> using its
full qualified path, \<^eg>: full qualified path, \<^eg>:
@{boxed_bash [display]\<open>ë\prompt{}ë /usr/local/Isabelleë\isabelleversionë/bin/isabelle version
\begin{bash} ë\isabellefullversionë\<close>}
ë\prompt{}ë /usr/local/Isabelleë\isabelleversion/ëbin/isabelle version
ë\isabellefullversionë
\end{bash}
%@ {boxed_bash [display]\<open>
%ë\prompt{}ë /usr/local/Isabelleë\isabelleversion/ëbin/isabelle version
%ë\isabellefullversionë
%\<close>}
\<close> \<close>
paragraph\<open>Installing \<^TeXLive>\<close> paragraph\<open>Installing \<^TeXLive>\<close>
@ -99,13 +80,7 @@ text\<open>
Modern Linux distribution will allow you to install \<^TeXLive> using their respective package Modern Linux distribution will allow you to install \<^TeXLive> using their respective package
managers. On a modern Debian system or a Debian derivative (\<^eg>, Ubuntu), the following command managers. On a modern Debian system or a Debian derivative (\<^eg>, Ubuntu), the following command
should install all required \<^LaTeX> packages: should install all required \<^LaTeX> packages:
@{boxed_bash [display]\<open>ë\prompt{}ë sudo aptitude install texlive-latex-extra texlive-fonts-extra\<close>}
\begin{bash}
ë\prompt{}ë sudo aptitude install texlive-latex-extra texlive-fonts-extra
\end{bash}
%@ {boxed_bash [display]\<open>
%ë\prompt{}ë sudo aptitude install texlive-latex-extra texlive-fonts-extra
%\<close>}
\<close> \<close>
subsubsection*[isadof::technical]\<open>Installing \<^isadof>\<close> subsubsection*[isadof::technical]\<open>Installing \<^isadof>\<close>
@ -114,10 +89,7 @@ text\<open>
(\href{\isadofarchiveurl}{\isadofarchiven}) from the \<^isadof> web site. The main steps for (\href{\isadofarchiveurl}{\isadofarchiven}) from the \<^isadof> web site. The main steps for
installing are extracting the \<^isadof> distribution and calling its \inlinebash|install| script. installing are extracting the \<^isadof> distribution and calling its \inlinebash|install| script.
We start by extracting the \<^isadof> archive: We start by extracting the \<^isadof> archive:
@{boxed_bash [display]\<open>ë\prompt{}ë tar xf ë\href{\isadofarchiveurl}{\isadofarchiven}ë\<close>}
\begin{bash}
ë\prompt{}ë tar xf ë\href{\isadofarchiveurl}{\isadofarchiven}ë
\end{bash}
This will create a directory \texttt{\isadofdirn} containing \<^isadof> distribution. This will create a directory \texttt{\isadofdirn} containing \<^isadof> distribution.
Next, we need to invoke the \<^boxed_bash>\<open>install\<close> script. If necessary, the installations Next, we need to invoke the \<^boxed_bash>\<open>install\<close> script. If necessary, the installations
automatically downloads additional dependencies from the AFP (\<^url>\<open>https://www.isa-afp.org\<close>), automatically downloads additional dependencies from the AFP (\<^url>\<open>https://www.isa-afp.org\<close>),
@ -132,8 +104,7 @@ If the \<^boxed_bash>\<open>isabelle\<close> tool is not in your \<^boxed_bash>
path of the \<^boxed_bash>\<open>isabelle\<close> tool ( \<^boxed_bash>\<open>install --help\<close> gives path of the \<^boxed_bash>\<open>isabelle\<close> tool ( \<^boxed_bash>\<open>install --help\<close> gives
you an overview of all available configuration options): you an overview of all available configuration options):
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{}ë cd ë\isadofdirnë
ë\prompt{}ë cd ë\isadofdirnë
ë\prompt{\isadofdirn}ë ./install --isabelle /usr/local/Isabelleë\isabelleversion/bin/isabelleë ë\prompt{\isadofdirn}ë ./install --isabelle /usr/local/Isabelleë\isabelleversion/bin/isabelleë
Isabelle/DOF Installer Isabelle/DOF Installer
@ -170,17 +141,14 @@ Isabelle/DOF Installer
/home/achim/.isabelle/Isabelleë\isabelleversion/etc/settingsë /home/achim/.isabelle/Isabelleë\isabelleversion/etc/settingsë
* Installation successful. Enjoy Isabelle/DOF, you can build the session * Installation successful. Enjoy Isabelle/DOF, you can build the session
Isabelle/DOF and all example documents by executing: Isabelle/DOF and all example documents by executing:
/usr/local/Isabelleë\isabelleversion/bin/isabelleë build -D . /usr/local/Isabelleë\isabelleversion/bin/isabelleë build -D . \<close>}
\end{bash}
After the successful installation, you can now explore the examples (in the sub-directory After the successful installation, you can now explore the examples (in the sub-directory
\inlinebash|examples| or create your own project. On the first start, the session \inlinebash|examples| or create your own project. On the first start, the session
\inlinebash|Isabelle_DOF| will be built automatically. If you want to pre-build this \inlinebash|Isabelle_DOF| will be built automatically. If you want to pre-build this
session and all example documents, execute: session and all example documents, execute:
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{\isadofdirn}ë isabelle build -D . \<close>}
ë\prompt{\isadofdirn}ë isabelle build -D .
\end{bash}
\<close> \<close>
subsection*[first_project::technical]\<open>Creating an \<^isadof> Project\<close> subsection*[first_project::technical]\<open>Creating an \<^isadof> Project\<close>
@ -188,8 +156,7 @@ text\<open>
\<^isadof> provides its own variant of Isabelle's \<^isadof> provides its own variant of Isabelle's
\inlinebash|mkroot| tool, called \inlinebash|mkroot_DOF|:\index{mkroot\_DOF} \inlinebash|mkroot| tool, called \inlinebash|mkroot_DOF|:\index{mkroot\_DOF}
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{}ë isabelle mkroot_DOF -h
ë\prompt{}ë isabelle mkroot_DOF -h
Usage: isabelle mkroot_DOF [OPTIONS] [DIR] Usage: isabelle mkroot_DOF [OPTIONS] [DIR]
@ -209,8 +176,7 @@ Usage: isabelle mkroot_DOF [OPTIONS] [DIR]
* scrreprt-modern * scrreprt-modern
* scrreprt * scrreprt
Prepare session root DIR (default: current directory). Prepare session root DIR (default: current directory). \<close>}
\end{bash}
Creating a new document setup requires two decisions: Creating a new document setup requires two decisions:
\<^item> which ontologies (\<^eg>, scholarly\_paper) are required and \<^item> which ontologies (\<^eg>, scholarly\_paper) are required and
@ -225,24 +191,20 @@ text\<open>
the KOMA-Script bundle~@{cite "kohm:koma-script:2019"}, you can create your first project the KOMA-Script bundle~@{cite "kohm:koma-script:2019"}, you can create your first project
\inlinebash|myproject| as follows: \inlinebash|myproject| as follows:
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{}ë isabelle mkroot_DOF myproject
ë\prompt{}ë isabelle mkroot_DOF myproject
Preparing session "myproject" iëën "myproject" Preparing session "myproject" iëën "myproject"
creating "myproject/ROOT" creating "myproject/ROOT"
creating "myproject/document/root.tex" creating "myproject/document/root.tex"
Now use the following coëëmmand line to build the session: Now use the following coëëmmand line to build the session:
isabelle build -D myproject isabelle build -D myproject \<close>}
\end{bash}
This creates a directory \inlinebash|myproject| containing the \<^isadof>-setup for your This creates a directory \inlinebash|myproject| containing the \<^isadof>-setup for your
new document. To check the document formally, including the generation of the document in PDF, new document. To check the document formally, including the generation of the document in PDF,
you only need to execute you only need to execute
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{}ë isabelle build -d . myproject \<close>}
ë\prompt{}ë isabelle build -d . myproject
\end{bash}
This will create the directory \inlinebash|myproject|: This will create the directory \inlinebash|myproject|:
\begin{center} \begin{center}
@ -302,17 +264,13 @@ text\<open>
\nolinkurl{examples/scholarly_paper/2018-cicm-isabelle_dof-applications/IsaDofApplications.thy}. \nolinkurl{examples/scholarly_paper/2018-cicm-isabelle_dof-applications/IsaDofApplications.thy}.
\<^item> starting Isabelle/jedit from the command line by,\<^eg>, calling: \<^item> starting Isabelle/jedit from the command line by,\<^eg>, calling:
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{\isadofdirn}ë
ë\prompt{\isadofdirn}ë isabelle jedit -d . examples/scholarly_paper/2020-iFM-CSP/paper.thy \<close>}
isabelle jedit -d . examples/scholarly_paper/2020-iFM-CSP/paper.thy
\end{bash}
\<close> \<close>
(* We should discuss if we shouldn't put the iFM paper more in the foreground *) (* We should discuss if we shouldn't put the iFM paper more in the foreground *)
text\<open> You can build the PDF-document at the command line by calling: text\<open> You can build the PDF-document at the command line by calling:
@{boxed_bash [display] \<open>ë\prompt{}ë isabelle build -d . 2020-iFM-csp \<close>}
@{boxed_bash [display]
\<open>ë\prompt{}ë isabelle build -d . 2020-iFM-csp \<close>}
\<close> \<close>
subsection*[sss::technical]\<open>A Bluffers Guide to the \<^verbatim>\<open>scholarly_paper\<close> Ontology\<close> subsection*[sss::technical]\<open>A Bluffers Guide to the \<^verbatim>\<open>scholarly_paper\<close> Ontology\<close>
@ -631,16 +589,12 @@ text\<open>
\nolinkurl{examples/CENELEC_50128/mini_odo/mini_odo.thy}. \nolinkurl{examples/CENELEC_50128/mini_odo/mini_odo.thy}.
\<^item> starting Isabelle/jedit from the command line by calling: \<^item> starting Isabelle/jedit from the command line by calling:
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{\isadofdirn}ë
ë\prompt{\isadofdirn}ë isabelle jedit examples/CENELEC_50128/mini_odo/mini_odo.thy \<close>}
isabelle jedit examples/CENELEC_50128/mini_odo/mini_odo.thy
\end{bash}
\<close> \<close>
text\<open>\<^noindent> Finally, you text\<open>\<^noindent> Finally, you
\<^item> can build the PDF-document by calling: \<^item> can build the PDF-document by calling:
\begin{bash} @{boxed_bash [display]\<open>ë\prompt{}ë isabelle build mini_odo \<close>}
ë\prompt{}ë isabelle build mini_odo
\end{bash}
\<close> \<close>
subsection\<open>Modeling CENELEC 50128\<close> subsection\<open>Modeling CENELEC 50128\<close>
@ -776,18 +730,12 @@ text\<open>
Isabelle-Icon provided by the Isabelle installation) and loading the file Isabelle-Icon provided by the Isabelle installation) and loading the file
\nolinkurl{examples/math_exam/MathExam/MathExam.thy}. \nolinkurl{examples/math_exam/MathExam/MathExam.thy}.
\<^item> starting Isabelle/jedit from the command line by calling: \<^item> starting Isabelle/jedit from the command line by calling:
@{boxed_bash [display]\<open>ë\prompt{\isadofdirn}ë
\begin{bash} isabelle jedit examples/math_exam/MathExam/MathExam.thy \<close>}
ë\prompt{\isadofdirn}ë
isabelle jedit examples/math_exam/MathExam/MathExam.thy
\end{bash}
\<close> \<close>
text\<open> text\<open>
You can build the PDF-document by calling: You can build the PDF-document by calling:
@{boxed_bash [display]\<open>ë\prompt{}ë isabelle build MathExam\<close>}
\begin{bash}
ë\prompt{}ë isabelle build MathExam
\end{bash}
\<close> \<close>
subsection\<open>Modeling Exams\<close> subsection\<open>Modeling Exams\<close>