[manual] Add latest new features; formatting; misc

Added: * auto hide console (r793) * Settings/resources dialog (r782) * functionalized status bar widgets (r767) * "Reload using selected encoding" (r797) Formating: * Added microtype package * Removed hard wrap dialog image (orphaned) * Misc changes to avoid stacks, rivers, improper breaks, ... Added zipping of html help to `make dist` git-svn-id: http://texworks.googlecode.com/svn/manual@814 9a2a4a0b-1251-0410-9248-99fc04669920
TeXworks · May 9, 2011 · 33bb4d5 · 33bb4d5
1 parent 42bb8d0
commit 33bb4d5
Show file tree

Hide file tree

Showing 16 changed files with 69 additions and 55 deletions.
diff --git a/src/Makefile b/src/Makefile
@@ -2,6 +2,7 @@ LANGS = $(patsubst %/,manual-%,$(wildcard */))
 DISTLANGS = $(patsubst manual-%,dist-%,$(LANGS))
 CLEANLANGS = $(patsubst manual-%,clean-%,$(LANGS))
 DISTCLEANLANGS = $(patsubst manual-%,dist-clean-%,$(LANGS))
+REVNO = $(shell LANG=C; svn info | grep '^Revision: ' | sed 's/Revision: //')
 
 .PHONY : all clean dist dist-clean $(LANGS) $(DISTLANGS) $(CLEANLANGS) $(DISTCLEANLANGS)
 
@@ -10,6 +11,7 @@ all : $(LANGS)
 clean : $(CLEANLANGS)
 
 dist : $(DISTLANGS)
+	cd ../html && zip -r TeXworks-manual-html-r$(REVNO).zip TeXworks-manual
 
 dist-clean : $(DISTCLEANLANGS)
 

diff --git a/src/en/README b/src/en/README
@@ -22,15 +22,15 @@ distribution such as:
 Make sure you have the following required LaTeX packages installed:
 	amsmath, amssymb, array, babel, booktabs, calc, color, fancyhdr, fancyvrb,
 	fncychap, fontenc, footmisc, framed, graphicx, hyperref, idxlayout,
-	inputenc, keystroke, lmodern, longtable, makeidx, needspace, sectsty,
-	tocbibind, upquote, url, wrapfig,
+	inputenc, keystroke, lmodern, longtable, makeidx, microtype, needspace,
+	sectsty, tocbibind, upquote, url, wrapfig,
 and the ZapfChancery font.
 
 When using TeXLive, these can be installed by running
 	tlmgr install amsfonts amsmath babel booktabs fancyhdr fancyvrb fncychap \
 	              footmisc framed graphics hyperref idxlayout keystroke latex \
-	              lm needspace sectsty tocbibind tools upquote url wrapfig \
-	              zapfchan
+	              lm microtype needspace sectsty tocbibind tools upquote url \
+	              wrapfig zapfchan
 from the command line.
 
 If you intend to typeset in the HTML format, you also need tex4ht.

diff --git a/src/en/actionsAlphabetical.tex b/src/en/actionsAlphabetical.tex
@@ -18,26 +18,26 @@
 actionFind\_Again          & actionSelect\_All \\
 actionFind\_Selection      & actionSelect\_Image \\
 actionFirst\_Page          & actionSelect\_Text \\
-actionFit\_to\_Width       & actionShow\_Hide\_Console \\
-actionFit\_to\_Window      & actionShow\_Scripts\_Folder \\
-actionFont                 & actionShow\_Selection \\
-actionFull\_Screen         & actionSide\_by\_Side \\
-actionGoToHomePage         & actionSmartQuotes\_None \\
-actionGo\_to\_Line         & actionStack \\
-actionGo\_to\_Page         & actionSyntaxColoring\_None \\
-actionGo\_to\_Preview      & actionTile \\
-actionGo\_to\_Source       & actionTo\_Lowercase \\
-actionHard\_Wrap           & actionTo\_Uppercase \\
-actionIndent               & actionToggle\_Case \\
-actionLast\_Page           & actionTypeset \\
-actionLine\_Numbers        & actionUncomment \\
-actionMagnify              & actionUndo \\
-actionManage\_Scripts      & actionUnindent \\
-actionNew                  & actionUpdate\_Scripts \\
-actionNew\_from\_Template  & actionWrap\_Lines \\
-actionNext\_Page           & actionWriteToMailingList \\
-actionNone                 & actionZoom\_In \\
-actionOpen                 & actionZoom\_Out \\
-actionOpen\_Recent         & \\
+actionFit\_to\_Width       & actionSettings\_and\_Resources \\
+actionFit\_to\_Window      & actionShow\_Hide\_Console \\
+actionFont                 & actionShow\_Scripts\_Folder \\
+actionFull\_Screen         & actionShow\_Selection \\
+actionGoToHomePage         & actionSide\_by\_Side \\
+actionGo\_to\_Line         & actionSmartQuotes\_None \\
+actionGo\_to\_Page         & actionStack \\
+actionGo\_to\_Preview      & actionSyntaxColoring\_None \\
+actionGo\_to\_Source       & actionTile \\
+actionHard\_Wrap           & actionTo\_Lowercase \\
+actionIndent               & actionTo\_Uppercase \\
+actionLast\_Page           & actionToggle\_Case \\
+actionLine\_Numbers        & actionTypeset \\
+actionMagnify              & actionUncomment \\
+actionManage\_Scripts      & actionUndo \\
+actionNew                  & actionUnindent \\
+actionNew\_from\_Template  & actionUpdate\_Scripts \\
+actionNext\_Page           & actionWrap\_Lines \\
+actionNone                 & actionWriteToMailingList \\
+actionOpen                 & actionZoom\_In \\
+actionOpen\_Recent         & actionZoom\_Out \\
 \bottomrule
 \end{longtable}
diff --git a/src/en/autocompletionLatex.tex b/src/en/autocompletionLatex.tex
@@ -67,6 +67,7 @@
 bcitem          & \textbackslash bcitem    & \textbackslash begin\{compactitem\}{\AutoCompRet}\textbackslash item{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}\textbackslash end\{compactitem\}• \\
 bcitemo         & \textbackslash bcitemo   & \textbackslash begin\{compactitem\}[{\AutoCompIns}]{\AutoCompRet}\textbackslash item{\AutoCompRet}•{\AutoCompRet}\textbackslash end\{compactitem\}• \\
 bdes            & \textbackslash bdes      & \textbackslash begin\{description\}{\AutoCompRet}\textbackslash item[{\AutoCompIns}]{\AutoCompRet}•{\AutoCompRet}\textbackslash end\{description\}• \\
+bdoc            & \textbackslash bdoc      & \textbackslash begin\{document\}{\AutoCompRet}{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}{\AutoCompRet}\textbackslash end\{document\} \\
 benu            & \textbackslash benu      & \textbackslash begin\{enumerate\}{\AutoCompRet}\textbackslash item{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}\textbackslash end\{enumerate\}• \\
 benuo           & \textbackslash benuo     & \textbackslash begin\{enumerate\}[{\AutoCompIns}]{\AutoCompRet}\textbackslash item{\AutoCompRet}•{\AutoCompRet}\textbackslash end\{enumerate\}• \\
 beqns           & \textbackslash beqns     & \textbackslash begin\{eqnarray*\}{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}\textbackslash end\{eqnarray*\}• \\
@@ -409,6 +410,7 @@
                 &                          & \{compactitem\}{\AutoCompRet}\textbackslash item{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}\textbackslash end\{compactitem\}• \\
                 &                          & \{compactitem\}[{\AutoCompIns}]{\AutoCompRet}\textbackslash item{\AutoCompRet}•{\AutoCompRet}\textbackslash end\{compactitem\}• \\
                 &                          & \{description\}{\AutoCompRet}\textbackslash item[{\AutoCompIns}]{\AutoCompRet}•{\AutoCompRet}\textbackslash end\{description\}• \\
+                &                          & \{document\}{\AutoCompRet}{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}{\AutoCompRet}\textbackslash end\{document\} \\
                 &                          & \{enumerate\}{\AutoCompRet}\textbackslash item{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}\textbackslash end\{enumerate\}• \\
                 &                          & \{enumerate\}[{\AutoCompIns}]{\AutoCompRet}\textbackslash item{\AutoCompRet}•{\AutoCompRet}\textbackslash end\{enumerate\}• \\
                 &                          & \{eqnarray*\}{\AutoCompRet}{\AutoCompIns}{\AutoCompRet}\textbackslash end\{eqnarray*\}• \\

diff --git a/src/en/beyond.tex b/src/en/beyond.tex
@@ -15,6 +15,6 @@ \chapter{Beyond this manual}
 
 If you run into problems with {\Tw}, it is advisable to browse the mailing list archives accessible via \url{http://tug.org/pipermail/texworks/}. If you use {\Tw} regularly or are interested in learning about problems and solutions when using it for some other reason, you can also consider subscribing to the list at \url{http://tug.org/mailman/listinfo/texworks} to stay up-to-date. For the occasional post to the mailing list, you can also use the \menu{Help}\submenu\menu{Email to mailing list} menu item. Please make sure you replace the default subject by something describing your issue and to include all information that might help resolving it. That way, you are much more likely to get many helpful replies.
 
-If you find a bug in {\Tw} or want to suggest a new feature for future versions, you should have a look at the issue list at Google Code (\url{http://code.google.com/p/texworks/issues/list}). Before posting a new item, please make sure that a similar report or request is not already on the list and that the issue list is indeed the right place, though. If in doubt, please ask on the mailing list first.
+If you find a bug in {\Tw} or want to suggest a new feature you would like to see in a future version, you should have a look at the issue list at Google Code (\url{http://code.google.com/p/texworks/issues/list}). Before posting a new item, please make sure that a similar report or request is not already on the list and that the issue list is indeed the right place, though. If in doubt, please ask on the mailing list first.
 
 Happy {\TeX}ing!
diff --git a/src/en/customizing.tex b/src/en/customizing.tex
@@ -41,7 +41,7 @@ \section{Syntax highlighting}
 \section{Keyboard shortcuts}
 \label{sec.shortcuts}
 
-The use of keyboard shortcuts\index{keyboard shortcuts} greatly facilitates typing in and the management of the source and the preview. Their use is much more effective than the use of buttons for frequently-used actions.
+The use of keyboard shortcuts\index{keyboard shortcuts} greatly facilitates typing in and the management of the source and the preview windows. Their use is much more effective than the use of buttons for frequently-used actions.
 
 Below, you'll find the shortcuts for source and preview windows. Note that on Mac OS X, \verb|Ctrl| actually refers to the \emph{Command key}, which is the usual modifier for keyboard shortcuts. Although the keyboard shortcuts are specified with \verb|Ctrl|, this will appear as the \emph{Command-key} symbol in menus. (To refer to the actual \emph{Control key} on the Mac, the shortcut file should use the name \verb|Meta|).
 
@@ -140,7 +140,7 @@ \section{Roots for completion}
 %\input{tw-basic_fr.tex}
 \input{autocompletionBasic}
 
-\needspace{5\baselineskip}
+\needspace{6\baselineskip}
 Keywords defined in \path{tw-latex.txt}\index{auto-completion!tw-latex.txt} (defined in \LaTeX):
 %\input{tw-latex_fr.tex}
 \input{autocompletionLatex}

diff --git a/src/en/editingtools.tex b/src/en/editingtools.tex
@@ -12,12 +12,12 @@ \section{Creating a document from a template}\index{template}
 
 Use \menu{File}\submenu\menu{New from template\ldots} or \keysequence{Ctrl+Shift+N} (Mac OS X: \keysequence{Cmd+Shift+N}). A dialogue box opens to allow you to select one of the templates. After selecting one and pressing \verb|OK|, a document is created and you can start to work.
 
-If you want to create a personal template, you just have to create a suitable document with everything you always want to do (and perhaps marking places to fill in the rest) and save it as a \path{.tex} file in the \path{<home>\TeXworks\templates} folder, or a sub-folder of it, if you wish.
+If you want to create a personal template, you just have to create a suitable document with everything you always want to do (and perhaps marking places to fill in the rest) and save it as a \path{.tex} file in the \path{<resources>\templates} folder, or a sub-folder of it, if you wish.
 
 \section{Creating a project using several source files}\index{project}
 
-When the source becomes long, it is sometimes difficult to navigate and maintain it. Then, it is useful to split the source in different smaller files: one file will be the main document, with the preamble and the \verb|document| environment, as well as calls to the ``sub-documents''.\footnote{Called by the commands
-\verb|\input{}| or \verb|\include{}|, see {\LaTeX} manuals for more information.}
+When the source becomes long, it is sometimes difficult to navigate and maintain it. In that case, it is useful to split the source into different smaller files: one file will be the main document, with the preamble and the \verb|document| environment, as well as calls to the ``sub-documents''\footnote{Called by the commands
+\verb|\input{}| or \verb|\include{}|, see {\LaTeX} manuals for more information.}, which could in turn contain separate chapters, for example.
 
 But there might be a problem if you want to start typesetting/compilation in a sub-document: as there is neither a preamble nor a \verb|document| environment there, {\LaTeX} will stop immediately with an error.
 
@@ -40,7 +40,7 @@ \section{Spell-checking}
 
 During typing, every word the spell-checker considers wrong is underlined by a red wavy line. A right-click on the word opens a contextual menu in which there are some replacement suggestions. Click on the desired word to make the replacement.
 
-Before using the spell-checker, you need to install dictionaries in the right folder of {\Tw}: \path{<home>\TeXworks\dictionaries}.
+Before using the spell-checker, you need to install dictionaries in the right folder of {\Tw}: \path{<resources>\dictionaries}.
 
 \begin{OSLinux}
 On Linux, the dictionaries are usually taken from the folder \path{/usr/share/myspell/dicts}---the default path for myspell dictionaries. Note, though, that the maintainer of your {\Tw} package may have changed this to reflect the file system layout of your Linux distribution. You can override this default by setting the \verb+TW_DICPATH+ environment variable before running {\Tw}.

diff --git a/src/en/firststeps.tex b/src/en/firststeps.tex
@@ -37,13 +37,15 @@ \section{Interface summary}\index{interface}
 \includegraphics[width=\textwidth]{interface-summary}
 \end{center}
 
+Even though they are not looking like real buttons, the widgets in the status bar can be clicked. The widgets showing the current position (line or page, respectively), for example, open a dialog to enter a line or page to jump to when clicked. The other widgets typically open contextual menus where some settings can be changed.
+
 \section{Creating a document}
 
 \subsection{Writing the document}
 
 As an example of the use of {\Tw}, we will work with \LaTeX\index{TeX@\TeX!\LaTeX}, but any other {\TeX} system is possible. In particular, if you need to use some special fonts\footnote{You can only use fonts {\AllTeX} knows, most of which are coming in packages included in your distribution. You cannot use your ``normal'' fonts, unfortunately. For more information, see for example \url{http://faq.tug.org/} and \url{http://www.tug.dk/FontCatalogue/}.}---a mandatory font for an official template, non-Latin alphabets, etc.---the {\XeTeX} system is very powerful.\footnote{See the bibliography for pointers to {\XeTeX} and \XeLaTeX.}
 
-Let's create now our first document\index{document!creation}. Enter the following text exactly as shown. To show some of the features of {\Tw}/{\LaTeX}, it is in French intentionally.
+Let's create our first document\index{document!creation} now. Enter the following text exactly as shown. To show some of the features of {\Tw}/{\LaTeX}, it is in French intentionally.
 
 \begin{example}
 \documentclass{article}
@@ -125,12 +127,14 @@ \section{Petite démonstration}
 
 \section{And when errors occur?}\index{errors}
 
-When you create a document for typesetting with {\LaTeX}, you cannot avoid making mistakes: forgetting a closing brace or an \verb|\end{}| command to close an environment, using mathematical commands without switching to mathematical mode, etc. When you compile and there is an error, {\LaTeX} stops, giving you a chance to deal with the problem. This is shown by the stopping of the scrolling action in the output panel, and an error message being displayed, with {\LaTeX} waiting for an instruction to know what it should do. One sees the \emph{typing cursor\index{typing cursor}} in the line between the output panel and the status bar: the \emph{console bar\index{console bar}}.
+When you create a document for typesetting with {\LaTeX}, you cannot avoid making mistakes: forgetting a closing brace or an \verb|\end{}| to close an environment, using mathematical commands without switching to mathematical mode, etc. When you compile and there is an error, {\LaTeX} stops, giving you a chance to deal with the problem. This is shown by the stopping of the scrolling action in the output panel, and an error message being displayed, with {\LaTeX} waiting for an instruction to know what it should do.
 
 \begin{center}\label{fig:consoleOutput}
 \includegraphics{consoleOutput}
 \end{center}
 
+One sees the \emph{typing cursor\index{typing cursor}} in the line between the output panel and the status bar: the \emph{console bar\index{console bar}}.
+
 The error message is on many lines, for example like this:
 \smallskip
 
@@ -158,6 +162,8 @@ \section{And when errors occur?}\index{errors}
 
 Sometimes, an error still occurs during subsequent runs of {\AllTeX} even after it was corrected in the document. This can happen because {\AllTeX} creates a number of intermediary files which can still contain the original, erroneous code. Therefore, it is advisable to remove those files after fixing an error. {\Tw} provides a command to facilitate this---see section \ref{sec:remove-aux-files}.
 
+After an error occurred, the output panel remains open---even after consecutive typesetting runs---to help you fix the problem (which can sometimes take several attempts and restarts of {\AllTeX}). Once all problems are solved, you can close the panel by the \menu{Windows}\submenu\menu{Hide Output Panel}\index{output panel!hide} menu item. As an alternative, you can also configure to output panel to hide automatically as soon as the typesetting process finishes successfully by setting \menu{Edit}\submenu\menu{Preferences\dots}\submenu\menu{Typesetting}\submenu\menu{Hide output panel} to \emph{On success}. Since one can easily overlook other problems in the document (e.g., undefined references) that do not cause {\AllTeX} to fail, this option is only recommended to expert users.
+
 To help you in finding and fixing error (at least if you are using {\LaTeX}), {\Tw} comes with a small script that extracts all errors, warnings, and other noteworthy messages from the console output and presents them to you in a simple, tabular form.
 
 \begin{center}\label{fig:errorParsingScript}

diff --git a/src/en/installation.tex b/src/en/installation.tex
@@ -62,8 +62,6 @@ \section{Under Mac OS X}\index{installation!Mac}
 
 \section{Ready!}
 
-\urldef{\TwResourcePath}\path{<home>/TeXworks}
-
-Finally, some files may need to be added to the ``personal'' files that {\Tw} creates. As the exact location of these depends on your platform, this will be referred to as \path{<home>/TeXworks}\index{folder!$\langle$home$\rangle$/TeXworks} or the \textbf{{\Tw} resource folder} later in this manual. On Linux, this is \path{~/.TeXworks}, on Windows XP it is \path{C:\Documents and Settings\<your name>\TeXworks}, on Windows Vista/7 it is \path{C:\Users\<your name>\TeXworks}, and on the Mac it is \path{~/Library/.TeXworks/}, 
+Finally, some files may need to be added to the ``personal'' files that {\Tw} creates. As the exact location of these depends on your platform, this will be referred to as \path{<resources>}\index{folder!$\langle$resources$\rangle$} or the \textbf{{\Tw} resource folder} throughout this manual. On Linux, this is \path{~/.TeXworks}, on Windows~XP it is \path{C:\Documents and Settings\<your name>\TeXworks}, on Windows Vista/7 it is \path{C:\Users\<your name>\TeXworks}, and on Mac OS X it is \path{~/Library/.TeXworks/} by default. The easiest way to locate this folder in recent versions of {\Tw} is to use the \menu{Help}\submenu\menu{Settings and Resources\dots} menu item. It opens a dialog which shows you where {\Tw} saves its settings and where it looks for resources.
 
 After installation and first run, have a look in the sub-folders of the {\Tw} resource folder and delete any \path{qt_temp.xxxx} files; they are temporary files left behind and could interfere with the normal ones, which are installed in the same folder, later on.