src/Doc/Sugar/Sugar.thy
author nipkow
Mon, 28 Aug 2017 18:27:16 +0200
changeset 66527 7ca69030a2af
parent 66453 cc19f7ca2ed6
child 67406 23307fd33906
permissions -rw-r--r--
added eta_expansion and its documentation.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
15337
nipkow
parents:
diff changeset
     1
(*<*)
nipkow
parents:
diff changeset
     2
theory Sugar
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
     3
imports
66453
cc19f7ca2ed6 session-qualified theory imports: isabelle imports -U -i -d '~~/src/Benchmarks' -a;
wenzelm
parents: 64267
diff changeset
     4
  "HOL-Library.LaTeXsugar"
cc19f7ca2ed6 session-qualified theory imports: isabelle imports -U -i -d '~~/src/Benchmarks' -a;
wenzelm
parents: 64267
diff changeset
     5
  "HOL-Library.OptionalSugar"
15337
nipkow
parents:
diff changeset
     6
begin
61645
ae5e55d03e45 translation for conjunctive premises
nipkow
parents: 61594
diff changeset
     7
no_translations
ae5e55d03e45 translation for conjunctive premises
nipkow
parents: 61594
diff changeset
     8
  ("prop") "P \<and> Q \<Longrightarrow> R" <= ("prop") "P \<Longrightarrow> Q \<Longrightarrow> R"
15337
nipkow
parents:
diff changeset
     9
(*>*)
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    10
text{*
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    11
\section{Introduction}
15337
nipkow
parents:
diff changeset
    12
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    13
This document is for those Isabelle users who have mastered
15337
nipkow
parents:
diff changeset
    14
the art of mixing \LaTeX\ text and Isabelle theories and never want to
nipkow
parents:
diff changeset
    15
typeset a theorem by hand anymore because they have experienced the
64267
b9a1486e79be setsum -> sum
nipkow
parents: 63414
diff changeset
    16
bliss of writing \verb!@!\verb!{thm[display,mode=latex_sum] sum_Suc_diff [no_vars]}!
15337
nipkow
parents:
diff changeset
    17
and seeing Isabelle typeset it for them:
64267
b9a1486e79be setsum -> sum
nipkow
parents: 63414
diff changeset
    18
@{thm[display,mode=latex_sum] sum_Suc_diff[no_vars]}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    19
No typos, no omissions, no sweat.
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    20
If you have not experienced that joy, read Chapter 4, \emph{Presenting
58620
7435b6a3f72e more antiquotations;
wenzelm
parents: 56977
diff changeset
    21
Theories}, @{cite LNCS2283} first.
15337
nipkow
parents:
diff changeset
    22
nipkow
parents:
diff changeset
    23
If you have mastered the art of Isabelle's \emph{antiquotations},
nipkow
parents:
diff changeset
    24
i.e.\ things like the above \verb!@!\verb!{thm...}!, beware: in your vanity
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
    25
you may be tempted to think that all readers of the stunning
15337
nipkow
parents:
diff changeset
    26
documents you can now produce at the drop of a hat will be struck with
nipkow
parents:
diff changeset
    27
awe at the beauty unfolding in front of their eyes. Until one day you
nipkow
parents:
diff changeset
    28
come across that very critical of readers known as the ``common referee''.
nipkow
parents:
diff changeset
    29
He has the nasty habit of refusing to understand unfamiliar notation
nipkow
parents:
diff changeset
    30
like Isabelle's infamous @{text"\<lbrakk> \<rbrakk> \<Longrightarrow>"} no matter how many times you
nipkow
parents:
diff changeset
    31
explain it in your paper. Even worse, he thinks that using @{text"\<lbrakk>
nipkow
parents:
diff changeset
    32
\<rbrakk>"} for anything other than denotational semantics is a cardinal sin
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    33
that must be punished by instant rejection.
15337
nipkow
parents:
diff changeset
    34
nipkow
parents:
diff changeset
    35
nipkow
parents:
diff changeset
    36
This document shows you how to make Isabelle and \LaTeX\ cooperate to
nipkow
parents:
diff changeset
    37
produce ordinary looking mathematics that hides the fact that it was
15471
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    38
typeset by a machine. You merely need to load the right files:
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    39
\begin{itemize}
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    40
\item Import theory \texttt{LaTeXsugar} in the header of your own
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    41
theory.  You may also want bits of \texttt{OptionalSugar}, which you can
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    42
copy selectively into your own theory or import as a whole.  Both
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
    43
theories live in \texttt{HOL/Library}.
15378
b1c5add0a65e link to tar.gz
kleing
parents: 15373
diff changeset
    44
15471
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    45
\item Should you need additional \LaTeX\ packages (the text will tell
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    46
you so), you include them at the beginning of your \LaTeX\ document,
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
    47
typically in \texttt{root.tex}. For a start, you should
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
    48
\verb!\usepackage{amssymb}! --- otherwise typesetting
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
    49
@{prop[source]"\<not>(\<exists>x. P x)"} will fail because the AMS symbol
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
    50
@{text"\<nexists>"} is missing.
15471
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
    51
\end{itemize}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    52
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    53
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    54
\section{HOL syntax}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    55
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    56
\subsection{Logic}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    57
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    58
The formula @{prop[source]"\<not>(\<exists>x. P x)"} is typeset as @{prop"~(EX x. P x)"}.
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
    59
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
    60
The predefined constructs @{text"if"}, @{text"let"} and
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    61
@{text"case"} are set in sans serif font to distinguish them from
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    62
other functions. This improves readability:
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    63
\begin{itemize}
53015
a1119cf551e8 standardized symbols via "isabelle update_sub_sup", excluding src/Pure and src/Tools/WWW_Find;
wenzelm
parents: 49628
diff changeset
    64
\item @{term"if b then e\<^sub>1 else e\<^sub>2"} instead of @{text"if b then e\<^sub>1 else e\<^sub>2"}.
a1119cf551e8 standardized symbols via "isabelle update_sub_sup", excluding src/Pure and src/Tools/WWW_Find;
wenzelm
parents: 49628
diff changeset
    65
\item @{term"let x = e\<^sub>1 in e\<^sub>2"} instead of @{text"let x = e\<^sub>1 in e\<^sub>2"}.
a1119cf551e8 standardized symbols via "isabelle update_sub_sup", excluding src/Pure and src/Tools/WWW_Find;
wenzelm
parents: 49628
diff changeset
    66
\item @{term"case x of True \<Rightarrow> e\<^sub>1 | False \<Rightarrow> e\<^sub>2"} instead of\\
a1119cf551e8 standardized symbols via "isabelle update_sub_sup", excluding src/Pure and src/Tools/WWW_Find;
wenzelm
parents: 49628
diff changeset
    67
      @{text"case x of True \<Rightarrow> e\<^sub>1 | False \<Rightarrow> e\<^sub>2"}.
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    68
\end{itemize}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    69
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    70
\subsection{Sets}
15337
nipkow
parents:
diff changeset
    71
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    72
Although set syntax in HOL is already close to
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    73
standard, we provide a few further improvements:
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    74
\begin{itemize}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    75
\item @{term"{x. P}"} instead of @{text"{x. P}"}.
27688
397de75836a1 *** empty log message ***
nipkow
parents: 27093
diff changeset
    76
\item @{term"{}"} instead of @{text"{}"}, where
397de75836a1 *** empty log message ***
nipkow
parents: 27093
diff changeset
    77
 @{term"{}"} is also input syntax.
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    78
\item @{term"insert a (insert b (insert c M))"} instead of @{text"insert a (insert b (insert c M))"}.
56977
a33fe940a557 new syntax for card, normalized spacing for #
nipkow
parents: 56420
diff changeset
    79
\item @{term"card A"} instead of @{text"card A"}.
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    80
\end{itemize}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    81
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    82
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    83
\subsection{Lists}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    84
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
    85
If lists are used heavily, the following notations increase readability:
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    86
\begin{itemize}
27688
397de75836a1 *** empty log message ***
nipkow
parents: 27093
diff changeset
    87
\item @{term"x # xs"} instead of @{text"x # xs"},
397de75836a1 *** empty log message ***
nipkow
parents: 27093
diff changeset
    88
      where @{term"x # xs"} is also input syntax.
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    89
\item @{term"length xs"} instead of @{text"length xs"}.
15385
26b05d4bc21a improvements by Larry and Micheal Wahler
kleing
parents: 15378
diff changeset
    90
\item @{term"nth xs n"} instead of @{text"nth xs n"},
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    91
      the $n$th element of @{text xs}.
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
    92
22834
bf67f798f063 added test about "set" supression
nipkow
parents: 22329
diff changeset
    93
\item Human readers are good at converting automatically from lists to
30502
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
    94
sets. Hence \texttt{OptionalSugar} contains syntax for suppressing the
22834
bf67f798f063 added test about "set" supression
nipkow
parents: 22329
diff changeset
    95
conversion function @{const set}: for example, @{prop[source]"x \<in> set xs"}
bf67f798f063 added test about "set" supression
nipkow
parents: 22329
diff changeset
    96
becomes @{prop"x \<in> set xs"}.
bf67f798f063 added test about "set" supression
nipkow
parents: 22329
diff changeset
    97
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
    98
\item The @{text"@"} operation associates implicitly to the right,
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
    99
which leads to unpleasant line breaks if the term is too long for one
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   100
line. To avoid this, \texttt{OptionalSugar} contains syntax to group
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   101
@{text"@"}-terms to the left before printing, which leads to better
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   102
line breaking behaviour:
53015
a1119cf551e8 standardized symbols via "isabelle update_sub_sup", excluding src/Pure and src/Tools/WWW_Find;
wenzelm
parents: 49628
diff changeset
   103
@{term[display]"term\<^sub>0 @ term\<^sub>1 @ term\<^sub>2 @ term\<^sub>3 @ term\<^sub>4 @ term\<^sub>5 @ term\<^sub>6 @ term\<^sub>7 @ term\<^sub>8 @ term\<^sub>9 @ term\<^sub>1\<^sub>0"}
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   104
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   105
\end{itemize}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   106
15337
nipkow
parents:
diff changeset
   107
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   108
\subsection{Numbers}
30502
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   109
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   110
Coercions between numeric types are alien to mathematicians who
30502
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   111
consider, for example, @{typ nat} as a subset of @{typ int}.
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   112
\texttt{OptionalSugar} contains syntax for suppressing numeric coercions such
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   113
as @{const int} @{text"::"} @{typ"nat \<Rightarrow> int"}. For example,
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   114
@{term[source]"int 5"} is printed as @{term "int 5"}. Embeddings of types
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   115
@{typ nat}, @{typ int}, @{typ real} are covered; non-injective coercions such
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   116
as @{const nat} @{text"::"} @{typ"int \<Rightarrow> nat"} are not and should not be
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   117
hidden.
30502
b80d2621caee hiding numeric coercions in LaTeX
nipkow
parents: 27688
diff changeset
   118
15337
nipkow
parents:
diff changeset
   119
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   120
\section{Printing theorems}
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   121
61645
ae5e55d03e45 translation for conjunctive premises
nipkow
parents: 61594
diff changeset
   122
The @{prop "P \<Longrightarrow> Q \<Longrightarrow> R"} syntax is a bit idiosyncratic. If you would like
ae5e55d03e45 translation for conjunctive premises
nipkow
parents: 61594
diff changeset
   123
to avoid it, you can easily print the premises as a conjunction:
ae5e55d03e45 translation for conjunctive premises
nipkow
parents: 61594
diff changeset
   124
@{prop "P \<and> Q \<Longrightarrow> R"}. See \texttt{OptionalSugar} for the required ``code''.
ae5e55d03e45 translation for conjunctive premises
nipkow
parents: 61594
diff changeset
   125
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   126
\subsection{Question marks}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   127
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   128
If you print anything, especially theorems, containing
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   129
schematic variables they are prefixed with a question mark:
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   130
\verb!@!\verb!{thm conjI}! results in @{thm conjI}. Most of the time
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   131
you would rather not see the question marks. There is an attribute
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   132
\verb!no_vars! that you can attach to the theorem that turns its
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   133
schematic into ordinary free variables:
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   134
\begin{quote}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   135
\verb!@!\verb!{thm conjI[no_vars]}!\\
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   136
\showout @{thm conjI[no_vars]}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   137
\end{quote}
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   138
This \verb!no_vars! business can become a bit tedious.
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   139
If you would rather never see question marks, simply put
34877
ded5b770ec1c formal antiquotations for ML snippets; no "open" unsynchronized references
haftmann
parents: 33323
diff changeset
   140
\begin{quote}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   141
\verb!options [show_question_marks = false]!
34877
ded5b770ec1c formal antiquotations for ML snippets; no "open" unsynchronized references
haftmann
parents: 33323
diff changeset
   142
\end{quote}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   143
into the relevant \texttt{ROOT} file, just before the \texttt{theories} for that session.
33323
1932908057c7 small fixes
nipkow
parents: 32898
diff changeset
   144
The rest of this document is produced with this flag set to \texttt{false}.
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   145
*}
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   146
38980
af73cf0dc31f turned show_question_marks into proper configuration option;
wenzelm
parents: 38798
diff changeset
   147
(*<*)declare [[show_question_marks = false]](*>*)
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   148
24496
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   149
subsection {*Qualified names*}
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   150
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   151
text{* If there are multiple declarations of the same name, Isabelle prints
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   152
the qualified name, for example @{text "T.length"}, where @{text T} is the
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   153
theory it is defined in, to distinguish it from the predefined @{const[source]
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   154
"List.length"}. In case there is no danger of confusion, you can insist on
42669
04dfffda5671 more conventional naming scheme: names_long, names_short, names_unique;
wenzelm
parents: 42358
diff changeset
   155
short names (no qualifiers) by setting the \verb!names_short!
42358
b47d41d9f4b5 Name_Space: proper configuration options long_names, short_names, unique_names instead of former unsynchronized references;
wenzelm
parents: 42289
diff changeset
   156
configuration option in the context.
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   157
24496
65f3b37f80b7 added short_names explanation
nipkow
parents: 22834
diff changeset
   158
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   159
\subsection {Variable names\label{sec:varnames}}
16395
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   160
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   161
It sometimes happens that you want to change the name of a
16395
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   162
variable in a theorem before printing it. This can easily be achieved
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   163
with the help of Isabelle's instantiation attribute \texttt{where}:
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   164
\begin{quote}
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   165
\verb!@!\verb!{thm conjI[where P = \<phi> and Q = \<psi>]}!\\
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   166
\showout @{thm conjI[where P = \<phi> and Q = \<psi>]}
16395
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   167
\end{quote}
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   168
To support the ``\_''-notation for irrelevant variables
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   169
the constant \texttt{DUMMY} has been introduced:
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   170
\begin{quote}
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   171
\verb!@!\verb!{thm fst_conv[of _ DUMMY]}!\\
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   172
\showout @{thm fst_conv[of _ DUMMY]}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   173
\end{quote}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   174
As expected, the second argument has been replaced by ``\_'',
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   175
but the first argument is the ugly @{text "x1.0"}, a schematic variable
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   176
with suppressed question mark. Schematic variables that end in digits,
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   177
e.g. @{text"x1"}, are still printed with a trailing @{text".0"},
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   178
e.g. @{text"x1.0"}, their internal index. This can be avoided by
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   179
turning the last digit into a subscript: write \<^verbatim>\<open>x\<^sub>1\<close> and
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   180
obtain the much nicer @{text"x\<^sub>1"}. Alternatively, you can display trailing digits of
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   181
schematic and free variables as subscripts with the \texttt{sub} style:
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   182
\begin{quote}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   183
\verb!@!\verb!{thm (sub) fst_conv[of _ DUMMY]}!\\
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   184
\showout @{thm (sub) fst_conv[of _ DUMMY]}
16395
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   185
\end{quote}
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   186
The insertion of underscores can be automated with the \verb!dummy_pats! style:
36138
1faa0fc34174 advertise [rename_abs] attribute in LaTeXsugar -- wish I had known about this earier.
krauss
parents: 34890
diff changeset
   187
\begin{quote}
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   188
\verb!@!\verb!{thm (dummy_pats,sub) fst_conv}!\\
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   189
\showout @{thm (dummy_pats,sub) fst_conv}
36138
1faa0fc34174 advertise [rename_abs] attribute in LaTeXsugar -- wish I had known about this earier.
krauss
parents: 34890
diff changeset
   190
\end{quote}
63414
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   191
The theorem must be an equation. Then every schematic variable that occurs
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   192
on the left-hand but not the right-hand side is replaced by \texttt{DUMMY}.
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   193
This is convenient for displaying functional programs.
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   194
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   195
Variables that are bound by quantifiers or lambdas can be renamed
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   196
with the help of the attribute \verb!rename_abs!.
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   197
It expects a list of names or underscores, similar to the \texttt{of} attribute:
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   198
\begin{quote}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   199
\verb!@!\verb!{thm split_paired_All[rename_abs _ l r]}!\\
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   200
\showout @{thm split_paired_All[rename_abs _ l r]}
beb987127d0f new style dummy_pats
nipkow
parents: 61645
diff changeset
   201
\end{quote}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   202
66527
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   203
Sometimes Isabelle $\eta$-contracts terms, for example in the following definition:
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   204
*}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   205
fun eta where
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   206
"eta (x \<cdot> xs) = (\<forall>y \<in> set xs. x < y)"
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   207
text{*
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   208
\noindent
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   209
If you now print the defining equation, the result is not what you hoped for:
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   210
\begin{quote}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   211
\verb!@!\verb!{thm eta.simps}!\\
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   212
\showout @{thm eta.simps}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   213
\end{quote}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   214
In such situations you can put the abstractions back by explicitly $\eta$-expanding upon output:
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   215
\begin{quote}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   216
\verb!@!\verb!{thm (eta_expand z) eta.simps}!\\
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   217
\showout @{thm (eta_expand z) eta.simps}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   218
\end{quote}
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   219
Instead of a single variable \verb!z! you can give a whole list \verb!x y z!
7ca69030a2af added eta_expansion and its documentation.
nipkow
parents: 66453
diff changeset
   220
to perform multiple $\eta$-expansions.
16395
3446d2b6a19f documented DUMMY
nipkow
parents: 16175
diff changeset
   221
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   222
\subsection{Inference rules}
15337
nipkow
parents:
diff changeset
   223
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   224
To print theorems as inference rules you need to include Didier
58620
7435b6a3f72e more antiquotations;
wenzelm
parents: 56977
diff changeset
   225
R\'emy's \texttt{mathpartir} package~@{cite mathpartir}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   226
for typesetting inference rules in your \LaTeX\ file.
15337
nipkow
parents:
diff changeset
   227
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   228
Writing \verb!@!\verb!{thm[mode=Rule] conjI}! produces
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   229
@{thm[mode=Rule] conjI}, even in the middle of a sentence.
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   230
If you prefer your inference rule on a separate line, maybe with a name,
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   231
\begin{center}
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   232
@{thm[mode=Rule] conjI} {\sc conjI}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   233
\end{center}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   234
is produced by
15337
nipkow
parents:
diff changeset
   235
\begin{quote}
nipkow
parents:
diff changeset
   236
\verb!\begin{center}!\\
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   237
\verb!@!\verb!{thm[mode=Rule] conjI} {\sc conjI}!\\
15337
nipkow
parents:
diff changeset
   238
\verb!\end{center}!
nipkow
parents:
diff changeset
   239
\end{quote}
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   240
It is not recommended to use the standard \texttt{display} option
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   241
together with \texttt{Rule} because centering does not work and because
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   242
the line breaking mechanisms of \texttt{display} and \texttt{mathpartir} can
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   243
clash.
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   244
15337
nipkow
parents:
diff changeset
   245
Of course you can display multiple rules in this fashion:
nipkow
parents:
diff changeset
   246
\begin{quote}
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   247
\verb!\begin{center}!\\
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   248
\verb!@!\verb!{thm[mode=Rule] conjI} {\sc conjI} \\[1ex]!\\
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   249
\verb!@!\verb!{thm[mode=Rule] conjE} {\sc disjI$_1$} \qquad!\\
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   250
\verb!@!\verb!{thm[mode=Rule] disjE} {\sc disjI$_2$}!\\
15337
nipkow
parents:
diff changeset
   251
\verb!\end{center}!
nipkow
parents:
diff changeset
   252
\end{quote}
nipkow
parents:
diff changeset
   253
yields
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   254
\begin{center}\small
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   255
@{thm[mode=Rule] conjI} {\sc conjI} \\[1ex]
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   256
@{thm[mode=Rule] disjI1} {\sc disjI$_1$} \qquad
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   257
@{thm[mode=Rule] disjI2} {\sc disjI$_2$}
15337
nipkow
parents:
diff changeset
   258
\end{center}
nipkow
parents:
diff changeset
   259
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   260
The \texttt{mathpartir} package copes well if there are too many
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   261
premises for one line:
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   262
\begin{center}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   263
@{prop[mode=Rule] "\<lbrakk> A \<longrightarrow> B; B \<longrightarrow> C; C \<longrightarrow> D; D \<longrightarrow> E; E \<longrightarrow> F; F \<longrightarrow> G;
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   264
 G \<longrightarrow> H; H \<longrightarrow> I; I \<longrightarrow> J; J \<longrightarrow> K \<rbrakk> \<Longrightarrow> A \<longrightarrow> K"}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   265
\end{center}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   266
15471
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
   267
Limitations: 1. Premises and conclusion must each not be longer than
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
   268
the line.  2. Premises that are @{text"\<Longrightarrow>"}-implications are again
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
   269
displayed with a horizontal line, which looks at least unusual.
e7f069887ec2 *** empty log message ***
nipkow
parents: 15428
diff changeset
   270
22329
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   271
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   272
In case you print theorems without premises no rule will be printed by the
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   273
\texttt{Rule} print mode. However, you can use \texttt{Axiom} instead:
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   274
\begin{quote}
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   275
\verb!\begin{center}!\\
22329
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   276
\verb!@!\verb!{thm[mode=Axiom] refl} {\sc refl}! \\
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   277
\verb!\end{center}!
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   278
\end{quote}
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   279
yields
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   280
\begin{center}
22329
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   281
@{thm[mode=Axiom] refl} {\sc refl} 
e4325ce4e0c4 added example for print-mode Axiom
schirmer
parents: 21558
diff changeset
   282
\end{center}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   283
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   284
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   285
\subsection{Displays and font sizes}
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   286
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   287
When displaying theorems with the \texttt{display} option, for example as in
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   288
\verb!@!\verb!{thm[display] refl}! @{thm[display] refl} the theorem is
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   289
set in small font. It uses the \LaTeX-macro \verb!\isastyle!,
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   290
which is also the style that regular theory text is set in, e.g. *}
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   291
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   292
lemma "t = t"
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   293
(*<*)oops(*>*)
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   294
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   295
text{* \noindent Otherwise \verb!\isastyleminor! is used,
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   296
which does not modify the font size (assuming you stick to the default
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   297
\verb!\isabellestyle{it}! in \texttt{root.tex}). If you prefer
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   298
normal font size throughout your text, include
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   299
\begin{quote}
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   300
\verb!\renewcommand{\isastyle}{\isastyleminor}!
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   301
\end{quote}
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   302
in \texttt{root.tex}. On the other hand, if you like the small font,
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   303
just put \verb!\isastyle! in front of the text in question,
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   304
e.g.\ at the start of one of the center-environments above.
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   305
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   306
The advantage of the display option is that you can display a whole
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   307
list of theorems in one go. For example,
46187
f009e0fe8643 updated example -- List.foldl is no longer defined via primrec;
wenzelm
parents: 42669
diff changeset
   308
\verb!@!\verb!{thm[display] append.simps}!
f009e0fe8643 updated example -- List.foldl is no longer defined via primrec;
wenzelm
parents: 42669
diff changeset
   309
generates @{thm[display] append.simps}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   310
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   311
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   312
\subsection{If-then}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   313
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   314
If you prefer a fake ``natural language'' style you can produce
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   315
the body of
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   316
\newtheorem{theorem}{Theorem}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   317
\begin{theorem}
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   318
@{thm[mode=IfThen] le_trans}
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   319
\end{theorem}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   320
by typing
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   321
\begin{quote}
15689
621bd0d8048f section on qmark
nipkow
parents: 15673
diff changeset
   322
\verb!@!\verb!{thm[mode=IfThen] le_trans}!
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   323
\end{quote}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   324
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   325
In order to prevent odd line breaks, the premises are put into boxes.
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   326
At times this is too drastic:
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   327
\begin{theorem}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   328
@{prop[mode=IfThen] "longpremise \<Longrightarrow> longerpremise \<Longrightarrow> P(f(f(f(f(f(f(f(f(f(x)))))))))) \<Longrightarrow> longestpremise \<Longrightarrow> conclusion"}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   329
\end{theorem}
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   330
In which case you should use \texttt{IfThenNoBox} instead of
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   331
\texttt{IfThen}:
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   332
\begin{theorem}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   333
@{prop[mode=IfThenNoBox] "longpremise \<Longrightarrow> longerpremise \<Longrightarrow> P(f(f(f(f(f(f(f(f(f(x)))))))))) \<Longrightarrow> longestpremise \<Longrightarrow> conclusion"}
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   334
\end{theorem}
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   335
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   336
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   337
\subsection{Doing it yourself\label{sec:yourself}}
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   338
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   339
If for some reason you want or need to present theorems your
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   340
own way, you can extract the premises and the conclusion explicitly
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   341
and combine them as you like:
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   342
\begin{itemize}
32891
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   343
\item \verb!@!\verb!{thm (prem 1)! $thm$\verb!}!
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   344
prints premise 1 of $thm$.
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   345
\item \verb!@!\verb!{thm (concl)! $thm$\verb!}!
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   346
prints the conclusion of $thm$.
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   347
\end{itemize}
32891
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   348
For example, ``from @{thm (prem 2) conjI} and
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   349
@{thm (prem 1) conjI} we conclude @{thm (concl) conjI}''
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   350
is produced by
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   351
\begin{quote}
32891
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   352
\verb!from !\verb!@!\verb!{thm (prem 2) conjI}! \verb!and !\verb!@!\verb!{thm (prem 1) conjI}!\\
d403b99287ff new generalized concept for term styles
haftmann
parents: 32833
diff changeset
   353
\verb!we conclude !\verb!@!\verb!{thm (concl) conjI}!
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   354
\end{quote}
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   355
Thus you can rearrange or hide premises and typeset the theorem as you like.
32898
e871d897969c term styles also cover antiquotations term_type and typeof
haftmann
parents: 32891
diff changeset
   356
Styles like \verb!(prem 1)! are a general mechanism explained
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   357
in \S\ref{sec:styles}.
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   358
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   359
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   360
\subsection{Patterns}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   361
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   362
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   363
In \S\ref{sec:varnames} we shows how to create patterns containing ``@{term DUMMY}''.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   364
You can drive this game even further and extend the syntax of let
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   365
bindings such that certain functions like @{term fst}, @{term hd}, 
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   366
etc.\ are printed as patterns. \texttt{OptionalSugar} provides the following:
16153
999ca183b4c7 \nexists und premsise1 .. 9
nipkow
parents: 16076
diff changeset
   367
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   368
\begin{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   369
\begin{tabular}{l@ {~~produced by~~}l}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   370
@{term "let x = fst p in t"} & \verb!@!\verb!{term "let x = fst p in t"}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   371
@{term "let x = snd p in t"} & \verb!@!\verb!{term "let x = snd p in t"}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   372
@{term "let x = hd xs in t"} & \verb!@!\verb!{term "let x = hd xs in t"}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   373
@{term "let x = tl xs in t"} & \verb!@!\verb!{term "let x = tl xs in t"}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   374
@{term "let x = the y in t"} & \verb!@!\verb!{term "let x = the y in t"}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   375
\end{tabular}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   376
\end{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   377
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   378
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   379
\section {Styles\label{sec:styles}}
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   380
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   381
The \verb!thm! antiquotation works nicely for single theorems, but
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   382
sets of equations as used in definitions are more difficult to
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   383
typeset nicely: people tend to prefer aligned @{text "="} signs.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   384
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   385
To deal with such cases where it is desirable to dive into the structure
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   386
of terms and theorems, Isabelle offers antiquotations featuring ``styles'':
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   387
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   388
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   389
\verb!@!\verb!{thm (style) thm}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   390
\verb!@!\verb!{prop (style) thm}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   391
\verb!@!\verb!{term (style) term}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   392
\verb!@!\verb!{term_type (style) term}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   393
\verb!@!\verb!{typeof (style) term}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   394
\end{quote}
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   395
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   396
 A ``style'' is a transformation of a term. There are predefined
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   397
 styles, namely \verb!lhs! and \verb!rhs!, \verb!prem! with one argument, and \verb!concl!.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   398
For example, the output
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   399
\begin{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   400
\begin{tabular}{l@ {~~@{text "="}~~}l}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   401
@{thm (lhs) append_Nil} & @{thm (rhs) append_Nil}\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   402
@{thm (lhs) append_Cons} & @{thm (rhs) append_Cons}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   403
\end{tabular}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   404
\end{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   405
is produced by the following code:
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   406
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   407
  \verb!\begin{center}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   408
  \verb!\begin{tabular}{l@ {~~!\verb!@!\verb!{text "="}~~}l}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   409
  \verb!@!\verb!{thm (lhs) append_Nil} & @!\verb!{thm (rhs) append_Nil}\\!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   410
  \verb!@!\verb!{thm (lhs) append_Cons} & @!\verb!{thm (rhs) append_Cons}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   411
  \verb!\end{tabular}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   412
  \verb!\end{center}!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   413
\end{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   414
Note the space between \verb!@! and \verb!{! in the tabular argument.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   415
It prevents Isabelle from interpreting \verb!@ {~~...~~}! 
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   416
as an antiquotation. The styles \verb!lhs! and \verb!rhs!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   417
extract the left hand side (or right hand side respectively) from the
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   418
conclusion of propositions consisting of a binary operator
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   419
(e.~g.~@{text "="}, @{text "\<equiv>"}, @{text "<"}).
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   420
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   421
Likewise, \verb!concl! may be used as a style to show just the
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   422
conclusion of a proposition. For example, take \verb!hd_Cons_tl!:
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   423
\begin{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   424
  @{thm hd_Cons_tl}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   425
\end{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   426
To print just the conclusion,
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   427
\begin{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   428
  @{thm (concl) hd_Cons_tl}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   429
\end{center}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   430
type
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   431
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   432
  \verb!\begin{center}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   433
  \verb!@!\verb!{thm (concl) hd_Cons_tl}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   434
  \verb!\end{center}!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   435
\end{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   436
Beware that any options must be placed \emph{before} the style, as in this example.
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   437
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   438
Further use cases can be found in \S\ref{sec:yourself}.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   439
If you are not afraid of ML, you may also define your own styles.
55837
154855d9a564 clarified names of antiquotations and markup;
wenzelm
parents: 55417
diff changeset
   440
Have a look at module @{ML_structure Term_Style}.
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   441
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   442
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   443
\section {Proofs}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   444
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   445
Full proofs, even if written in beautiful Isar style, are
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   446
likely to be too long and detailed to be included in conference
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   447
papers, but some key lemmas might be of interest.
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   448
It is usually easiest to put them in figures like the one in Fig.\
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   449
\ref{fig:proof}. This was achieved with the \isakeyword{text\_raw} command:
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   450
*}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   451
text_raw {*
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   452
  \begin{figure}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   453
  \begin{center}\begin{minipage}{0.6\textwidth}  
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   454
  \isastyleminor\isamarkuptrue
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   455
*}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   456
lemma True
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   457
proof -
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   458
  -- "pretty trivial"
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   459
  show True by force
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   460
qed
15428
3f1a674b7ec7 suggestions by Jeremy Siek
kleing
parents: 15385
diff changeset
   461
text_raw {*    
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   462
  \end{minipage}\end{center}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   463
  \caption{Example proof in a figure.}\label{fig:proof}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   464
  \end{figure}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   465
*}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   466
text {*
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   467
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   468
\begin{quote}
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   469
\small
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   470
\verb!text_raw {!\verb!*!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   471
\verb!  \begin{figure}!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   472
\verb!  \begin{center}\begin{minipage}{0.6\textwidth}!\\
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   473
\verb!  \isastyleminor\isamarkuptrue!\\
15366
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   474
\verb!*!\verb!}!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   475
\verb!lemma True!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   476
\verb!proof -!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   477
\verb!  -- "pretty trivial"!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   478
\verb!  show True by force!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   479
\verb!qed!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   480
\verb!text_raw {!\verb!*!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   481
\verb!  \end{minipage}\end{center}!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   482
\verb!  \caption{Example proof in a figure.}\label{fig:proof}!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   483
\verb!  \end{figure}!\\
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   484
\verb!*!\verb!}!
e6f595009734 more sugar
kleing
parents: 15342
diff changeset
   485
\end{quote}
24497
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   486
7840f760a744 explained \isatstyle(minor)
nipkow
parents: 24496
diff changeset
   487
Other theory text, e.g.\ definitions, can be put in figures, too.
15342
13bd3d12ec2f *** empty log message ***
nipkow
parents: 15337
diff changeset
   488
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   489
\section{Theory snippets}
15917
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   490
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   491
This section describes how to include snippets of a theory text in some other \LaTeX\ document.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   492
The typical scenario is that the description of your theory is not part of the theory text but
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   493
a separate document that antiquotes bits of the theory. This works well for terms and theorems
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   494
but there are no antiquotations, for example, for function definitions or proofs. Even if there are antiquotations,
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   495
the output is usually a reformatted (by Isabelle) version of the input and may not look like
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   496
you wanted it to look. Here is how to include a snippet of theory text (in \LaTeX\ form) in some
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   497
other \LaTeX\ document, in 4 easy steps. Beware that these snippets are not processed by
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   498
any antiquotation mechanism: the resulting \LaTeX\ text is more or less exactly what you wrote
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   499
in the theory, without any added sugar.
15917
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   500
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   501
\subsection{Theory markup}
15917
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   502
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   503
Include some markers at the beginning and the end of the theory snippet you want to cut out.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   504
You have to place the following lines before and after the snippet, where snippets must always be
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   505
consecutive lines of theory text:
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   506
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   507
\verb!\text_raw{!\verb!*\snip{!\emph{snippetname}\verb!}{1}{2}{%*!\verb!}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   508
\emph{theory text}\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   509
\verb!\text_raw{!\verb!*!\verb!}%endsnip*!\verb!}!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   510
\end{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   511
where \emph{snippetname} should be a unique name for the snippet. The numbers \texttt{1}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   512
and \texttt{2} are explained in a moment.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   513
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   514
\subsection{Generate the \texttt{.tex} file}
15917
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   515
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   516
Run your theory \texttt{T} with the \texttt{isabelle} \texttt{build} tool
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   517
to generate the \LaTeX-file \texttt{T.tex} which is needed for the next step,
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   518
extraction of marked snippets.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   519
You may also want to process \texttt{T.tex} to generate a pdf document.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   520
This requires a definition of \texttt{\char`\\snippet}:
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   521
\begin{verbatim}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   522
\newcommand{\repeatisanl}[1]
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   523
  {\ifnum#1=0\else\isanewline\repeatisanl{\numexpr#1-1}\fi}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   524
\newcommand{\snip}[4]{\repeatisanl#2#4\repeatisanl#3}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   525
\end{verbatim}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   526
Parameter 2 and 3 of \texttt{\char`\\snippet} are numbers (the \texttt{1}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   527
and \texttt{2} above) and determine how many newlines are inserted before and after the snippet.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   528
Unfortunately \texttt{text\_raw} eats up all preceding and following newlines
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   529
and they have to be inserted again in this manner. Otherwise the document generated from \texttt{T.tex}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   530
will look ugly around the snippets. It can take some iterations to get the number of required
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   531
newlines exactly right.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   532
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   533
\subsection{Extract marked snippets}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   534
\label{subsec:extract}
15917
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   535
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   536
Extract the marked bits of text with a shell-level script, e.g.
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   537
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   538
\verb!sed -n '/\\snip{/,/endsnip/p' T.tex > !\emph{snippets}\verb!.tex!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   539
\end{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   540
File \emph{snippets}\texttt{.tex} (the name is arbitrary) now contains a sequence of blocks like this
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   541
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   542
\verb!\snip{!\emph{snippetname}\verb!}{1}{2}{%!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   543
\emph{theory text}\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   544
\verb!}%endsnip!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   545
\end{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   546
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   547
\subsection{Including snippets}
17031
ffa73448025e added hint for position of aqu options in connection with styles
haftmann
parents: 16395
diff changeset
   548
49239
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   549
In the preamble of the document where the snippets are to be used you define \texttt{\char`\\snip}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   550
and input \emph{snippets}\texttt{.tex}:
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   551
\begin{verbatim}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   552
\newcommand{\snip}[4]
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   553
  {\expandafter\newcommand\csname #1\endcsname{#4}}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   554
\input{snippets}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   555
\end{verbatim}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   556
This definition of \texttt{\char`\\snip} simply has the effect of defining for each snippet
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   557
\emph{snippetname} a \LaTeX\ command \texttt{\char`\\}\emph{snippetname}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   558
that produces the corresponding snippet text. In the body of your document you can display that text
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   559
like this:
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   560
\begin{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   561
\verb!\begin{isabelle}!\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   562
\texttt{\char`\\}\emph{snippetname}\\
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   563
\verb!\end{isabelle}!
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   564
\end{quote}
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   565
The \texttt{isabelle} environment is the one defined in the standard file
fdac10715b6b added snippets
nipkow
parents: 48985
diff changeset
   566
\texttt{isabelle.sty} which most likely you are loading anyway.
49628
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   567
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   568
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   569
\section{Antiquotation}
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   570
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   571
You want to show a constant and its type? Instead of going
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   572
\verb!@!\verb!{const myconst}! \verb!@!\verb!{text "::"}! \verb!@!\verb!{typeof myconst}!,
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   573
you can just write \verb!@!\verb!{const_typ myconst}! using the new antiquotation
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   574
\texttt{const\_typ} defined in \texttt{LaTeXsugar}. For example,
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   575
\verb!@!\verb!{const_typ length}! produces @{const_typ length}.
8262d35eff20 new antiquotation const_typ
nipkow
parents: 49239
diff changeset
   576
15917
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   577
*}
cd4983c76548 Added short description of thm_style and term_style antiquotation
haftmann
parents: 15689
diff changeset
   578
15337
nipkow
parents:
diff changeset
   579
(*<*)
nipkow
parents:
diff changeset
   580
end
16175
nipkow
parents: 16167
diff changeset
   581
(*>*)