doc-src/TutorialI/tutorial.sty
author paulson
Thu, 26 Jul 2001 16:43:02 +0200
changeset 11456 7eb63f63e6c6
parent 11428 332347b9b942
child 11457 279da0358aa9
permissions -rw-r--r--
revisions and indexing
     1 % tutorial.sty : Isabelle Tutorial Page Layout
     2 %
     3 \typeout{Document Style tutorial. Released 9 July 2001}
     4 
     5 \hyphenation{Isa-belle man-u-script man-u-scripts ap-pen-dix mut-u-al-ly}
     6 \hyphenation{data-type data-types co-data-type co-data-types }
     7 
     8 %usage: \iflabelundefined{LABEL}{if not defined}{if defined}
     9 \newcommand{\iflabelundefined}[1]{\@ifundefined{r@#1}}
    10 
    11 
    12 %%%INDEXING  use isa-index to process the index
    13 
    14 \newcommand\seealso[2]{\emph{see also} #1}
    15 \usepackage{makeidx}
    16 
    17 %index, putting page numbers of definitions in boldface
    18 \def\bold#1{\textbf{#1}}
    19 \newcommand\fnote[1]{#1n}
    20 \newcommand\indexbold[1]{\index{#1|bold}}
    21 
    22 % The alternative to \protect\isa in the indexing macros is
    23 % \noexpand\noexpand \noexpand\isa
    24 % need TWO levels of \noexpand to delay the expansion of \isa:
    25 %  the \noexpand\noexpand will leave one \noexpand, to be given to the
    26 %  (still unexpanded) \isa token.  See TeX by Topic, page 122.
    27 
    28 %%%% for indexing constants, symbols, theorems, ...
    29 \newcommand\cdx[1]{\isa{#1}\index{#1@\protect\isa{#1} (constant)}}
    30 \newcommand\sdx[1]{\isa{#1}\index{#1@\protect\isa{#1} (symbol)}}
    31 
    32 \newcommand\tdx[1]{\isa{#1}\index{#1@\protect\isa{#1} (theorem)}}
    33 \newcommand\tdxbold[1]{\isa{#1}\index{#1@\protect\isa{#1} (theorem)|bold}}
    34 
    35 \newcommand\cldx[1]{\isa{#1}\index{#1@\protect\isa{#1} (class)}}
    36 \newcommand\tydx[1]{\textit{#1}\index{#1@\protect\isa{#1} (type)}}
    37 \newcommand\thydx[1]{\isa{#1}\index{#1@\protect\isa{#1} (theory)}}
    38 
    39 \newcommand\attrdx[1]{\isa{#1}\index{#1@\protect\isa{#1} (attribute)}}
    40 \newcommand\commdx[1]{\isacommand{#1}\index{#1@\protect\isacommand{#1}
    41 (command)}}
    42 \newcommand\methdx[1]{\isa{#1}\index{#1@\protect\isa{#1} (method)}}
    43 \newcommand\tooldx[1]{\isa{#1}\index{#1@\protect\isa{#1} (tool)}}
    44 \newcommand\settdx[1]{\isa{#1}\index{#1@\protect\isa{#1} (setting)}}
    45 
    46 %set argument in \bf font and index in ROMAN font (for definitions in text!)
    47 \newcommand\bfindex[1]{{\bf#1}\index{#1|bold}\@}
    48 
    49 \newcommand\rmindex[1]{{#1}\index{#1}\@}
    50 \newcommand\ttindex[1]{\texttt{#1}\index{#1@\texttt{#1}}\@}
    51 \newcommand\ttindexbold[1]{\texttt{#1}\index{#1@\texttt{#1}|bold}\@}
    52 
    53 %Commented-out the original versions to see what the index looks like without them.
    54 %   In any event, they need to use \isa or \protect\isa rather than \texttt.
    55 %%\newcommand{\indexboldpos}[2]{#1\index{#2@#1|bold}\@}
    56 %%\newcommand{\ttindexboldpos}[2]{\texttt{#1}\index{#2@\texttt{#1}|bold}\@}
    57 \newcommand{\indexboldpos}[2]{#1\@}
    58 \newcommand{\ttindexboldpos}[2]{\isa{#1}\@}
    59 
    60 %\newtheorem{theorem}{Theorem}[section]
    61 \newtheorem{Exercise}{Exercise}[section]
    62 \newenvironment{exercise}{\begin{Exercise}\rm}{\end{Exercise}}
    63 \newcommand{\ttlbr}{\texttt{[|}}
    64 \newcommand{\ttrbr}{\texttt{|]}}
    65 \newcommand{\ttor}{\texttt{|}}
    66 \newcommand{\ttall}{\texttt{!}}
    67 \newcommand{\ttuniquex}{\texttt{?!}}
    68 \newcommand{\ttEXU}{\texttt{EX!}}
    69 \newcommand{\ttAnd}{\texttt{!!}}
    70 
    71 \newcommand{\isasymimp}{\isasymlongrightarrow}
    72 \newcommand{\isasymImp}{\isasymLongrightarrow}
    73 \newcommand{\isasymFun}{\isasymRightarrow}
    74 \newcommand{\isasymuniqex}{\isamath{\exists!\,}}
    75 \renewcommand{\S}{Sect.\ts}
    76 
    77 \renewenvironment{isamarkuptxt}{\begin{isamarkuptext}}{\end{isamarkuptext}}
    78 
    79 \newif\ifremarks
    80 \newcommand{\REMARK}[1]{\ifremarks\marginpar{\raggedright\footnotesize#1}\fi}
    81 
    82 %names of Isabelle rules
    83 \newcommand{\rulename}[1]{\hfill(#1)}
    84 \newcommand{\rulenamedx}[1]{\hfill(#1\index{#1@\protect\isa{#1} (theorem)|bold})}
    85 
    86 %%%% meta-logical connectives
    87 
    88 \let\Forall=\bigwedge
    89 \let\Imp=\Longrightarrow
    90 \let\To=\Rightarrow
    91 \newcommand{\Var}[1]{{?\!#1}}
    92 
    93 %%% underscores as ordinary characters, not for subscripting
    94 %%  use @ or \sb for subscripting; use \at for @
    95 %%  only works in \tt font
    96 %%  must not make _ an active char; would make \ttindex fail!
    97 \gdef\underscoreoff{\catcode`\@=8\catcode`\_=\other}
    98 \gdef\underscoreon{\catcode`\_=8\makeatother}
    99 \chardef\other=12
   100 \chardef\at=`\@
   101 
   102 % alternative underscore
   103 \def\_{\leavevmode\kern.06em\vbox{\hrule height.2ex width.3em}\hskip0.1em}
   104 
   105 
   106 %%%% ``WARNING'' environment
   107 \def\dbend{\vtop to 0pt{\vss\hbox{\Huge\bf!}\vss}}
   108 \newenvironment{warn}{\medskip\medbreak\begingroup \clubpenalty=10000 
   109          \small %%WAS\baselineskip=0.9\baselineskip
   110          \noindent \hangindent\parindent \hangafter=-2 
   111          \hbox to0pt{\hskip-\hangindent\dbend\hfill}\ignorespaces}%
   112         {\par\endgroup\medbreak}
   113 
   114 
   115 %%%% Standard logical symbols
   116 \let\turn=\vdash
   117 \let\conj=\wedge
   118 \let\disj=\vee
   119 \let\imp=\rightarrow
   120 \let\bimp=\leftrightarrow
   121 \newcommand\all[1]{\forall#1.}  %quantification
   122 \newcommand\ex[1]{\exists#1.}
   123 \newcommand{\pair}[1]{\langle#1\rangle}
   124 
   125 \newcommand{\lparr}{\mathopen{(\!|}}
   126 \newcommand{\rparr}{\mathclose{|\!)}}
   127 \newcommand{\fs}{\mathpunct{,\,}}
   128 \newcommand{\ty}{\mathrel{::}}
   129 \newcommand{\asn}{\mathrel{:=}}
   130 \newcommand{\more}{\ldots}
   131 \newcommand{\record}[1]{\lparr #1 \rparr}
   132 \newcommand{\dtt}{\mathord.}
   133 
   134 \newcommand\lbrakk{\mathopen{[\![}}
   135 \newcommand\rbrakk{\mathclose{]\!]}}
   136 \newcommand\List[1]{\lbrakk#1\rbrakk}  %was \obj
   137 \newcommand\vpile[1]{\begin{array}{c}#1\end{array}}
   138 \newenvironment{matharray}[1]{\[\begin{array}{#1}}{\end{array}\]}
   139 \newcommand{\Text}[1]{\mbox{#1}}
   140 
   141 \DeclareMathSymbol{\dshsym}{\mathalpha}{letters}{"2D}
   142 \newcommand{\dsh}{\mathit{\dshsym}}
   143 
   144 \let\int=\cap
   145 \let\un=\cup
   146 \let\inter=\bigcap
   147 \let\union=\bigcup
   148 
   149 \def\ML{{\sc ml}}
   150 \def\AST{{\sc ast}}
   151 
   152 %macros to change the treatment of symbols
   153 \def\relsemicolon{\mathcode`\;="303B}   %treat ; like a relation
   154 \def\binperiod{\mathcode`\.="213A}   %treat . like a binary operator
   155 \def\binvert{\mathcode`\|="226A}     %treat | like a binary operator
   156 
   157 %redefinition of \sloppy and \fussy to use \emergencystretch
   158 \def\sloppy{\tolerance2000 \hfuzz.5pt \vfuzz.5pt \emergencystretch=15pt}
   159 \def\fussy{\tolerance200 \hfuzz.1pt \vfuzz.1pt \emergencystretch=0pt}
   160 
   161 %non-bf version of description
   162 \def\descrlabel#1{\hspace\labelsep #1}
   163 \def\descr{\list{}{\labelwidth\z@ \itemindent-\leftmargin\let\makelabel\descrlabel}}
   164 \let\enddescr\endlist
   165 
   166 % The mathcodes for the letters A, ..., Z, a, ..., z are changed to
   167 % generate text italic rather than math italic by default. This makes
   168 % multi-letter identifiers look better. The mathcode for character c
   169 % is set to |"7000| (variable family) + |"400| (text italic) + |c|.
   170 %
   171 \DeclareSymbolFont{italics}{\encodingdefault}{\rmdefault}{m}{it}%
   172 \def\@setmcodes#1#2#3{{\count0=#1 \count1=#3
   173         \loop \global\mathcode\count0=\count1 \ifnum \count0<#2
   174         \advance\count0 by1 \advance\count1 by1 \repeat}}
   175 \@setmcodes{`A}{`Z}{"7\hexnumber@\symitalics41}
   176 \@setmcodes{`a}{`z}{"7\hexnumber@\symitalics61}