From e020096532b7331fdad9856e1702e1d7d3e1d4d3 Mon Sep 17 00:00:00 2001
From: elvez <elvez@3ecf2c5c-341e-0410-92b4-d18e462d057c>
Date: Fri, 8 Sep 2006 21:45:06 +0000
Subject: [PATCH] - Written documentation for section "Overall view of the main
 window"

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@1072 3ecf2c5c-341e-0410-92b4-d18e462d057c
---
 doc/sgpem2uman.texi | 67 ++++++++++++++++++++++++++-------------------
 1 file changed, 39 insertions(+), 28 deletions(-)

diff --git a/doc/sgpem2uman.texi b/doc/sgpem2uman.texi
index 00ba2ba..e91ea4e 100644
--- a/doc/sgpem2uman.texi
+++ b/doc/sgpem2uman.texi
@@ -89,7 +89,9 @@ Free Documentation License''.
 @unnumbered History
 
 @table @strong
-@item 2006, September 8th @r{-- Matteo Settenvini}
+@item 2006, September 8th @r{--- Luca Vezzaro} 
+Written documentation for section "Overall view of the main window"
+@item 2006, September 8th @r{--- Matteo Settenvini}
 Update chapters about building and installation. Rewrite some of the
 chapter about extending SGPEMv2 with custom CPU policies, and add a
 more complex example. Document interfaces exported to Python.
@@ -546,38 +548,42 @@ TODO: write me!
 
 @image{main-window,18cm,13.5cm,Screenshot of the main window during a simulation}
 
-@strong{TODO}: rework the following part, divide it into each separate
-subsection, and expand it (in English!). This is meant just as a guideline.
+Just below the menus, there's the toolbar. The purpose of most toolbar 
+buttons is easily understood. 
+For example, you can instantly change the current scheduling policy by using the menu 
+just to the right of the "Scheduling Policy" toolbar button.
+Similarly, you can do the same with a resource allocation policy. The aforementioned 
+"Scheduling Policy" and "Resource Scheduling" toolbar 
+buttons can be used to configure the policy's parameters, if there are any.
 
-Di seguito trovate una sommaria descrizione delle parti piu' importanti
-della finestra principale del programma. Una descrizione piu' completa
-dovrebbe (o dovra') trovarsi nel manuale utente, ``sgpemv2uman'' (se
-volete il PDF, potete generarlo con ``make pdf'' dopo aver configurato i
-sorgenti).
+To know more about the other toolbar buttons, such as "Pause", "Play" and "Stop", 
+see @xref{Controlling the simulation}.
 
-Appena sotto ai menu, c'e' la barra degli strumenti. La maggior parte
-dei pulsanti ivi contenuta č di immediata comprensione; il menu a
-tendina a fianco di ``Scheduling policy'' permette di selezionare una
-politica di schedulazione dei thread, e analogamente avviene per
-``Resource scheduling''.
+Normally, the window is split into three sections. 
 
-Facendo invece clic con il mouse sui pulsanti stessi, si apre una
-finestra che descrive la politica e permette di configurarne i
-parametri resi disponibili da chi l'ha scritta.
+@itemize
+@item
+The top left section, briefly called 
+the "Schedulables tree", although this is not completely correct, since except from resources,
+every entity in the SGPEMv2 is shown and edited in this tree view.
+The interface of this widget is straightforward, but in case you need to know about it,
+see @ref{The Schedulables/Requests tree}.
 
-Appena sotto la barra degli strumenti, si trova collocata una doppia
-vista; e' quella degli Schedulabili e quella delle Risorse.
-Potete aggiungere, togliere, o modificare ciascuna voce attraverso il
-menu a comparsa che appare facendo clic con il tastro destro del mouse
-su queste aree. Per maggiori informazioni sul significato di ciascuna
-entita', e dei loro parametri, si rimanda al manuale utente.
-Lo spazio maggiore della finestra č occupato dal widget che visualizza
-lo stato della simulazione.
+@item
+The top right section is the resources list, you can interact with it in the same way you do
+with the Schedulables tree. We won't get into the details here, as there is a 
+@ref{The Resources list, dedicated section} for this widget.
 
-Una finestra modale, nascondibile/visualizzabile tramite il menu View,
-mostra il grafo di Holt, che mostra lo stato dell'allocazione delle
-risorse. Ridimensionare questa finestra in modo non proporzionale
-cambia la modalitą di visualizzazione del grafo.
+@item
+Finally, the bottom section contains the "Simulation vidget", which displays how the scheduling
+is proceeding. This widget is too complex to be described here, so we'll leave that to its
+@ref{The Simulation widget, dedicated section}.
+@end itemize
+
+Well, in fact that's not all, folks. There's also the "Holt graph", which is displayed in a separate window,
+so it doesn't steal precious window space to the simulation widget, and also because you may not
+need it if you don't use resources and/or requests in your simulation. For more information on this widget, see
+@ref{The Holt graph}.
 
 @c % -------------------------------------------------
 @node The Schedulables/Requests tree, The Resources list, Overall view of the main window, From the GUI
@@ -604,6 +610,11 @@ cambia la modalit
 @subsection The Preferences dialog
 @cindex preferences
 
+@strong{TODO:} Spiegare:
+a) quale ordine viene applicato per il caricamento dei plugin   
+b) dove vengono salvate le preferenze   
+c) cos'č l'intervallo
+
 @c % -------------------------------------------------
 @node Controlling the simulation, (none), The Preferences dialog, From the GUI
 @subsection Controlling the simulation