flora-commits Mailing List for Flora-2

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/flora/flora2-visualizer/net.sourceforge.flora.eclipse/docs/manual
In directory sc8-pr-cvs5.sourceforge.net:/tmp/cvs-serv23834/docs/manual

Modified Files:
	manual.tex 
Log Message:
updated manual

Index: manual.tex
===================================================================
RCS file: /cvsroot/flora/flora2-visualizer/net.sourceforge.flora.eclipse/docs/manual/manual.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5

--- manual.tex	30 Apr 2007 11:55:13 -0000	1.4
+++ manual.tex	30 Apr 2007 20:30:18 -0000	1.5
@@ -96,8 +96,8 @@
 %% ==> TeXnicCenter supplies some possible option files
 %% ==> with its templates (File | New from Template...).
 
-\newcommand{\FLORA}{{\mbox{\sc ${\cal F}${lora}\rm\emph{-2}}}\xspace}
-\newcommand{\FVIZ}{{\mbox{\sc ${\cal F}${lora}\rm\emph{-2}-{Visualizer}}}\xspace}
+\newcommand{\FLORA}{{\mbox{\textsc{${\cal F}${lora}\rm\emph{-2}}}}\xspace}
+\newcommand{\FVIZ}{{\mbox{\textsc{${\cal F}${lora}\rm\emph{-2}}-\textsc{Visualizer}}}\xspace}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% DOCUMENT
@@ -143,7 +143,7 @@
 %% Inhaltsverzeichnis %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \newpage
 \tableofcontents %Table of contents
-%\cleardoublepage %The first chapter should start on an odd page.
+\clearpage %The first chapter should start on an odd page.
 
 \pagestyle{plain} %Now display headings: headings / fancy / ...
 
@@ -164,7 +164,7 @@
 IDE providing
 \begin{itemize}
 	\item a \emph{text editor} for editing source code
-	\item a \emph{visualizer} for registered objects
+	\item a \emph{visualizer} for visualization of registered objects
 	\item a \emph{console} for communication with the \FLORA reasoner
 	\item a \emph{view} for the currently loaded modules
 \end{itemize}
@@ -195,7 +195,7 @@
 \label{sec:introduction_installation}
 
 \FVIZ is supplied in two ways. It can either be downloaded as standalone program
-or just as plugins to contribute to an eclipse application.
+or as plugins to contribute to an eclipse application.
 
 \begin{enumerate}
 \item Standalone program:\\
@@ -206,8 +206,11 @@
   file or start the program from console.
 \item Plugin JARs:\\
   If you haven't got already an eclipse RCP application (like e.g. the eclipse~SDK)
-  you need to install one or download the standalone version of \FVIZ.\\
-  Otherwise the JAR files just need to be put to the eclipse plugin directory.
+  you need to install one or download the standalone version of \FVIZ.
+  Otherwise the JAR files just need to be put to the eclipse plugin directory.\\
+  When starting the eclipse you need to open the \FVIZ Perspective. It is located
+  at \emph{Window} $\rightarrow$ \emph{Open Perspective} $\rightarrow$ \emph{Other...}.
+  Then choose \emph{Flora} and press \emph{OK}.
 \end{enumerate}
 
 \section{The \FVIZ Reasoner}
@@ -263,7 +266,7 @@
 \subsection{Configuration}
 \label{sec:consoleview_configuration}
 
-At the \FLORA Console preference you can change the text highlighting colors.
+At the \FLORA Console preference page you can change the text highlighting colors.
 You can choose between three different writings:
 \begin{itemize}
 \item Default color\\
@@ -280,7 +283,7 @@
 The \FVIZ Console is used like a normal \FLORA console application. It automatically
 parses commands or queries and sends it to the \FVIZ Reasoner. The response is color-
 highlighted for better differentiation.\\
-There are commands commands which weren't typed by the user. These come from GUI actions
+Some displayed commands weren't typed by the user. These come from GUI actions
 and are printed to the \FVIZ Console for better understanding of the program.
 
 \section{The \FVIZ Module View}
@@ -313,21 +316,21 @@
 \begin{itemize}
 \item \emph{load to module and erase registered objects}\\
   This option erases all registered object and loads the file to the specified module.
-  After the erasure operation there no more objects of the module in the \FVIZ registry.
+  After the erasure operation are no more objects of the module in the \FVIZ registry.
   If registration operations are specified in the file they'll be registered after the
   erasure and therefore won't be affected by the erasure.\\
   \lstinline|_load('/home/flora2/demo.flr'>>specifiedModule).|
 
 \item \emph{load to module and keep registered objects}\\
   This option keeps the registered objects and loads the file to the specified module.
-  If objects are registered by the file they'll be added to the \FVIZ registration.
+  If objects are registered by the file they'll be added to the \FVIZ registry.
   It doesn't make any difference if an object is registered more times. The additional
   registration will be ignored by the \FVIZ.\\
   \lstinline|_load('/home/flora2/demo.flr'>>specifiedModule).|
 
 \item \emph{add to module and keep registered objects}\\
   This option keeps the registered objects and adds the file to the specified module.
-  If objects are registered by the file they'll be added to the \FVIZ registration.
+  If objects are registered by the file they'll be added to the \FVIZ registry.
   It doesn't make any difference if an object is registered more times. The additional
   registration will be ignored by the \FVIZ.\\
   \lstinline|_add('/home/flora2/demo.flr'>>specifiedModule).|
@@ -336,7 +339,7 @@
 \subsubsection{Creating new \FLORA modules}
 \label{sec:moduleview_usage_createmodules}
 
-To create a new \FLORA module can either be done by the \FVIZ Console or by using the
+Creating a new \FLORA module can either be done by the \FVIZ Console or by using the
 \FVIZ Module View. At the view there is the possibility to click the \emph{create new
   module} button or using the context menu. The context menu can be accessed by
 right clicking on the table or using the views menu by clicking the triangle in the
@@ -354,7 +357,7 @@
 Module View the \emph{show erase dialog} must be chosen from the context menu (for
 accessing the context menu see \ref{sec:moduleview_usage_createmodules}.\\
 When \emph{show erase dialog} is selected a dialog pops up. The dialog contains a 
-table with the currently loaded modules. By clicking the check boxes the dialogs to
+table with the currently loaded modules. By clicking the check boxes the modules to
 erase can be chosen. By clicking the \emph{OK} button selected Modules get erased.\\
 \lstinline|erasemodule{specifiedModule}.|
 
@@ -369,6 +372,21 @@
 table with the currently loaded modules. At clicking the \emph{OK} button the selected 
 modules will be filtered from view.
 
+\subsection{Menu}
+\label{sec:consoleview_menu}
+
+When the \FVIZ Console View is active the \FLORA menu is extended by the points:
+
+\begin{itemize}
+\item Show Session Log File\\
+Opens the Session Log File in a new \FVIZ Text Editor. This file can be edited and
+saved by using \emph{File} $\rightarrow$\emph{Save As}.
+
+\item Restart \FLORA Reasoner\\
+Restarts the Flora Reasoner. Note that the \FVIZ registry doesn't get affected.
+
+\end{itemize}
+
 \section{The \FVIZ Text Editor}
 \label{sec:texteditor}
 
@@ -386,7 +404,7 @@
 
 \item  Tab Type\\
   If set to Tab the \FVIZ Text Editor writes a \lstinline|'\t'| to the edited \emph{.flr}
-  file. If set to Space it writes as much \lstinline|' '| to the file as chose at the tab
+  file. If set to Space it writes as much \lstinline|' '| to the file as chosen at the tab
   width option.
 
 
@@ -410,12 +428,12 @@
 
 \begin{itemize}
 \item Format\\
-  This action formats the highlighted (or the whole if nothing is highlighted) text.
+  This action formats the highlighted (or all if nothing is highlighted) text.
   When formatting the indentations are corrected if needed and the space between
-  text tokens get trimmed or expanded.
+  text tokens gets trimmed or expanded.
 
 \item Open Buffer\\
-  This action opens a new editor as a buffer. The edited text can be saved as normal file
+  This action opens a new editor as a buffer. The edited buffer can be saved as normal file
   by using \emph{File} $\rightarrow$ \emph{Save as}.
 
 \item Add Region to Module\\
@@ -431,7 +449,7 @@
   To specify the module a dialog pops up and lists all currently loaded modules.
 
 \item Load Region\\
-  This action adds the selected text of the current \FVIZ Text Editor to the \FLORA 
+  This action loads the selected text of the current \FVIZ Text Editor to the \FLORA 
   main module
 
 \item Load Query to Module\\
@@ -457,9 +475,9 @@
 $\rightarrow$ \emph{Flora-2 Visualizer}. It allows to change
 \begin{itemize}
 \item Node Colors\\
-  The colors of the displayed nodes. The module nodes default color is white it doesn't offer
+  The colors of the displayed nodes. The module nodes default color is white since it doesn't offer
   any advantages and doesn't need to be seen by the user (it just connects the rest of the
-  graph).
+  graph as root node).
 
 \item Zoom level\\
   The default level of zoom. The zoom level can also be changed in the \FVIZ View to scale the level
@@ -473,7 +491,7 @@
   node which contains all instances of a class instead of drawing all instances specially.
 
 \item Minimum Cluster Size\\
-  The minimum size at which the graph draws an instance cluster instead of single instances of class.
+  The minimum size at which the graph draws an instance cluster instead of single instances.
   In the \FVIZ View it's possible to switch dynamically between clustering and unclustering the
   instances of a class (see \ref{sec:visualizerview_usage_contextmenu}).
 \end{itemize}
@@ -484,17 +502,17 @@
 The \FVIZ View draws a graph of the specified \FLORA module. A \FVIZ View can be opened by
 clicking on a \FLORA module at the \FVIZ Module View (see \ref{sec:moduleview}). The
 visualizer is then opened in a new editor and displays the currently registered objects
-of the module.
+of the selected module.
 
-\index{registration}
+\index{registratxion}
 \subsubsection{Registration}
 \label{sec:visualizerview_usage_registration}
 
 There are several ways to register objects for the \FVIZ View. The easiest way is to use
 the \emph{register} button(marked with a green \emph{R}) at the \FVIZ View. When pressed a
-display pops up with a field to enter a comma, space or tab separated list of objects to
+dialog pops up with a field to enter a comma, space or tab separated list of objects to
 register.\\
-The other possibility is to register the objects directly in the loaded console or via the
+The other possibility is to register the objects directly in the loaded file or via the
 \FVIZ Console. The command to register objects is\\
 \lstinline|<moduleName>[\%register([<registeredObjects>])]@<visualizerModuleName>.|\\
 After registering the graph is refreshed (aside from registering by \FVIZ Console). Objects
@@ -513,7 +531,7 @@
 The selected objects get unregistered when pressing the \emph{OK} button. When using the
 \FVIZ Console the command\\
 \lstinline|<moduleName>[\%unregister([<registeredObjects>])]@<visualizerModuleName>.|\\
-unregisters the objects from the \FVIZ registration.\\
+unregisters the objects from the \FVIZ registry.\\
 When unregistering by button the graph automatically refreshes to display the result.
 
 \subsubsection{Context Menu}
@@ -529,7 +547,7 @@
 \item Show details\\
   This action opens a dialog with two tables showing the values and types of the current object. Adapted
   on instance clusters it opens a dialog listing all instances of the cluster. You can double-click the
-  instances to open the details dialog.\\
+  instances to open the details dialog of a module.\\
   The details dialog also pop up when double-clicking on a node.
 
 \item Cluster\\
@@ -580,4 +598,4 @@
 
 %\input{FileName} %You need a file 'FileName.tex' for this.
 
-\end{document}
+\end{document}
\ No newline at end of file





2002	Jan	Feb	Mar	Apr	May (59)	Jun (43)	Jul (4)	Aug (4)	Sep (102)	Oct (20)	Nov (47)	Dec (32)
2003	Jan (24)	Feb (34)	Mar (72)	Apr (36)	May (10)	Jun (46)	Jul (36)	Aug (24)	Sep (37)	Oct (27)	Nov (43)	Dec (40)
2004	Jan (35)	Feb	Mar	Apr	May	Jun	Jul (30)	Aug (83)	Sep (68)	Oct (38)	Nov (3)	Dec (7)
2005	Jan (9)	Feb (31)	Mar (46)	Apr (73)	May (21)	Jun (1)	Jul (32)	Aug (33)	Sep (3)	Oct (28)	Nov (4)	Dec (23)
2006	Jan (22)	Feb (2)	Mar (12)	Apr (23)	May (73)	Jun (14)	Jul	Aug (20)	Sep (14)	Oct (5)	Nov	Dec (14)
2007	Jan (54)	Feb (81)	Mar (286)	Apr (313)	May (154)	Jun (85)	Jul (8)	Aug (11)	Sep (12)	Oct (14)	Nov (6)	Dec (6)
2008	Jan	Feb	Mar (1)	Apr (12)	May (4)	Jun	Jul (13)	Aug (22)	Sep	Oct	Nov	Dec
2013	Jan	Feb	Mar	Apr	May (46)	Jun (43)	Jul (46)	Aug (9)	Sep (13)	Oct (31)	Nov (42)	Dec (18)
2014	Jan (7)	Feb (7)	Mar (11)	Apr (13)	May (16)	Jun (6)	Jul (17)	Aug	Sep (2)	Oct	Nov (1)	Dec
2015	Jan	Feb (17)	Mar (4)	Apr (3)	May (2)	Jun (3)	Jul (2)	Aug (3)	Sep	Oct	Nov	Dec
2016	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug (1)	Sep	Oct	Nov	Dec (2)
2017	Jan	Feb	Mar (1)	Apr	May	Jun	Jul	Aug	Sep (1)	Oct	Nov	Dec
2019	Jan	Feb	Mar	Apr	May	Jun	Jul (1)	Aug	Sep	Oct	Nov	Dec

S	M	T	W	T	F	S
1	2	3	4	5 (5)	6 (3)	7 (19)
8 (7)	9 (42)	10 (24)	11 (6)	12 (9)	13 (6)	14
15 (9)	16 (27)	17 (49)	18 (6)	19	20	21 (12)
22 (26)	23 (12)	24 (20)	25	26	27 (2)	28 (4)
29 (1)	30 (24)

flora-commits Mailing List for Flora-2

flora-commits — List for commit messages