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