author | wenzelm |
Wed, 21 Oct 2015 00:23:11 +0200 | |
changeset 61494 | 63b18f758874 |
parent 61493 | 0debd22f0c0e |
child 61503 | 28e788ca2c5d |
permissions | -rw-r--r-- |
27043 | 1 |
theory Document_Preparation |
42651 | 2 |
imports Base Main |
27043 | 3 |
begin |
4 |
||
58618 | 5 |
chapter \<open>Document preparation \label{ch:document-prep}\<close> |
27043 | 6 |
|
58618 | 7 |
text \<open>Isabelle/Isar provides a simple document preparation system |
54346 | 8 |
based on {PDF-\LaTeX}, with support for hyperlinks and bookmarks |
9 |
within that format. This allows to produce papers, books, theses |
|
10 |
etc.\ from Isabelle theory sources. |
|
27043 | 11 |
|
61477 | 12 |
{\LaTeX} output is generated while processing a \<^emph>\<open>session\<close> in |
13 |
batch mode, as explained in the \<^emph>\<open>The Isabelle System Manual\<close> |
|
60270 | 14 |
@{cite "isabelle-system"}. The main Isabelle tools to get started with |
54346 | 15 |
document preparation are @{tool_ref mkroot} and @{tool_ref build}. |
27043 | 16 |
|
58552 | 17 |
The classic Isabelle/HOL tutorial @{cite "isabelle-hol-book"} also |
58618 | 18 |
explains some aspects of theory presentation.\<close> |
27043 | 19 |
|
20 |
||
58618 | 21 |
section \<open>Markup commands \label{sec:markup}\<close> |
27043 | 22 |
|
58618 | 23 |
text \<open> |
27043 | 24 |
\begin{matharray}{rcl} |
61493 | 25 |
@{command_def "chapter"} & : & \<open>any \<rightarrow> any\<close> \\ |
26 |
@{command_def "section"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
27 |
@{command_def "subsection"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
28 |
@{command_def "subsubsection"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
29 |
@{command_def "paragraph"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
30 |
@{command_def "subparagraph"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
31 |
@{command_def "text"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
32 |
@{command_def "txt"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
33 |
@{command_def "text_raw"} & : & \<open>any \<rightarrow> any\<close> \\ |
|
27043 | 34 |
\end{matharray} |
35 |
||
28747 | 36 |
Markup commands provide a structured way to insert text into the |
37 |
document generated from a theory. Each markup command takes a |
|
38 |
single @{syntax text} argument, which is passed as argument to a |
|
39 |
corresponding {\LaTeX} macro. The default macros provided by |
|
40800
330eb65c9469
Parse.liberal_name for document antiquotations and attributes;
wenzelm
parents:
40255
diff
changeset
|
40 |
@{file "~~/lib/texinputs/isabelle.sty"} can be redefined according |
28747 | 41 |
to the needs of the underlying document and {\LaTeX} styles. |
42 |
||
43 |
Note that formal comments (\secref{sec:comments}) are similar to |
|
44 |
markup commands, but have a different status within Isabelle/Isar |
|
45 |
syntax. |
|
27043 | 46 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
47 |
@{rail \<open> |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
48 |
(@@{command chapter} | @@{command section} | @@{command subsection} | |
61463 | 49 |
@@{command subsubsection} | @@{command paragraph} | @@{command subparagraph} | |
50 |
@@{command text} | @@{command txt} | @@{command text_raw}) @{syntax text} |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
51 |
\<close>} |
27043 | 52 |
|
61463 | 53 |
\<^descr> @{command chapter}, @{command section}, @{command subsection} etc.\ mark |
54 |
section headings within the theory source. This works in any context, even |
|
55 |
before the initial @{command theory} command. The corresponding {\LaTeX} |
|
56 |
macros are @{verbatim \<open>\isamarkupchapter\<close>}, @{verbatim |
|
57 |
\<open>\isamarkupsection\<close>}, @{verbatim \<open>\isamarkupsubsection\<close>} etc.\ |
|
27043 | 58 |
|
61439 | 59 |
\<^descr> @{command text} and @{command txt} specify paragraphs of plain text. |
58999
ed09ae4ea2d8
uniform treatment of all document markup commands: 'text' and 'txt' merely differ in LaTeX style;
wenzelm
parents:
58868
diff
changeset
|
60 |
This corresponds to a {\LaTeX} environment @{verbatim |
61493 | 61 |
\<open>\begin{isamarkuptext}\<close>} \<open>\<dots>\<close> @{verbatim \<open>\end{isamarkuptext}\<close>} |
58999
ed09ae4ea2d8
uniform treatment of all document markup commands: 'text' and 'txt' merely differ in LaTeX style;
wenzelm
parents:
58868
diff
changeset
|
62 |
etc. |
27043 | 63 |
|
61463 | 64 |
\<^descr> @{command text_raw} is similar to @{command text}, but without |
65 |
any surrounding markup environment. This allows to inject arbitrary |
|
66 |
{\LaTeX} source into the generated document. |
|
27043 | 67 |
|
68 |
||
61463 | 69 |
All text passed to any of the above markup commands may refer to formal |
61477 | 70 |
entities via \<^emph>\<open>document antiquotations\<close>, see also \secref{sec:antiq}. |
61463 | 71 |
These are interpreted in the present theory or proof context. |
27043 | 72 |
|
61421 | 73 |
\<^medskip> |
74 |
The proof markup commands closely resemble those for theory |
|
27043 | 75 |
specifications, but have a different formal status and produce |
58868
c5e1cce7ace3
uniform heading commands work in any context, even in theory header;
wenzelm
parents:
58725
diff
changeset
|
76 |
different {\LaTeX} macros. |
58618 | 77 |
\<close> |
27043 | 78 |
|
79 |
||
60286 | 80 |
section \<open>Document antiquotations \label{sec:antiq}\<close> |
27043 | 81 |
|
58618 | 82 |
text \<open> |
27043 | 83 |
\begin{matharray}{rcl} |
61493 | 84 |
@{antiquotation_def "theory"} & : & \<open>antiquotation\<close> \\ |
85 |
@{antiquotation_def "thm"} & : & \<open>antiquotation\<close> \\ |
|
86 |
@{antiquotation_def "lemma"} & : & \<open>antiquotation\<close> \\ |
|
87 |
@{antiquotation_def "prop"} & : & \<open>antiquotation\<close> \\ |
|
88 |
@{antiquotation_def "term"} & : & \<open>antiquotation\<close> \\ |
|
89 |
@{antiquotation_def term_type} & : & \<open>antiquotation\<close> \\ |
|
90 |
@{antiquotation_def typeof} & : & \<open>antiquotation\<close> \\ |
|
91 |
@{antiquotation_def const} & : & \<open>antiquotation\<close> \\ |
|
92 |
@{antiquotation_def abbrev} & : & \<open>antiquotation\<close> \\ |
|
93 |
@{antiquotation_def typ} & : & \<open>antiquotation\<close> \\ |
|
94 |
@{antiquotation_def type} & : & \<open>antiquotation\<close> \\ |
|
95 |
@{antiquotation_def class} & : & \<open>antiquotation\<close> \\ |
|
96 |
@{antiquotation_def "text"} & : & \<open>antiquotation\<close> \\ |
|
97 |
@{antiquotation_def goals} & : & \<open>antiquotation\<close> \\ |
|
98 |
@{antiquotation_def subgoals} & : & \<open>antiquotation\<close> \\ |
|
99 |
@{antiquotation_def prf} & : & \<open>antiquotation\<close> \\ |
|
100 |
@{antiquotation_def full_prf} & : & \<open>antiquotation\<close> \\ |
|
101 |
@{antiquotation_def ML} & : & \<open>antiquotation\<close> \\ |
|
102 |
@{antiquotation_def ML_op} & : & \<open>antiquotation\<close> \\ |
|
103 |
@{antiquotation_def ML_type} & : & \<open>antiquotation\<close> \\ |
|
104 |
@{antiquotation_def ML_structure} & : & \<open>antiquotation\<close> \\ |
|
105 |
@{antiquotation_def ML_functor} & : & \<open>antiquotation\<close> \\ |
|
106 |
@{antiquotation_def emph} & : & \<open>antiquotation\<close> \\ |
|
107 |
@{antiquotation_def bold} & : & \<open>antiquotation\<close> \\ |
|
108 |
@{antiquotation_def verbatim} & : & \<open>antiquotation\<close> \\ |
|
109 |
@{antiquotation_def "file"} & : & \<open>antiquotation\<close> \\ |
|
110 |
@{antiquotation_def "url"} & : & \<open>antiquotation\<close> \\ |
|
111 |
@{antiquotation_def "cite"} & : & \<open>antiquotation\<close> \\ |
|
61494 | 112 |
@{command_def "print_antiquotations"}\<open>\<^sup>*\<close> & : & \<open>context \<rightarrow>\<close> \\ |
27043 | 113 |
\end{matharray} |
114 |
||
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
115 |
The overall content of an Isabelle/Isar theory may alternate between |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
116 |
formal and informal text. The main body consists of formal |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
117 |
specification and proof commands, interspersed with markup commands |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
118 |
(\secref{sec:markup}) or document comments (\secref{sec:comments}). |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
119 |
The argument of markup commands quotes informal text to be printed |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
120 |
in the resulting document, but may again refer to formal entities |
61477 | 121 |
via \<^emph>\<open>document antiquotations\<close>. |
27043 | 122 |
|
58724 | 123 |
For example, embedding @{verbatim \<open>@{term [show_types] "f x = a + x"}\<close>} |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
124 |
within a text block makes |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
125 |
\isa{{\isacharparenleft}f{\isasymColon}{\isacharprime}a\ {\isasymRightarrow}\ {\isacharprime}a{\isacharparenright}\ {\isacharparenleft}x{\isasymColon}{\isacharprime}a{\isacharparenright}\ {\isacharequal}\ {\isacharparenleft}a{\isasymColon}{\isacharprime}a{\isacharparenright}\ {\isacharplus}\ x} appear in the final {\LaTeX} document. |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
126 |
|
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
127 |
Antiquotations usually spare the author tedious typing of logical |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
128 |
entities in full detail. Even more importantly, some degree of |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
129 |
consistency-checking between the main body of formal text and its |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
130 |
informal explanation is achieved, since terms and types appearing in |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
131 |
antiquotations are checked within the current theory or proof |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
132 |
context. |
27043 | 133 |
|
61493 | 134 |
\<^medskip> Antiquotations are in general written as @{verbatim "@{"}\<open>name\<close>~@{verbatim "["}\<open>options\<close>@{verbatim "]"}~\<open>arguments\<close>@{verbatim "}"}. The short form @{verbatim \<open>\\<close>}@{verbatim |
135 |
"<^"}\<open>name\<close>@{verbatim ">"}\<open>\<open>argument_content\<close>\<close> (without |
|
136 |
surrounding @{verbatim "@{"}\<open>\<dots>\<close>@{verbatim "}"}) works for a single |
|
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
137 |
argument that is a cartouche. |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
138 |
|
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
139 |
Omitting the control symbol is also possible: a cartouche without special |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
140 |
decoration is equivalent to @{verbatim \<open>\\<close>}@{verbatim |
61493 | 141 |
"<^cartouche>"}\<open>\<open>argument_content\<close>\<close>, which is equivalent to |
142 |
@{verbatim "@{cartouche"}~\<open>\<open>argument_content\<close>\<close>@{verbatim "}"}. The |
|
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
143 |
special name @{antiquotation_def cartouche} is defined in the context: |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
144 |
Isabelle/Pure introduces that as an alias to @{antiquotation_ref text} |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
145 |
(see below). Consequently, \<open>\<open>foo_bar + baz \<le> bazar\<close>\<close> prints literal |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
146 |
quasi-formal text (unchecked). |
61472 | 147 |
|
61474 | 148 |
\begingroup |
149 |
\def\isasymcontrolstart{\isatt{\isacharbackslash\isacharless\isacharcircum}} |
|
59917
9830c944670f
more uniform "verbose" option to print name space;
wenzelm
parents:
59783
diff
changeset
|
150 |
@{rail \<open> |
61472 | 151 |
@{syntax_def antiquotation}: |
61474 | 152 |
'@{' antiquotation_body '}' | |
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
153 |
'\<controlstart>' @{syntax_ref name} '>' @{syntax_ref cartouche} | |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
154 |
@{syntax_ref cartouche} |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
155 |
; |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
156 |
options: '[' (option * ',') ']' |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
157 |
; |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
158 |
option: @{syntax name} | @{syntax name} '=' @{syntax name} |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
159 |
; |
59917
9830c944670f
more uniform "verbose" option to print name space;
wenzelm
parents:
59783
diff
changeset
|
160 |
\<close>} |
61474 | 161 |
\endgroup |
59917
9830c944670f
more uniform "verbose" option to print name space;
wenzelm
parents:
59783
diff
changeset
|
162 |
|
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
163 |
Note that the syntax of antiquotations may \<^emph>\<open>not\<close> include source |
61493 | 164 |
comments @{verbatim "(*"}~\<open>\<dots>\<close>~@{verbatim "*)"} nor verbatim |
165 |
text @{verbatim "{*"}~\<open>\<dots>\<close>~@{verbatim "*}"}. |
|
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
166 |
|
43618 | 167 |
%% FIXME less monolithic presentation, move to individual sections!? |
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
168 |
@{rail \<open> |
61472 | 169 |
@{syntax_def antiquotation_body}: |
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
170 |
(@@{antiquotation text} | @@{antiquotation cartouche}) options @{syntax text} | |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
171 |
@@{antiquotation theory} options @{syntax name} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
172 |
@@{antiquotation thm} options styles @{syntax thmrefs} | |
42617 | 173 |
@@{antiquotation lemma} options @{syntax prop} @'by' @{syntax method} @{syntax method}? | |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
174 |
@@{antiquotation prop} options styles @{syntax prop} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
175 |
@@{antiquotation term} options styles @{syntax term} | |
43618 | 176 |
@@{antiquotation (HOL) value} options styles @{syntax term} | |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
177 |
@@{antiquotation term_type} options styles @{syntax term} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
178 |
@@{antiquotation typeof} options styles @{syntax term} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
179 |
@@{antiquotation const} options @{syntax term} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
180 |
@@{antiquotation abbrev} options @{syntax term} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
181 |
@@{antiquotation typ} options @{syntax type} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
182 |
@@{antiquotation type} options @{syntax name} | |
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
183 |
@@{antiquotation class} options @{syntax name} |
46261 | 184 |
; |
185 |
@{syntax antiquotation}: |
|
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
186 |
@@{antiquotation goals} options | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
187 |
@@{antiquotation subgoals} options | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
188 |
@@{antiquotation prf} options @{syntax thmrefs} | |
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
189 |
@@{antiquotation full_prf} options @{syntax thmrefs} | |
58069
0255436b3d85
more liberal embedded "text", which includes cartouches;
wenzelm
parents:
56594
diff
changeset
|
190 |
@@{antiquotation ML} options @{syntax text} | |
0255436b3d85
more liberal embedded "text", which includes cartouches;
wenzelm
parents:
56594
diff
changeset
|
191 |
@@{antiquotation ML_op} options @{syntax text} | |
0255436b3d85
more liberal embedded "text", which includes cartouches;
wenzelm
parents:
56594
diff
changeset
|
192 |
@@{antiquotation ML_type} options @{syntax text} | |
0255436b3d85
more liberal embedded "text", which includes cartouches;
wenzelm
parents:
56594
diff
changeset
|
193 |
@@{antiquotation ML_structure} options @{syntax text} | |
0255436b3d85
more liberal embedded "text", which includes cartouches;
wenzelm
parents:
56594
diff
changeset
|
194 |
@@{antiquotation ML_functor} options @{syntax text} | |
61473
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
195 |
@@{antiquotation emph} options @{syntax text} | |
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
196 |
@@{antiquotation bold} options @{syntax text} | |
58716
23a380cc45f4
official support for "tt" style variants, avoid fragile \verb in LaTeX;
wenzelm
parents:
58618
diff
changeset
|
197 |
@@{antiquotation verbatim} options @{syntax text} | |
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
198 |
@@{antiquotation "file"} options @{syntax name} | |
54705 | 199 |
@@{antiquotation file_unchecked} options @{syntax name} | |
58593 | 200 |
@@{antiquotation url} options @{syntax name} | |
201 |
@@{antiquotation cite} options @{syntax cartouche}? (@{syntax name} + @'and') |
|
27043 | 202 |
; |
32892 | 203 |
styles: '(' (style + ',') ')' |
32891 | 204 |
; |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
205 |
style: (@{syntax name} +) |
61473
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
206 |
; |
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
207 |
@@{command print_antiquotations} ('!'?) |
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
208 |
\<close>} |
27043 | 209 |
|
61493 | 210 |
\<^descr> \<open>@{text s}\<close> prints uninterpreted source text \<open>s\<close>. This is particularly useful to print portions of text according |
61491
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
211 |
to the Isabelle document style, without demanding well-formedness, |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
212 |
e.g.\ small pieces of terms that should not be parsed or |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
213 |
type-checked yet. |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
214 |
|
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
215 |
It is also possible to write this in the short form \<open>\<open>s\<close>\<close> without any |
97261e6c1d42
another antiquotation short form: undecorated cartouche as alias for @{text};
wenzelm
parents:
61479
diff
changeset
|
216 |
further decoration. |
27043 | 217 |
|
61493 | 218 |
\<^descr> \<open>@{theory A}\<close> prints the name \<open>A\<close>, which is |
27043 | 219 |
guaranteed to refer to a valid ancestor theory in the current |
220 |
context. |
|
221 |
||
61493 | 222 |
\<^descr> \<open>@{thm a\<^sub>1 \<dots> a\<^sub>n}\<close> prints theorems \<open>a\<^sub>1 \<dots> a\<^sub>n\<close>. |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
223 |
Full fact expressions are allowed here, including attributes |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
224 |
(\secref{sec:syn-att}). |
27043 | 225 |
|
61493 | 226 |
\<^descr> \<open>@{prop \<phi>}\<close> prints a well-typed proposition \<open>\<phi>\<close>. |
27043 | 227 |
|
61493 | 228 |
\<^descr> \<open>@{lemma \<phi> by m}\<close> proves a well-typed proposition |
229 |
\<open>\<phi>\<close> by method \<open>m\<close> and prints the original \<open>\<phi>\<close>. |
|
27453 | 230 |
|
61493 | 231 |
\<^descr> \<open>@{term t}\<close> prints a well-typed term \<open>t\<close>. |
43613
7afbaf5a406b
adding a minimalistic documentation of the value antiquotation in the Isar reference manual
bulwahn
parents:
42936
diff
changeset
|
232 |
|
61493 | 233 |
\<^descr> \<open>@{value t}\<close> evaluates a term \<open>t\<close> and prints |
43618 | 234 |
its result, see also @{command_ref (HOL) value}. |
27043 | 235 |
|
61493 | 236 |
\<^descr> \<open>@{term_type t}\<close> prints a well-typed term \<open>t\<close> |
32898
e871d897969c
term styles also cover antiquotations term_type and typeof
haftmann
parents:
32892
diff
changeset
|
237 |
annotated with its type. |
e871d897969c
term styles also cover antiquotations term_type and typeof
haftmann
parents:
32892
diff
changeset
|
238 |
|
61493 | 239 |
\<^descr> \<open>@{typeof t}\<close> prints the type of a well-typed term |
240 |
\<open>t\<close>. |
|
32898
e871d897969c
term styles also cover antiquotations term_type and typeof
haftmann
parents:
32892
diff
changeset
|
241 |
|
61493 | 242 |
\<^descr> \<open>@{const c}\<close> prints a logical or syntactic constant |
243 |
\<open>c\<close>. |
|
27043 | 244 |
|
61493 | 245 |
\<^descr> \<open>@{abbrev c x\<^sub>1 \<dots> x\<^sub>n}\<close> prints a constant abbreviation |
246 |
\<open>c x\<^sub>1 \<dots> x\<^sub>n \<equiv> rhs\<close> as defined in the current context. |
|
39305
d4fa19eb0822
'class' and 'type' are now antiquoations by default
haftmann
parents:
32898
diff
changeset
|
247 |
|
61493 | 248 |
\<^descr> \<open>@{typ \<tau>}\<close> prints a well-formed type \<open>\<tau>\<close>. |
39305
d4fa19eb0822
'class' and 'type' are now antiquoations by default
haftmann
parents:
32898
diff
changeset
|
249 |
|
61493 | 250 |
\<^descr> \<open>@{type \<kappa>}\<close> prints a (logical or syntactic) type |
251 |
constructor \<open>\<kappa>\<close>. |
|
39305
d4fa19eb0822
'class' and 'type' are now antiquoations by default
haftmann
parents:
32898
diff
changeset
|
252 |
|
61493 | 253 |
\<^descr> \<open>@{class c}\<close> prints a class \<open>c\<close>. |
39305
d4fa19eb0822
'class' and 'type' are now antiquoations by default
haftmann
parents:
32898
diff
changeset
|
254 |
|
61493 | 255 |
\<^descr> \<open>@{goals}\<close> prints the current \<^emph>\<open>dynamic\<close> goal |
27043 | 256 |
state. This is mainly for support of tactic-emulation scripts |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
257 |
within Isar. Presentation of goal states does not conform to the |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
258 |
idea of human-readable proof documents! |
27043 | 259 |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
260 |
When explaining proofs in detail it is usually better to spell out |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
261 |
the reasoning via proper Isar proof commands, instead of peeking at |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
262 |
the internal machine configuration. |
27043 | 263 |
|
61493 | 264 |
\<^descr> \<open>@{subgoals}\<close> is similar to \<open>@{goals}\<close>, but |
27043 | 265 |
does not print the main goal. |
266 |
||
61493 | 267 |
\<^descr> \<open>@{prf a\<^sub>1 \<dots> a\<^sub>n}\<close> prints the (compact) proof terms |
268 |
corresponding to the theorems \<open>a\<^sub>1 \<dots> a\<^sub>n\<close>. Note that this |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
269 |
requires proof terms to be switched on for the current logic |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
270 |
session. |
27043 | 271 |
|
61493 | 272 |
\<^descr> \<open>@{full_prf a\<^sub>1 \<dots> a\<^sub>n}\<close> is like \<open>@{prf a\<^sub>1 \<dots> |
273 |
a\<^sub>n}\<close>, but prints the full proof terms, i.e.\ also displays |
|
28760
cbc435f7b16b
unified use of declaration environment with IsarImplementation;
wenzelm
parents:
28750
diff
changeset
|
274 |
information omitted in the compact proof term, which is denoted by |
61493 | 275 |
``\<open>_\<close>'' placeholders there. |
27043 | 276 |
|
61493 | 277 |
\<^descr> \<open>@{ML s}\<close>, \<open>@{ML_op s}\<close>, \<open>@{ML_type |
278 |
s}\<close>, \<open>@{ML_structure s}\<close>, and \<open>@{ML_functor s}\<close> |
|
279 |
check text \<open>s\<close> as ML value, infix operator, type, structure, |
|
55837 | 280 |
and functor respectively. The source is printed verbatim. |
27043 | 281 |
|
61493 | 282 |
\<^descr> \<open>@{emph s}\<close> prints document source recursively, with {\LaTeX} |
283 |
markup @{verbatim \<open>\emph{\<close>}\<open>\<dots>\<close>@{verbatim \<open>}\<close>}. |
|
61473
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
284 |
|
61493 | 285 |
\<^descr> \<open>@{bold s}\<close> prints document source recursively, with {\LaTeX} |
286 |
markup @{verbatim \<open>\textbf{\<close>}\<open>\<dots>\<close>@{verbatim \<open>}\<close>}. |
|
61473
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
287 |
|
61493 | 288 |
\<^descr> \<open>@{verbatim s}\<close> prints uninterpreted source text literally |
58716
23a380cc45f4
official support for "tt" style variants, avoid fragile \verb in LaTeX;
wenzelm
parents:
58618
diff
changeset
|
289 |
as ASCII characters, using some type-writer font style. |
23a380cc45f4
official support for "tt" style variants, avoid fragile \verb in LaTeX;
wenzelm
parents:
58618
diff
changeset
|
290 |
|
61493 | 291 |
\<^descr> \<open>@{file path}\<close> checks that \<open>path\<close> refers to a |
40801 | 292 |
file (or directory) and prints it verbatim. |
293 |
||
61493 | 294 |
\<^descr> \<open>@{file_unchecked path}\<close> is like \<open>@{file |
295 |
path}\<close>, but does not check the existence of the \<open>path\<close> |
|
54705 | 296 |
within the file-system. |
297 |
||
61493 | 298 |
\<^descr> \<open>@{url name}\<close> produces markup for the given URL, which |
54702
3daeba5130f0
added document antiquotation @{url}, which produces formal markup for LaTeX and PIDE;
wenzelm
parents:
54346
diff
changeset
|
299 |
results in an active hyperlink within the text. |
3daeba5130f0
added document antiquotation @{url}, which produces formal markup for LaTeX and PIDE;
wenzelm
parents:
54346
diff
changeset
|
300 |
|
61493 | 301 |
\<^descr> \<open>@{cite name}\<close> produces a citation @{verbatim |
58724 | 302 |
\<open>\cite{name}\<close>} in {\LaTeX}, where the name refers to some Bib{\TeX} |
58593 | 303 |
database entry. |
304 |
||
61493 | 305 |
The variant \<open>@{cite \<open>opt\<close> name}\<close> produces @{verbatim |
58724 | 306 |
\<open>\cite[opt]{name}\<close>} with some free-form optional argument. Multiple names |
61493 | 307 |
are output with commas, e.g. \<open>@{cite foo \<AND> bar}\<close> becomes |
58724 | 308 |
@{verbatim \<open>\cite{foo,bar}\<close>}. |
58593 | 309 |
|
310 |
The {\LaTeX} macro name is determined by the antiquotation option |
|
311 |
@{antiquotation_option_def cite_macro}, or the configuration option |
|
61493 | 312 |
@{attribute cite_macro} in the context. For example, \<open>@{cite |
313 |
[cite_macro = nocite] foobar}\<close> produces @{verbatim \<open>\nocite{foobar}\<close>}. |
|
61473
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
314 |
|
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
315 |
\<^descr> @{command "print_antiquotations"} prints all document antiquotations |
61493 | 316 |
that are defined in the current context; the ``\<open>!\<close>'' option |
61473
34d1913f0b20
clarified control antiquotations: decode control symbol to get name;
wenzelm
parents:
61472
diff
changeset
|
317 |
indicates extra verbosity. |
58618 | 318 |
\<close> |
27043 | 319 |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
320 |
|
58618 | 321 |
subsection \<open>Styled antiquotations\<close> |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
322 |
|
61493 | 323 |
text \<open>The antiquotations \<open>thm\<close>, \<open>prop\<close> and \<open>term\<close> admit an extra \<^emph>\<open>style\<close> specification to modify the |
32891 | 324 |
printed result. A style is specified by a name with a possibly |
325 |
empty number of arguments; multiple styles can be sequenced with |
|
326 |
commas. The following standard styles are available: |
|
27043 | 327 |
|
61493 | 328 |
\<^descr> \<open>lhs\<close> extracts the first argument of any application |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
329 |
form with at least two arguments --- typically meta-level or |
27043 | 330 |
object-level equality, or any other binary relation. |
331 |
||
61493 | 332 |
\<^descr> \<open>rhs\<close> is like \<open>lhs\<close>, but extracts the second |
27043 | 333 |
argument. |
334 |
||
61493 | 335 |
\<^descr> \<open>concl\<close> extracts the conclusion \<open>C\<close> from a rule |
336 |
in Horn-clause normal form \<open>A\<^sub>1 \<Longrightarrow> \<dots> A\<^sub>n \<Longrightarrow> C\<close>. |
|
27043 | 337 |
|
61493 | 338 |
\<^descr> \<open>prem\<close> \<open>n\<close> extract premise number |
339 |
\<open>n\<close> from from a rule in Horn-clause |
|
340 |
normal form \<open>A\<^sub>1 \<Longrightarrow> \<dots> A\<^sub>n \<Longrightarrow> C\<close> |
|
58618 | 341 |
\<close> |
27043 | 342 |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
343 |
|
58618 | 344 |
subsection \<open>General options\<close> |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
345 |
|
58618 | 346 |
text \<open>The following options are available to tune the printed output |
54346 | 347 |
of antiquotations. Note that many of these coincide with system and |
348 |
configuration options of the same names. |
|
27043 | 349 |
|
61493 | 350 |
\<^descr> @{antiquotation_option_def show_types}~\<open>= bool\<close> and |
351 |
@{antiquotation_option_def show_sorts}~\<open>= bool\<close> control |
|
30397 | 352 |
printing of explicit type and sort constraints. |
27043 | 353 |
|
61493 | 354 |
\<^descr> @{antiquotation_option_def show_structs}~\<open>= bool\<close> |
30397 | 355 |
controls printing of implicit structures. |
27043 | 356 |
|
61493 | 357 |
\<^descr> @{antiquotation_option_def show_abbrevs}~\<open>= bool\<close> |
40879
ca132ef44944
configuration option "show_abbrevs" supersedes print mode "no_abbrevs", with inverted meaning;
wenzelm
parents:
40801
diff
changeset
|
358 |
controls folding of abbreviations. |
ca132ef44944
configuration option "show_abbrevs" supersedes print mode "no_abbrevs", with inverted meaning;
wenzelm
parents:
40801
diff
changeset
|
359 |
|
61493 | 360 |
\<^descr> @{antiquotation_option_def names_long}~\<open>= bool\<close> forces |
30397 | 361 |
names of types and constants etc.\ to be printed in their fully |
362 |
qualified internal form. |
|
27043 | 363 |
|
61493 | 364 |
\<^descr> @{antiquotation_option_def names_short}~\<open>= bool\<close> |
30397 | 365 |
forces names of types and constants etc.\ to be printed unqualified. |
366 |
Note that internalizing the output again in the current context may |
|
367 |
well yield a different result. |
|
27043 | 368 |
|
61493 | 369 |
\<^descr> @{antiquotation_option_def names_unique}~\<open>= bool\<close> |
30397 | 370 |
determines whether the printed version of qualified names should be |
371 |
made sufficiently long to avoid overlap with names declared further |
|
61493 | 372 |
back. Set to \<open>false\<close> for more concise output. |
27043 | 373 |
|
61493 | 374 |
\<^descr> @{antiquotation_option_def eta_contract}~\<open>= bool\<close> |
375 |
prints terms in \<open>\<eta>\<close>-contracted form. |
|
27043 | 376 |
|
61493 | 377 |
\<^descr> @{antiquotation_option_def display}~\<open>= bool\<close> indicates |
30397 | 378 |
if the text is to be output as multi-line ``display material'', |
379 |
rather than a small piece of text without line breaks (which is the |
|
380 |
default). |
|
27043 | 381 |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
382 |
In this mode the embedded entities are printed in the same style as |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
383 |
the main theory text. |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
384 |
|
61493 | 385 |
\<^descr> @{antiquotation_option_def break}~\<open>= bool\<close> controls |
30397 | 386 |
line breaks in non-display material. |
27043 | 387 |
|
61493 | 388 |
\<^descr> @{antiquotation_option_def quotes}~\<open>= bool\<close> indicates |
30397 | 389 |
if the output should be enclosed in double quotes. |
27043 | 390 |
|
61493 | 391 |
\<^descr> @{antiquotation_option_def mode}~\<open>= name\<close> adds \<open>name\<close> to the print mode to be used for presentation. Note that the |
30397 | 392 |
standard setup for {\LaTeX} output is already present by default, |
61493 | 393 |
including the modes \<open>latex\<close> and \<open>xsymbols\<close>. |
27043 | 394 |
|
61493 | 395 |
\<^descr> @{antiquotation_option_def margin}~\<open>= nat\<close> and |
396 |
@{antiquotation_option_def indent}~\<open>= nat\<close> change the margin |
|
30397 | 397 |
or indentation for pretty printing of display material. |
27043 | 398 |
|
61493 | 399 |
\<^descr> @{antiquotation_option_def goals_limit}~\<open>= nat\<close> |
51960
61ac1efe02c3
option "goals_limit", with more uniform description;
wenzelm
parents:
51057
diff
changeset
|
400 |
determines the maximum number of subgoals to be printed (for goal-based |
30397 | 401 |
antiquotation). |
27043 | 402 |
|
61493 | 403 |
\<^descr> @{antiquotation_option_def source}~\<open>= bool\<close> prints the |
30397 | 404 |
original source text of the antiquotation arguments, rather than its |
405 |
internal representation. Note that formal checking of |
|
406 |
@{antiquotation "thm"}, @{antiquotation "term"}, etc. is still |
|
407 |
enabled; use the @{antiquotation "text"} antiquotation for unchecked |
|
408 |
output. |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
409 |
|
61493 | 410 |
Regular \<open>term\<close> and \<open>typ\<close> antiquotations with \<open>source = false\<close> involve a full round-trip from the original source |
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
411 |
to an internalized logical entity back to a source form, according |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
412 |
to the syntax of the current context. Thus the printed output is |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
413 |
not under direct control of the author, it may even fluctuate a bit |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
414 |
as the underlying theory is changed later on. |
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
415 |
|
61493 | 416 |
In contrast, @{antiquotation_option source}~\<open>= true\<close> |
30397 | 417 |
admits direct printing of the given source text, with the desirable |
418 |
well-formedness check in the background, but without modification of |
|
419 |
the printed text. |
|
28749
99f6da3bbbf7
renamed "formal comments" to "document comments";
wenzelm
parents:
28747
diff
changeset
|
420 |
|
27043 | 421 |
|
61493 | 422 |
For Boolean flags, ``\<open>name = true\<close>'' may be abbreviated as |
423 |
``\<open>name\<close>''. All of the above flags are disabled by default, |
|
51057 | 424 |
unless changed specifically for a logic session in the corresponding |
61458 | 425 |
@{verbatim "ROOT"} file. |
426 |
\<close> |
|
27043 | 427 |
|
428 |
||
58618 | 429 |
section \<open>Markup via command tags \label{sec:tags}\<close> |
27043 | 430 |
|
58618 | 431 |
text \<open>Each Isabelle/Isar command may be decorated by additional |
28750 | 432 |
presentation tags, to indicate some modification in the way it is |
433 |
printed in the document. |
|
27043 | 434 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
435 |
@{rail \<open> |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
436 |
@{syntax_def tags}: ( tag * ) |
27043 | 437 |
; |
42596
6c621a9d612a
modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents:
40879
diff
changeset
|
438 |
tag: '%' (@{syntax ident} | @{syntax string}) |
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
439 |
\<close>} |
27043 | 440 |
|
28750 | 441 |
Some tags are pre-declared for certain classes of commands, serving |
442 |
as default markup if no tags are given in the text: |
|
27043 | 443 |
|
61421 | 444 |
\<^medskip> |
27043 | 445 |
\begin{tabular}{ll} |
61493 | 446 |
\<open>theory\<close> & theory begin/end \\ |
447 |
\<open>proof\<close> & all proof commands \\ |
|
448 |
\<open>ML\<close> & all commands involving ML code \\ |
|
27043 | 449 |
\end{tabular} |
61421 | 450 |
\<^medskip> |
27043 | 451 |
|
61421 | 452 |
The Isabelle document preparation system |
60270 | 453 |
@{cite "isabelle-system"} allows tagged command regions to be presented |
27043 | 454 |
specifically, e.g.\ to fold proof texts, or drop parts of the text |
455 |
completely. |
|
456 |
||
61493 | 457 |
For example ``@{command "by"}~\<open>%invisible auto\<close>'' causes |
458 |
that piece of proof to be treated as \<open>invisible\<close> instead of |
|
459 |
\<open>proof\<close> (the default), which may be shown or hidden |
|
27043 | 460 |
depending on the document setup. In contrast, ``@{command |
61493 | 461 |
"by"}~\<open>%visible auto\<close>'' forces this text to be shown |
27043 | 462 |
invariably. |
463 |
||
464 |
Explicit tag specifications within a proof apply to all subsequent |
|
465 |
commands of the same level of nesting. For example, ``@{command |
|
61493 | 466 |
"proof"}~\<open>%visible \<dots>\<close>~@{command "qed"}'' forces the whole |
467 |
sub-proof to be typeset as \<open>visible\<close> (unless some of its parts |
|
28750 | 468 |
are tagged differently). |
469 |
||
61421 | 470 |
\<^medskip> |
471 |
Command tags merely produce certain markup environments for |
|
28750 | 472 |
type-setting. The meaning of these is determined by {\LaTeX} |
40800
330eb65c9469
Parse.liberal_name for document antiquotations and attributes;
wenzelm
parents:
40255
diff
changeset
|
473 |
macros, as defined in @{file "~~/lib/texinputs/isabelle.sty"} or |
28750 | 474 |
by the document author. The Isabelle document preparation tools |
475 |
also provide some high-level options to specify the meaning of |
|
476 |
arbitrary tags to ``keep'', ``drop'', or ``fold'' the corresponding |
|
477 |
parts of the text. Logic sessions may also specify ``document |
|
478 |
versions'', where given tags are interpreted in some particular way. |
|
60270 | 479 |
Again see @{cite "isabelle-system"} for further details. |
58618 | 480 |
\<close> |
27043 | 481 |
|
482 |
||
58618 | 483 |
section \<open>Railroad diagrams\<close> |
42658 | 484 |
|
58618 | 485 |
text \<open> |
42658 | 486 |
\begin{matharray}{rcl} |
61493 | 487 |
@{antiquotation_def "rail"} & : & \<open>antiquotation\<close> \\ |
42658 | 488 |
\end{matharray} |
489 |
||
55113 | 490 |
@{rail \<open> |
59937 | 491 |
'rail' @{syntax text} |
55113 | 492 |
\<close>} |
42658 | 493 |
|
494 |
The @{antiquotation rail} antiquotation allows to include syntax |
|
495 |
diagrams into Isabelle documents. {\LaTeX} requires the style file |
|
59116 | 496 |
@{file "~~/lib/texinputs/railsetup.sty"}, which can be used via |
497 |
@{verbatim \<open>\usepackage{railsetup}\<close>} in @{verbatim "root.tex"}, for |
|
42658 | 498 |
example. |
499 |
||
500 |
The rail specification language is quoted here as Isabelle @{syntax |
|
55120 | 501 |
string} or text @{syntax "cartouche"}; it has its own grammar given |
502 |
below. |
|
42658 | 503 |
|
55120 | 504 |
\begingroup |
61474 | 505 |
\def\isasymnewline{\isatt{\isacharbackslash\isacharless newline\isachargreater}} |
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
506 |
@{rail \<open> |
42658 | 507 |
rule? + ';' |
508 |
; |
|
509 |
rule: ((identifier | @{syntax antiquotation}) ':')? body |
|
510 |
; |
|
511 |
body: concatenation + '|' |
|
512 |
; |
|
513 |
concatenation: ((atom '?'?) +) (('*' | '+') atom?)? |
|
514 |
; |
|
515 |
atom: '(' body? ')' | identifier | |
|
516 |
'@'? (string | @{syntax antiquotation}) | |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
517 |
'\<newline>' |
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
518 |
\<close>} |
55120 | 519 |
\endgroup |
42658 | 520 |
|
61493 | 521 |
The lexical syntax of \<open>identifier\<close> coincides with that of |
522 |
@{syntax ident} in regular Isabelle syntax, but \<open>string\<close> uses |
|
42658 | 523 |
single quotes instead of double quotes of the standard @{syntax |
55113 | 524 |
string} category. |
42658 | 525 |
|
61493 | 526 |
Each \<open>rule\<close> defines a formal language (with optional name), |
42658 | 527 |
using a notation that is similar to EBNF or regular expressions with |
528 |
recursion. The meaning and visual appearance of these rail language |
|
529 |
elements is illustrated by the following representative examples. |
|
530 |
||
61421 | 531 |
\<^item> Empty @{verbatim "()"} |
42658 | 532 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
533 |
@{rail \<open>()\<close>} |
42658 | 534 |
|
61421 | 535 |
\<^item> Nonterminal @{verbatim "A"} |
42658 | 536 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
537 |
@{rail \<open>A\<close>} |
42658 | 538 |
|
61421 | 539 |
\<^item> Nonterminal via Isabelle antiquotation |
42658 | 540 |
@{verbatim "@{syntax method}"} |
541 |
||
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
542 |
@{rail \<open>@{syntax method}\<close>} |
42658 | 543 |
|
61421 | 544 |
\<^item> Terminal @{verbatim "'xyz'"} |
42658 | 545 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
546 |
@{rail \<open>'xyz'\<close>} |
42658 | 547 |
|
61421 | 548 |
\<^item> Terminal in keyword style @{verbatim "@'xyz'"} |
42658 | 549 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
550 |
@{rail \<open>@'xyz'\<close>} |
42658 | 551 |
|
61421 | 552 |
\<^item> Terminal via Isabelle antiquotation |
42658 | 553 |
@{verbatim "@@{method rule}"} |
554 |
||
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
555 |
@{rail \<open>@@{method rule}\<close>} |
42658 | 556 |
|
61421 | 557 |
\<^item> Concatenation @{verbatim "A B C"} |
42658 | 558 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
559 |
@{rail \<open>A B C\<close>} |
42658 | 560 |
|
61421 | 561 |
\<^item> Newline inside concatenation |
55029
61a6bf7d4b02
clarified @{rail} syntax: prefer explicit \<newline> symbol;
wenzelm
parents:
54705
diff
changeset
|
562 |
@{verbatim "A B C \<newline> D E F"} |
42658 | 563 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
564 |
@{rail \<open>A B C \<newline> D E F\<close>} |
42658 | 565 |
|
61421 | 566 |
\<^item> Variants @{verbatim "A | B | C"} |
42658 | 567 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
568 |
@{rail \<open>A | B | C\<close>} |
42658 | 569 |
|
61421 | 570 |
\<^item> Option @{verbatim "A ?"} |
42658 | 571 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
572 |
@{rail \<open>A ?\<close>} |
42658 | 573 |
|
61421 | 574 |
\<^item> Repetition @{verbatim "A *"} |
42658 | 575 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
576 |
@{rail \<open>A *\<close>} |
42658 | 577 |
|
61421 | 578 |
\<^item> Repetition with separator @{verbatim "A * sep"} |
42658 | 579 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
580 |
@{rail \<open>A * sep\<close>} |
42658 | 581 |
|
61421 | 582 |
\<^item> Strict repetition @{verbatim "A +"} |
42658 | 583 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
584 |
@{rail \<open>A +\<close>} |
42658 | 585 |
|
61421 | 586 |
\<^item> Strict repetition with separator @{verbatim "A + sep"} |
42658 | 587 |
|
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
588 |
@{rail \<open>A + sep\<close>} |
58618 | 589 |
\<close> |
42658 | 590 |
|
591 |
||
58618 | 592 |
section \<open>Draft presentation\<close> |
27043 | 593 |
|
58618 | 594 |
text \<open> |
27043 | 595 |
\begin{matharray}{rcl} |
61493 | 596 |
@{command_def "display_drafts"}\<open>\<^sup>*\<close> & : & \<open>any \<rightarrow>\<close> \\ |
27043 | 597 |
\end{matharray} |
598 |
||
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
599 |
@{rail \<open> |
52549 | 600 |
@@{command display_drafts} (@{syntax name} +) |
55112
b1a5d603fd12
prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents:
55029
diff
changeset
|
601 |
\<close>} |
27043 | 602 |
|
61493 | 603 |
\<^descr> @{command "display_drafts"}~\<open>paths\<close> performs simple output of a |
52549 | 604 |
given list of raw source files. Only those symbols that do not require |
605 |
additional {\LaTeX} packages are displayed properly, everything else is left |
|
606 |
verbatim. |
|
58618 | 607 |
\<close> |
27043 | 608 |
|
609 |
end |