GPL V2. Added settings to documentation
authorinsilmaril
Mon Jul 09 10:23:40 2007 +0000 (2007-07-09)
changeset 5445550c3ba96ba
parent 543 9068ed9695f7
child 545 a7afc473b843
GPL V2. Added settings to documentation
icons/flag-hideexport.png
tex/vym.tex
     1.1 Binary file icons/flag-hideexport.png has changed
     2.1 --- a/tex/vym.tex	Mon Jul 09 10:23:39 2007 +0000
     2.2 +++ b/tex/vym.tex	Mon Jul 09 10:23:40 2007 +0000
     2.3 @@ -282,7 +282,8 @@
     2.4  
     2.5  By default some of these flags are set exclusively e.g. when the 
     2.6  "thumb-up" flag is set, then the "thumb down" is reset and vice
     2.7 -versa. You can change this default behaviour in the settings menu.
     2.8 +versa. You can change this default behaviour in the settings menu (see
     2.9 +\ref{settings}).
    2.10  
    2.11  \section{Mapeditor} \label {mapeditor}
    2.12  \subsection{Start a new map}
    2.13 @@ -313,7 +314,7 @@
    2.14  before} the selection. This can be done using the context menu.
    2.15  
    2.16  \hint{To delete a branch press \key{CTRL-X}. If enabled in the Settings
    2.17 -menu, you can also use the \key{Del} key.}
    2.18 +menu (see \ref{settings}), you can also use the \key{Del} key.}
    2.19  
    2.20  \subsection{Navigate through a map}
    2.21  \subsubsection*{Select branches}
    2.22 @@ -576,7 +577,7 @@
    2.23  After an URL was entered, a little globe will appear in the branch. By
    2.24  clicking on the globe in the toolbar or the context menu an external
    2.25  browser\footnote{
    2.26 -	The browser can be changed in the Settings Menu.}
    2.27 +	The browser can be changed in the Settings Menu (see \ref{settings}).}
    2.28  will be launched.
    2.29  \begin{center}
    2.30  	\includegraphics[width=0.5cm]{images/flag-url.png}
    2.31 @@ -673,7 +674,8 @@
    2.32  formatted text in the noteeditor\footnote{
    2.33  	\vym uses the QRichtText format, which is basically a subset of the
    2.34  	formatting provided in HTML.}
    2.35 -Two default fonts are supported which can be set in the Settings menu.
    2.36 +Two default fonts are supported which can be set in the Settings menu
    2.37 +(see \ref{settings}).
    2.38  One is a fixed width font, the other has variable width. The fixed font
    2.39  is usually used for emails, source code etc.\ while the variable font is
    2.40  used for simple notes, where one doesn't need fixed character widths.
    2.41 @@ -747,8 +749,9 @@
    2.42  	\includegraphics[width=0.5cm]{images/flag-hideexport.png}
    2.43  \end{center}
    2.44  You can toggle this flag in the toolbar or by pressing \key{H}.
    2.45 -Note that there is a global option in the settings menu to toggle the
    2.46 -use of this flag. By default the flag is enabled.
    2.47 +Note that there is a global option in the settings menu (
    2.48 +\ref{settings}) to toggle the use of this flag. By default the flag is
    2.49 +enabled.
    2.50  
    2.51  \subsubsection*{Open Office}
    2.52  Open Office beginning with version~2 uses the so called "Open Document Format", which can be written by \vym. The options are
    2.53 @@ -913,6 +916,7 @@
    2.54  Each macro is a \vym script, which is executed when the associated key
    2.55  is pressed. The default location of the scripts can be changed in the
    2.56  Settings menu. More information on using scripts in \vym is found in
    2.57 +[\ref{settings})
    2.58  appendix~\ref{scripts}.
    2.59  
    2.60  \subsection{Bookmarks} \label{bookmarks}
    2.61 @@ -1041,22 +1045,25 @@
    2.62  between {\em Add Map (Insert)} and {\em Add Map (Replace)}: The imported
    2.63  data will be added after the selected branch.
    2.64  
    2.65 +
    2.66  \section{\vym on Mac OS X}
    2.67  \subsection{Overview}
    2.68  Basically there are two ways to run \vym on Macs:
    2.69 -\subsubsection*{QT Mac Edition:}
    2.70 +\subsubsection*{Qt Mac Edition:}
    2.71  	\vym here provides the well known Mac look and feel.  \vym is
    2.72 -	available as zipped Mac OS X application. It has been compiled and
    2.73 -	tested in Mac~OS~10.4. It is using the Mac version of Trolltechs QT library.  
    2.74 -\subsubsection*{X11}
    2.75 -	\vym can also be run using the Linux version, but then menus and
    2.76 -	handling will also be those of the Linux version e.g. The menu bar
    2.77 -	will look different. 
    2.78 +	available as Mac OS X application package in contained in a disk
    2.79 +	image ({\tt vym.dmg}. It has been compiled and tested in
    2.80 +	Mac~OS~10.4.  This package includes  runtime libraries of Qt by
    2.81 +	Trolltech.
    2.82 +	
    2.83 +\subsubsection*{X11 version} \vym can also be run using the Linux
    2.84 +version, but then menus and handling will also be those of the Linux
    2.85 +version e.g. The menu bar will look different. 
    2.86  
    2.87  \subsection	{Contextmenu and special keys}
    2.88  Most Macs unfortunatly just have a single mouse button. In order to show
    2.89  the context menu which usually would be opened with the right mouse
    2.90 -button, you can click while pressing the \key{kommand}-key.
    2.91 +button, you can click while pressing the \key{command}-key.
    2.92  
    2.93  Especially on Laptops some of the keys usually used on PC keyboards seem
    2.94  to be missing. The QT-Mac Edition of \vym has its own keyboard
    2.95 @@ -1071,9 +1078,62 @@
    2.96  opens the right browser.
    2.97  
    2.98  
    2.99 +\newpage
   2.100 +
   2.101  \begin{appendix}
   2.102  
   2.103  \section{\vym initialisation process and configuration}
   2.104 +\subsection {Settings menu}
   2.105 +	The {\em Settings} menu allows to configure \vym to your needs:
   2.106 +
   2.107 +\subsubsection*{Set application to open PDF files} Choose a PDF
   2.108 +	viewer like {\tt acrobat} or {\tt konqueror} which is installed on
   2.109 +	your system.
   2.110 +
   2.111 +\subsubsection*{Set application to open external links}
   2.112 +	Choose your favourite webbrowser here.
   2.113 +
   2.114 +\subsubsection*{Set path for macros}
   2.115 +	Set the default search path for macros, which will be executed when
   2.116 +	you press one of the function keys. Each key corresponds to a file
   2.117 +	({\tt macro-1.vys..macro12.vys}) in the search path.
   2.118 +
   2.119 +\subsubsection*{Set number of undo levels}
   2.120 +	Sets the number of undo/redo levels. The default setting is
   2.121 +	75~levels.
   2.122 +
   2.123 +\subsubsection*{Autosave and autosave time}
   2.124 +	Automatic saving of modified maps can be toggled on or off. The
   2.125 +	autosave time is entered in seconds.
   2.126 +
   2.127 +\subsubsection*{Edit branch after adding it}
   2.128 +	If set, the heading of a new branch will be edited immediatly after
   2.129 +	adding the branch.
   2.130 +
   2.131 +\subsubsection*{Select branch after adding it}
   2.132 +	If set, a new branch will be selected immediatly after adding it.
   2.133 +	When you "brainstorm" on a given keyword, you don't want to go
   2.134 +	deeper and deeper into details, but keep the focus on the keyword.
   2.135 +	So the default setting here is to {\em not} select the freshly added
   2.136 +	branch.
   2.137 +	
   2.138 +\subsubsection*{Select existing heading}
   2.139 +	If set and you begin to edit the heading of a branch, the heading text in
   2.140 +	the dialog will be selected. Usefully to copy\&paste to other
   2.141 +	applications.
   2.142 +
   2.143 +\subsubsection*{Delete key}
   2.144 +	If set, the \key{Delete} is enabled to, well, delete objects. This
   2.145 +	can be switched off to avoid confusing with the nearby
   2.146 +	\key{Insert}-key on PC keyboards.
   2.147 +
   2.148 +\subsubsection*{Exclusive flags}
   2.149 +	If set, some of the standard flags can only be used exclusively,
   2.150 +	e.g.~the smileys.
   2.151 +
   2.152 +\subsubsection*{Use hide flags}
   2.153 +	If set, every branch which also has the hide flag set (see
   2.154 +	\ref{hideexport}) will be hidden in exports.
   2.155  \subsection{Configuration file}
   2.156  On startup \vym will look for a configuration for user specific settings
   2.157  like window positions, toolbars etc. If this file does not already