# HG changeset patch # User wenzelm # Date 1694440780 -7200 # Node ID 71536ae52b16c07b93af6b813a3a115be092cb2c # Parent 0aa741c670868074601faa1b275e7fb858055287 misc tuning; diff -r 0aa741c67086 -r 71536ae52b16 src/Doc/JEdit/JEdit.thy --- a/src/Doc/JEdit/JEdit.thy Sun Sep 10 19:31:35 2023 +0200 +++ b/src/Doc/JEdit/JEdit.thy Mon Sep 11 15:59:40 2023 +0200 @@ -1979,39 +1979,39 @@ \end{figure} The traditional batch-build works on the command-line, e.g.\ via - \<^verbatim>\isabelle build -o document\~\SESSION\ (see also \<^cite>\\\S3\ in - "isabelle-system"\). The corresponding session \<^verbatim>\ROOT\ entry determines + \<^verbatim>\isabelle build -o document\~\SESSION\, see also \<^cite>\\\S3\ in + "isabelle-system"\. The corresponding session \<^verbatim>\ROOT\ entry determines \isakeyword{theories} and \isakeyword{document\_files} for the overall {\LaTeX} job. The latter is run as a monolithic process, using all theories and taking contents from the file-system. In contrast, an interactive build within Isabelle/jEdit allows to select a - subset of theory sources, with contents taken from the PIDE editor model. - Beware that \isakeyword{document\_files} and the overall session + subset of theory sources, and contents are taken from the PIDE document + model. Beware that \isakeyword{document\_files} and the overall session specification are still taken from the \<^verbatim>\ROOT\ entry: that information is only processed on startup of Isabelle/jEdit, so changes to \<^verbatim>\ROOT\ require a restart. \<^medskip> The GUI elements of the \<^emph>\Document\ panel (\figref{fig:document}), and its sub-panels for \<^emph>\Input\ and \<^emph>\Output\ are described below (from left to - right). The screenshot of has two instances of the panel, to illustrate both - \<^emph>\Input\ and \<^emph>\Output\ for this explanation. + right). The screenshot of has two instances of the panel to illustrate both + \<^emph>\Input\ and \<^emph>\Output\ simultaneously. \<^item> The \<^emph>\session selector\ tells, which session should be the basis of the document build job. This determines, which theories may be selected in the - \<^emph>\Input\ tab (dynamically), and which \isakeyword{document\_files} should + \<^emph>\Input\ tab (dynamically) and which \isakeyword{document\_files} should be used (statically). \<^item> The \<^emph>\progress indicator\ provides some visual feedback on the document - build process. The ``spinning wheel'' is either active while waiting for - selected document theories to be processed in the Prover IDE, or while - {\LaTeX} tools are running. + build process. The ``spinning wheel'' is either active while processing + selected document theories in the Prover IDE, or while {\LaTeX} tools are + running. \<^item> The \<^emph>\Auto\ checkbox may be selected to say that the {\LaTeX} job should - be started automatically (after a timeout). This happens, whenever the + be started automatically (after a timeout). This happens whenever the selected theories have been fully processed in the Prover IDE (see also - the \<^emph>\Build\ botton). If successful, the resulting PDF will be shown - by an external browser (see also the \<^emph>\View\ button). + the \<^emph>\Build\ button). If successful, the resulting PDF will be shown by an + external browser (see also the \<^emph>\View\ button). \<^item> The \<^emph>\Build\ button invokes the {\LaTeX} job manually, when \<^emph>\Input\ theories have been fully processed. The \<^emph>\Output\ tab follows the stages @@ -2021,9 +2021,9 @@ \<^item> The \<^emph>\View\ button invokes an external browser application on the resulting PDF file: its location is always the same, given within the \<^verbatim>\$ISABELLE_HOME_USER\ directory. Multiple invocations should normally - refresh the viewer application, at the same document position as last + refresh the viewer application, with the same document position as last time. Beware that window focus handling depends on the application (and - the operating system): there may be conflicts with with the editor + the desktop environment): there may be conflicts with the editor window focus. \<^item> The \<^emph>\Input\ sub-panel is similar to the regular \<^emph>\Theories\ panel @@ -2039,20 +2039,20 @@ document model (that affects everything, not just document theories). Non-selected theories are turned into an (almost) empty {\LaTeX} source - file: formal \\<^cite>\ antiquotations (\<^cite>\"isabelle-isar-ref"\) are + file: formal \\<^cite>\ antiquotations \<^cite>\"isabelle-isar-ref"\ are included, everything else is left blank. Thus the {\LaTeX} and Bib{\TeX} - document setup should normally work, independently on the selected subset + document setup should normally work, independently of the selected subset of theories. References to sections or pages might be missing, though. - \<^item> The \<^emph>\Output\ sub-panel provides a structured view and the running build - process. Its \<^emph>\progress\ output consists of a two-level hierarchy of - messages. The outer level displays overall programs with timing - information. Hovering over the program name reveals the inner level with - program log information or error messages. - - The initial stage of \<^verbatim>\Creating directory\ shows a directory listing of - the {\LaTeX} job that has been generated from all document sources. This - may help to explore structural failures of the {\LaTeX} job. + \<^item> The \<^emph>\Output\ sub-panel provides a structured view of the running build + process. Its progress output consists of a two-level hierarchy of + messages. The outer level displays program names with timing information. + Hovering over some name reveals the inner level with program log + information or error messages. + + The initial stage of ``\<^verbatim>\Creating directory\'' shows a directory listing + of the {\LaTeX} job that has been generated from all document sources. + This may help to explore structural failures of the {\LaTeX} job. \