WIP updating doc

Author: baugetfa

doc/_static/ipython.png

@@ -18,7 +18,7 @@ On Windows
 .. image:: ../_static/visualea.png
    :align: left
 
-The main window is composed of :
+The main window is composed of:
     * The package manager (lists nodes),
     * The workspaces where dataflows are graphically assembled,
     * Each node has it's own graphical interface,
@@ -32,18 +32,18 @@ The package manager finds the available components on the system.
    :scale: 100
    :align: left
 
-It provides different tabs :
+It provides different tabs:
 
     * The package tab lists packages and nodes in their physical hierarchy.
     * The category tab sorts nodes into logical categories to ease-up lookup.
-    * The search tab : search node by matching pattern with node name, category and description.
+    * The search tab: search node by matching pattern with node name, category and description.
 
 Package / Node / Dataflow
 -------------------------
 
 The package manager contains packages. A package is a distribution
 unit containing a set of components ( node / graphs).
-A package has several associated informations like :
+A package has several associated informations like:
 
     * Authors
     * Institutes
@@ -55,16 +55,16 @@ These package informations are accessible from the context menu:
 
     * Package Context Menu
 
-      - Open Url : Open associated url
-      - Infos : Display meta informations
+      - Open Url: Open associated url
+      - Infos: Display meta informations
 
-Each package element has also a context menu :
+Each package element has also a context menu:
 
     * Node (Component) Context Menu
 
-      - Open : Open the node
-      - Edit : Edit the node (Code Editor for Python node, Dataflow for Composite node)
-      - Remove : Remove the node from the package
+      - Open: Open the node
+      - Edit: Edit the node (Code Editor for Python node, Dataflow for Composite node)
+      - Remove: Remove the node from the package
 
 .. note:: Tooltip are available by moving the mouse pointer on an object.
 
@@ -77,14 +77,15 @@ User packages / system packages
 Package Manager operations (menu)
 =================================
 
-    * → Load wralea_file : load a particular package description file
-    * → Reload all packages : search all packages on the local system
-    * → Find Nodes : Open the search tab
-    * → Create
+    * → Load package/directory: load a particular package description file
+    * → Reload all packages: search all packages on the local system
+    * → Find Nodes: Open the search tab
+    * → Add
 
-      - → Package : Create a new user package
-      - → Python Node : Create a new component based on python code
-      - → Composite Node : Create a new component based on other components (Macro node)
+      - → Package: Create a new user package
+      - → Composite Node: Create a new component based on other components (Macro node)
+      - → Python Node: Create a new component based on python code
+      - → Data File: Create a new data file
 
 Workspaces
 ----------
@@ -94,15 +95,15 @@ User can create simple process by interconnecting boxes together. A box represen
 Opening workspaces
 ==================
 
-You can create several workspaces :
+You can create several workspaces:
 
-    * Workspace → New empty workspace or CTRL + W
+    * Workspace → New empty workspace or CTRL + T
     * Double click on a graph in the package manager. In this case the workspace contains the graph.
 
 Adding new nodes
 ================
-* You can add nodes by doing a drag and drop between the package manager and the workspace.
-* You also do Copy/Paste operation directly in the workspace.
+* You can add nodes by drag and drop between the package manager and the workspace.
+* You can also do Copy/Paste operation directly in the workspace.
 
 A node is represented by a box with input and outputs ports.
 
@@ -122,13 +123,14 @@ You can connect the nodes between them by doing a drag and drop operation betwee
    :height: 200px
    :scale: 100
 
-* An output port can be connected to several different input ports : in this case the value will be copied to the different port
-* An input port can be connected to several different output ports : in this cas the value will be the list of the different value of the connected output ports.
+* An output port can be connected to several different input ports: in this case the value will be copied to the different port
+* An input port can be connected to several different output ports: in this cas the value will be the list of the different value of the connected output ports.
 
 Node Graphical interface
 ========================
 
-Each node has a configuration dialog (its widget). You can open the widget with the context menu (right click → open widget).
+Each node has a configuration dialog (its widget). You can open the widget with the context menu (right click → open widget)
+or by double clicking the node.
 
 The widget depends of the node, it can be a simple value editor (spinbox for numbers, text editor…), or complex editor like 3D visualizer.
 
@@ -137,7 +139,7 @@ Running a dataflow
 
 The graph of nodes form an expression.
 
-To evaluate the expression :
+To evaluate the expression:
 
     * Menu → Workspace → Run will evaluate all the graph
     * Context Menu → Run on a particular node will evaluate only the selected node and its parents.
@@ -148,40 +150,40 @@ avoiding to do several times the same computation.
 .. deprecated::
     The node contained in a graph can be in different states/ The color of a node depends of its state:
 
-    * Red : the node need to be reevaluated
-    * Blue : the node doesn't need to be reevaluated
+    * Red: the node need to be reevaluated
+    * Blue: the node doesn't need to be reevaluated
 
 To change the status of a node or of a dataflow:
 
     * Context Menu → Reset: Reset the corresponding node
-    * Workspace → Reset : Reset all the dataflow
-    * Workspace → Invalidate : Force all nodes to be reevaluated the next time
+    * Workspace → Reset: Reset all the dataflow
+    * Workspace → Invalidate: Force all nodes to be reevaluated the next time
 
-You can visualize the value of a port : Context Menu → Print and with tooltips.
+You can visualize the value of a port: Context Menu → Print and with tooltips.
 
 Save a dataflow / Composite Node
 ================================
 
 A Composite node is an abstraction of a dataflow graph. It is a node which contains other nodes.
 
-Composite nodes are used to :
+Composite nodes are used to:
 
     *  save a dataflow
     *  manage complexity
 
 Saving a dataflow
 -----------------
 
-To save a dataflow :
+To save a dataflow:
 
-    * Save the workspace as a composite node : Workspace → Save as composite node or CTRL + E
+    * Save the workspace as a composite node: Workspace → Save as composite node or CTRL + E
 
 This function will save the graph but also the value of the node inputs
 
 Managing complexity
 -------------------
 
-A composite node can be reused as a normal node (a simple box). You can embed a part of a graph in a composite node :
+A composite node can be reused as a normal node (a simple box). You can embed a part of a graph in a composite node:
 
     * Select the node you want to group/embed
     * Workspace → Group or CTRL +G
@@ -192,17 +194,17 @@ This function can be used to improve the readability of your graph and facilitat
 
 I/O
 ---
-As normal node, a composite node has inputs and outputs. They can be set :
+As normal node, a composite node has inputs and outputs. They can be set:
 
     * Workspace → configure I/O
 
-Each input has :
+Each input has:
 
     * a name
     * an interface (used for the graphical interface and for type checking)
     * a default value
 
-Each output has :
+Each output has:
 
     * a name
     * an interface (used for type checking)
@@ -212,25 +214,25 @@ Open/Save a session
 
 You can save the entire session in order to keep all the data you currently use.
 
-    * File → save session : Save the current session for a furur reuse
-    * File → open session : Open a previously saved session
-    * File → new session : reinitialize all the workspace
+    * File → save session: Save the current session for a furur reuse
+    * File → open session: Open a previously saved session
+    * File → new session: reinitialize all the workspace
 
 .. warning:: This functionality is not safe and we do NOT recommand to use it. Use export as composite node instead to save your work
 
 Export Application
 ==================
 
-A graph can be exported as a standalone application (a python module) : Workspace → Export to Application.
+A graph can be exported as a standalone application (a python module): Workspace → Export to Application.
 
-The application can be previewed with the command : Workspace → Preview Application.
+The application can be previewed with the command: Workspace → Preview Application.
 
 Data Pool
 ---------
 
 The data pool is a kind of data clipboard to store temporally computed data.
 
-    * You can send data to the Pool : Port Context menu → Send to pool
+    * You can send data to the Pool: Port Context menu → Send to pool
     * You can re-use data of the pool in the dataflow by doing a drag and drop from the datapool list to aaninput port.
     * You can also access to the datapool in the interpreter (drag and drop to the interpreter will copy the correct code):
 
@@ -242,13 +244,12 @@ Python Operations
 
 At any moment, you can use the python interpreter to launch python command or scripts.
 
-CHANGE THIS PICTURE
 .. image:: ../_static/ipython.png
-    :width: 80%
+    :width: 100%
     :height: 200px
     :scale: 100
 
-The interpreter defines special variables :
+The interpreter defines special variables:
 
     * session contains the different workspaces and the nodes they contain
     * datapool is the datapool dictionary
@@ -261,21 +262,4 @@ You can also do a drag and drop from the datapool.
 Preferences
 -----------
 
-Interface preferences can be set via the preference dialog : Window → Preferences
-
-Package manager
-===============
-
-This tab is used to set the directories to search for openalea packages.
-
-.. warning::  section to be filled
-
-Dataflow Python editor
-======================
-
-.. warning::  section to be filled
-
-UI
-==
-
-.. warning::  section to be filled
+Interface preferences can be set via the preference dialog: Window → Preferences