Document --ui in doc/gui.txt.
[hooke.git] / doc / gui.txt
index 17ec5f44b755e768341c19e5451d7ea6f971ee22..eb1f1f4b049b1263d1c53e6eb6c89aaee799f62d 100644 (file)
@@ -4,7 +4,11 @@ The GUI interface
 
 Orignially by Rolf Schmidt <rschmidt@alcor.concordia.ca>.
 
-Enable by selecting `gui` in your config file (see :doc:`config`)::
+Run the GUI with::
+
+    $ ./bin/hk.py --ui gui
+
+Alternatively, select `gui` in your config file (see :doc:`config`)::
 
     [user interfaces]
     command line = False
@@ -70,6 +74,8 @@ Here you can navigate your file system and double click on a saved
 playlist to open it.  You can change the initial folder by modifying
 `workdir` in the `preferences` (core plugin).
 
+.. todo:: Implement folders panel.
+
 Playlists
 =========
 You can manage several playlists in this window.  As the GUI is rather
@@ -150,8 +156,6 @@ Hooke's GUI will remember the size and position of the main window
 panels any which way you like and save this arrangement as a
 perspective.
 
-.. todo:: Actually write new properties to the config file on GUI exit.
-
 .. image:: img/gui_perspective.jpg
 
 Hooke will always start with the last used perspective and you can
@@ -193,3 +197,13 @@ The :doc:`autopeak` tutorial is also applicable.  You need to setup the
 type of fit you want to use: in the Properties of the autopeak command
 (autopeak plugin) select `WLC`, `FJC` or `FJC_PEG` from the dropdown
 list for the `polymer model` argument of `polymer fit`.
+
+Fast curve reviewing and saving
+===============================
+.. todo:: Update curve review tutorial section.
+
+When automatic routines are not good enough to filter your data, use
+``review`` command to cycle through your playlist presenting ten
+curves in the same graph.  You can then enter the numbers of the
+interesting curves and automatically save a copy of them into another
+directory.