discontinued documentation of old browser;
authorwenzelm
Thu Dec 31 19:53:19 2015 +0100 (2015-12-31)
changeset 6201392a2372a226b
parent 62012 12d3edd62932
child 62014 446fcbadc6bf
discontinued documentation of old browser;
tuned;
src/Doc/ROOT
src/Doc/System/Basics.thy
src/Doc/System/Misc.thy
src/Doc/System/Presentation.thy
src/Doc/System/document/browser_screenshot.png
src/Doc/System/document/root.tex
src/Doc/manual.bib
     1.1 --- a/src/Doc/ROOT	Thu Dec 31 15:27:25 2015 +0100
     1.2 +++ b/src/Doc/ROOT	Thu Dec 31 19:53:19 2015 +0100
     1.3 @@ -370,7 +370,6 @@
     1.4    document_files (in "../Isar_Ref/document")
     1.5      "style.sty"
     1.6    document_files
     1.7 -    "browser_screenshot.png"
     1.8      "build"
     1.9      "root.tex"
    1.10  
     2.1 --- a/src/Doc/System/Basics.thy	Thu Dec 31 15:27:25 2015 +0100
     2.2 +++ b/src/Doc/System/Basics.thy	Thu Dec 31 19:53:19 2015 +0100
     2.3 @@ -35,15 +35,15 @@
     2.4  section \<open>Isabelle settings \label{sec:settings}\<close>
     2.5  
     2.6  text \<open>
     2.7 -  The Isabelle system heavily depends on the \<^emph>\<open>settings
     2.8 -  mechanism\<close>\indexbold{settings}. Essentially, this is a statically scoped
     2.9 -  collection of environment variables, such as @{setting ISABELLE_HOME},
    2.10 -  @{setting ML_SYSTEM}, @{setting ML_HOME}. These variables are \<^emph>\<open>not\<close>
    2.11 -  intended to be set directly from the shell, though. Isabelle employs a
    2.12 -  somewhat more sophisticated scheme of \<^emph>\<open>settings files\<close> --- one for
    2.13 -  site-wide defaults, another for additional user-specific modifications. With
    2.14 -  all configuration variables in clearly defined places, this scheme is more
    2.15 -  maintainable and user-friendly than global shell environment variables.
    2.16 +  The Isabelle system heavily depends on the \<^emph>\<open>settings mechanism\<close>.
    2.17 +  Essentially, this is a statically scoped collection of environment
    2.18 +  variables, such as @{setting ISABELLE_HOME}, @{setting ML_SYSTEM}, @{setting
    2.19 +  ML_HOME}. These variables are \<^emph>\<open>not\<close> intended to be set directly from the
    2.20 +  shell, though. Isabelle employs a somewhat more sophisticated scheme of
    2.21 +  \<^emph>\<open>settings files\<close> --- one for site-wide defaults, another for additional
    2.22 +  user-specific modifications. With all configuration variables in clearly
    2.23 +  defined places, this scheme is more maintainable and user-friendly than
    2.24 +  global shell environment variables.
    2.25  
    2.26    In particular, we avoid the typical situation where prospective users of a
    2.27    software package are told to put several things into their shell startup
    2.28 @@ -209,9 +209,8 @@
    2.29    is appended here, too.
    2.30  
    2.31    \<^descr>[@{setting_def ISABELLE_BROWSER_INFO}] is the directory where theory
    2.32 -  browser information (HTML text, graph data, and printable documents) is
    2.33 -  stored (see also \secref{sec:info}). The default value is @{file_unchecked
    2.34 -  "$ISABELLE_HOME_USER/browser_info"}.
    2.35 +  browser information is stored as HTML and PDF (see also \secref{sec:info}).
    2.36 +  The default value is @{file_unchecked "$ISABELLE_HOME_USER/browser_info"}.
    2.37  
    2.38    \<^descr>[@{setting_def ISABELLE_LOGIC}] specifies the default logic to load if none
    2.39    is given explicitely by the user. The default value is \<^verbatim>\<open>HOL\<close>.
     3.1 --- a/src/Doc/System/Misc.thy	Thu Dec 31 15:27:25 2015 +0100
     3.2 +++ b/src/Doc/System/Misc.thy	Thu Dec 31 19:53:19 2015 +0100
     3.3 @@ -12,155 +12,6 @@
     3.4  \<close>
     3.5  
     3.6  
     3.7 -section \<open>Theory graph browser \label{sec:browse}\<close>
     3.8 -
     3.9 -text \<open>
    3.10 -  The Isabelle graph browser is a general tool for visualizing dependency
    3.11 -  graphs. Certain nodes of the graph (i.e.\ theories) can be grouped together
    3.12 -  in ``directories'', whose contents may be hidden, thus enabling the user to
    3.13 -  collapse irrelevant portions of information. The browser is written in Java,
    3.14 -  it can be used both as a stand-alone application and as an applet.
    3.15 -\<close>
    3.16 -
    3.17 -
    3.18 -subsection \<open>Invoking the graph browser\<close>
    3.19 -
    3.20 -text \<open>
    3.21 -  The stand-alone version of the graph browser is wrapped up as @{tool_def
    3.22 -  browser}:
    3.23 -  @{verbatim [display]
    3.24 -\<open>Usage: isabelle browser [OPTIONS] [GRAPHFILE]
    3.25 -
    3.26 -  Options are:
    3.27 -    -b           Admin/build only
    3.28 -    -c           cleanup -- remove GRAPHFILE after use
    3.29 -    -o FILE      output to FILE (ps, eps, pdf)\<close>}
    3.30 -
    3.31 -  When no file name is specified, the browser automatically changes to the
    3.32 -  directory @{setting ISABELLE_BROWSER_INFO}.
    3.33 -
    3.34 -  \<^medskip>
    3.35 -  The \<^verbatim>\<open>-b\<close> option indicates that this is for administrative build only, i.e.\
    3.36 -  no browser popup if no files are given.
    3.37 -
    3.38 -  The \<^verbatim>\<open>-c\<close> option causes the input file to be removed after use.
    3.39 -
    3.40 -  The \<^verbatim>\<open>-o\<close> option indicates batch-mode operation, with the output written to
    3.41 -  the indicated file; note that \<^verbatim>\<open>pdf\<close> produces an \<^verbatim>\<open>eps\<close> copy as well.
    3.42 -
    3.43 -  \<^medskip>
    3.44 -  The applet version of the browser is part of the standard WWW theory
    3.45 -  presentation, see the link ``theory dependencies'' within each session
    3.46 -  index.
    3.47 -\<close>
    3.48 -
    3.49 -
    3.50 -subsection \<open>Using the graph browser\<close>
    3.51 -
    3.52 -text \<open>
    3.53 -  The browser's main window, which is shown in \figref{fig:browserwindow},
    3.54 -  consists of two sub-windows. In the left sub-window, the directory tree is
    3.55 -  displayed. The graph itself is displayed in the right sub-window.
    3.56 -
    3.57 -  \begin{figure}[ht]
    3.58 -  \includegraphics[width=\textwidth]{browser_screenshot}
    3.59 -  \caption{\label{fig:browserwindow} Browser main window}
    3.60 -  \end{figure}
    3.61 -\<close>
    3.62 -
    3.63 -
    3.64 -subsubsection \<open>The directory tree window\<close>
    3.65 -
    3.66 -text \<open>
    3.67 -  We describe the usage of the directory browser and the meaning of the
    3.68 -  different items in the browser window.
    3.69 -
    3.70 -  \<^item> A red arrow before a directory name indicates that the directory is
    3.71 -  currently ``folded'', i.e.~the nodes in this directory are collapsed to one
    3.72 -  single node. In the right sub-window, the names of nodes corresponding to
    3.73 -  folded directories are enclosed in square brackets and displayed in red
    3.74 -  color.
    3.75 -
    3.76 -  \<^item> A green downward arrow before a directory name indicates that the
    3.77 -  directory is currently ``unfolded''. It can be folded by clicking on the
    3.78 -  directory name. Clicking on the name for a second time unfolds the directory
    3.79 -  again. Alternatively, a directory can also be unfolded by clicking on the
    3.80 -  corresponding node in the right sub-window.
    3.81 -
    3.82 -  \<^item> Blue arrows stand before ordinary node names. When clicking on such a name
    3.83 -  (i.e.\ that of a theory), the graph display window focuses to the
    3.84 -  corresponding node. Double clicking invokes a text viewer window in which
    3.85 -  the contents of the theory file are displayed.
    3.86 -\<close>
    3.87 -
    3.88 -
    3.89 -subsubsection \<open>The graph display window\<close>
    3.90 -
    3.91 -text \<open>
    3.92 -  When pointing on an ordinary node, an upward and a downward arrow is shown.
    3.93 -  Initially, both of these arrows are green. Clicking on the upward or
    3.94 -  downward arrow collapses all predecessor or successor nodes, respectively.
    3.95 -  The arrow's color then changes to red, indicating that the predecessor or
    3.96 -  successor nodes are currently collapsed. The node corresponding to the
    3.97 -  collapsed nodes has the name ``\<^verbatim>\<open>[....]\<close>''. To uncollapse the nodes again,
    3.98 -  simply click on the red arrow or on the node with the name ``\<^verbatim>\<open>[....]\<close>''.
    3.99 -  Similar to the directory browser, the contents of theory files can be
   3.100 -  displayed by double clicking on the corresponding node.
   3.101 -\<close>
   3.102 -
   3.103 -
   3.104 -subsubsection \<open>The ``File'' menu\<close>
   3.105 -
   3.106 -text \<open>
   3.107 -  Due to Java Applet security restrictions this menu is only available in the
   3.108 -  full application version. The meaning of the menu items is as follows:
   3.109 -
   3.110 -  \<^descr>[Open \dots] Open a new graph file.
   3.111 -
   3.112 -  \<^descr>[Export to PostScript] Outputs the current graph in Postscript format,
   3.113 -  appropriately scaled to fit on one single sheet of A4 paper. The resulting
   3.114 -  file can be printed directly.
   3.115 -
   3.116 -  \<^descr>[Export to EPS] Outputs the current graph in Encapsulated Postscript
   3.117 -  format. The resulting file can be included in other documents.
   3.118 -
   3.119 -  \<^descr>[Quit] Quit the graph browser.
   3.120 -\<close>
   3.121 -
   3.122 -
   3.123 -subsection \<open>Syntax of graph definition files\<close>
   3.124 -
   3.125 -text \<open>
   3.126 -  A graph definition file has the following syntax:
   3.127 -
   3.128 -  \begin{center}\small
   3.129 -  \begin{tabular}{rcl}
   3.130 -    \<open>graph\<close> & \<open>=\<close> & \<open>{ vertex\<close>~\<^verbatim>\<open>;\<close>~\<open>}+\<close> \\
   3.131 -    \<open>vertex\<close> & \<open>=\<close> & \<open>vertex_name vertex_ID dir_name [\<close>~\<^verbatim>\<open>+\<close>~\<open>] path [\<close>~\<^verbatim>\<open><\<close>~\<open>|\<close>~\<^verbatim>\<open>>\<close>~\<open>] { vertex_ID }*\<close>
   3.132 -  \end{tabular}
   3.133 -  \end{center}
   3.134 -
   3.135 -  The meaning of the items in a vertex description is as follows:
   3.136 -
   3.137 -  \<^descr>[\<open>vertex_name\<close>] The name of the vertex.
   3.138 -
   3.139 -  \<^descr>[\<open>vertex_ID\<close>] The vertex identifier. Note that there may be several
   3.140 -  vertices with equal names, whereas identifiers must be unique.
   3.141 -
   3.142 -  \<^descr>[\<open>dir_name\<close>] The name of the ``directory'' the vertex should be placed in.
   3.143 -  A ``\<^verbatim>\<open>+\<close>'' sign after \<open>dir_name\<close> indicates that the nodes in the directory
   3.144 -  are initially visible. Directories are initially invisible by default.
   3.145 -
   3.146 -  \<^descr>[\<open>path\<close>] The path of the corresponding theory file. This is specified
   3.147 -  relatively to the path of the graph definition file.
   3.148 -
   3.149 -  \<^descr>[List of successor/predecessor nodes] A ``\<^verbatim>\<open><\<close>'' sign before the list means
   3.150 -  that successor nodes are listed, a ``\<^verbatim>\<open>>\<close>'' sign means that predecessor
   3.151 -  nodes are listed. If neither ``\<^verbatim>\<open><\<close>'' nor ``\<^verbatim>\<open>>\<close>'' is found, the browser
   3.152 -  assumes that successor nodes are listed.
   3.153 -\<close>
   3.154 -
   3.155 -
   3.156  section \<open>Resolving Isabelle components \label{sec:tool-components}\<close>
   3.157  
   3.158  text \<open>
     4.1 --- a/src/Doc/System/Presentation.thy	Thu Dec 31 15:27:25 2015 +0100
     4.2 +++ b/src/Doc/System/Presentation.thy	Thu Dec 31 19:53:19 2015 +0100
     4.3 @@ -51,11 +51,9 @@
     4.4  \<close>
     4.5  
     4.6  
     4.7 -section \<open>Generating theory browser information \label{sec:info}\<close>
     4.8 +section \<open>Generating HTML browser information \label{sec:info}\<close>
     4.9  
    4.10  text \<open>
    4.11 -  \index{theory browsing information|bold}
    4.12 -
    4.13    As a side-effect of building sessions, Isabelle is able to generate theory
    4.14    browsing information, including HTML documents that show the theory sources
    4.15    and the relationship with its ancestors and descendants. Besides the HTML
    4.16 @@ -65,24 +63,16 @@
    4.17    implicit tree structure of the session build hierarchy is \<^emph>\<open>not\<close> relevant
    4.18    for the presentation.
    4.19  
    4.20 -  Isabelle also generates graph files that represent the theory dependencies
    4.21 -  within a session. There is a graph browser Java applet embedded in the
    4.22 -  generated HTML pages, and also a stand-alone application that allows
    4.23 -  browsing theory graphs without having to start a WWW client first. The
    4.24 -  latter version also includes features such as generating Postscript files,
    4.25 -  which are not available in the applet version. See \secref{sec:browse} for
    4.26 -  further information.
    4.27 -
    4.28    \<^medskip>
    4.29 -  The easiest way to let Isabelle generate theory browsing information for
    4.30 -  existing sessions is to invoke @{tool build} with suitable options:
    4.31 +  To generate theory browsing information for an existing session, just invoke
    4.32 +  @{tool build} with suitable options:
    4.33    @{verbatim [display] \<open>isabelle build -o browser_info -v -c FOL\<close>}
    4.34  
    4.35    The presentation output will appear in \<^verbatim>\<open>$ISABELLE_BROWSER_INFO/FOL/FOL\<close> as
    4.36    reported by the above verbose invocation of the build process.
    4.37  
    4.38    Many Isabelle sessions (such as \<^verbatim>\<open>HOL-Library\<close> in @{file
    4.39 -  "~~/src/HOL/Library"}) also provide actual printable documents. These are
    4.40 +  "~~/src/HOL/Library"}) also provide printable documents in PDF. These are
    4.41    prepared automatically as well if enabled like this:
    4.42    @{verbatim [display] \<open>isabelle build -o browser_info -o document=pdf -v -c HOL-Library\<close>}
    4.43  
     5.1 Binary file src/Doc/System/document/browser_screenshot.png has changed
     6.1 --- a/src/Doc/System/document/root.tex	Thu Dec 31 15:27:25 2015 +0100
     6.2 +++ b/src/Doc/System/document/root.tex	Thu Dec 31 19:53:19 2015 +0100
     6.3 @@ -20,8 +20,7 @@
     6.4  
     6.5  \title{\includegraphics[scale=0.5]{isabelle} \\[4ex] The Isabelle System Manual}
     6.6  
     6.7 -\author{\emph{Makarius Wenzel} and \emph{Stefan Berghofer} \\
     6.8 -  TU M\"unchen}
     6.9 +\author{\emph{Makarius Wenzel}}
    6.10  
    6.11  \makeindex
    6.12  
     7.1 --- a/src/Doc/manual.bib	Thu Dec 31 15:27:25 2015 +0100
     7.2 +++ b/src/Doc/manual.bib	Thu Dec 31 19:53:19 2015 +0100
     7.3 @@ -1908,28 +1908,24 @@
     7.4    note = {\url{http://www.spass-prover.org/publications/spass.pdf}}}
     7.5  
     7.6  @manual{isabelle-system,
     7.7 -  author	= {Makarius Wenzel and Stefan Berghofer},
     7.8 -  title		= {The {Isabelle} System Manual},
     7.9 -  institution	= {TU Munich},
    7.10 -  note          = {\url{http://isabelle.in.tum.de/doc/system.pdf}}}
    7.11 +  author = {Makarius Wenzel},
    7.12 +  title = {The {Isabelle} System Manual},
    7.13 +  note = {\url{http://isabelle.in.tum.de/doc/system.pdf}}}
    7.14  
    7.15  @manual{isabelle-jedit,
    7.16 -  author	= {Makarius Wenzel},
    7.17 -  title		= {{Isabelle/jEdit}},
    7.18 -  institution	= {TU Munich},
    7.19 -  note          = {\url{http://isabelle.in.tum.de/doc/jedit.pdf}}}
    7.20 +  author = {Makarius Wenzel},
    7.21 +  title = {{Isabelle/jEdit}},
    7.22 +  note = {\url{http://isabelle.in.tum.de/doc/jedit.pdf}}}
    7.23  
    7.24  @manual{isabelle-isar-ref,
    7.25 -  author	= {Makarius Wenzel},
    7.26 -  title		= {The {Isabelle/Isar} Reference Manual},
    7.27 -  institution	= {TU Munich},
    7.28 -  note          = {\url{http://isabelle.in.tum.de/doc/isar-ref.pdf}}}
    7.29 +  author = {Makarius Wenzel},
    7.30 +  title = {The {Isabelle/Isar} Reference Manual},
    7.31 +  note = {\url{http://isabelle.in.tum.de/doc/isar-ref.pdf}}}
    7.32  
    7.33  @manual{isabelle-implementation,
    7.34 -  author	= {Makarius Wenzel},
    7.35 -  title		= {The {Isabelle/Isar} Implementation},
    7.36 -  institution	= {TU Munich},
    7.37 -  note          = {\url{http://isabelle.in.tum.de/doc/implementation.pdf}}}
    7.38 +  author = {Makarius Wenzel},
    7.39 +  title = {The {Isabelle/Isar} Implementation},
    7.40 +  note = {\url{http://isabelle.in.tum.de/doc/implementation.pdf}}}
    7.41  
    7.42  @InProceedings{Wenzel:1999:TPHOL,
    7.43    author = 	 {Markus Wenzel},