theory Readme

imports Base

begin

chapter {* Comments for Authors of the Cookbook *}

text {*

  \begin{itemize}

  \item You can include references to other Isabelle manuals using the 

  reference names from those manuals. To do this the following

  four latex commands are defined:

  \begin{center}

  \begin{tabular}{l|c|c}

   & Chapters & Sections\\\hline

  Implementation Manual & @{ML_text "\\ichcite{\<dots>}"} & @{ML_text "\\isccite{\<dots>}"}\\

  Isar Reference Manual & @{ML_text "\\rchcite{\<dots>}"} & @{ML_text "\\rsccite{\<dots>}"}\\

  \end{tabular}

  \end{center}

  So @{ML_text "\\ichcite{ch:logic}"} results in a reference for the chapter about logic 

  in the implementation manual, namely \ichcite{ch:logic}.

  \item There are various document antiquotations defined for the 

  Isabelle code and also that responses of the ML-compiler can be shown.

  \begin{itemize}

  @{text "@{ML_open \"a + b\" for a b}"}.

  \item[$\bullet$] {\bf @{text "@{ML_response \"\<dots>\" \"\<dots>\"}"}} The first

  expression is checked like in the antiquotation @{text "@{ML \"\<dots>\"}"}; the

  second is a pattern that specifies the result the first expression

  produces. This specification can contain @{text [quotes] "\<dots>"} for parts that

  can be omitted. The actual response will be checked against the

  specification. For example @{text "@{ML_response \"(1+2,3)\"

  \"(3,\<dots>)\"}"}. This antiquotation can only be used when the result can be

  constructed. It does not work when the code produces an exception or is an

  abstract datatype (like @{ML_type thm} or @{ML_type cterm}).

  \end{itemize}

  \item Functions and value bindings cannot be defined inside antiquotations; they need

  to be included inside \isacommand{ML} \isa{\isacharverbatimopen \ldots \isacharverbatimclose}

  environments. Some \LaTeX-hack, however, does not print the environment markers.

  \end{itemize}

*}

end