Update note section of tutorial.txt.

[hooke.git] / doc / tutorial.txt

diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index 7b302f5379a6888c5a2cbdf8b0b080f92d3dcd3a..58cb57f3bbfb847aafbc0441a55a96265226812c 100644 (file)
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -51,9 +51,14 @@ also check that the current working directory (`.`) is in your
 As Hooke launches, you should see something like the following in your
 terminal::
 
-    Hooke version 0.8.0 Seinei
+    Hooke version 0.9.0.devel (Kenzo)
 
-    COPYRIGHT
+    Copyright (C) 2006-2010 A. Seeholzer, Alberto Gomez-Casado, Allen
+    Chen, Fabrizio Benedetti, Francesco Musiani, Marco Brucale, Massimo
+    Sandal, Pancaldi Paolo, Richard Naud, Rolf Schmidt, W. Trevor King
+
+    Hooke comes with ABSOLUTELY NO WARRANTY and is licensed under the GNU
+    Lesser General Public License.  For details, run `license`.
     ----
     hooke>
 
@@ -116,18 +121,42 @@ You can list the files in the directory using ``ls`` or ``dir``
     mycurve.001
     ...
 
-Now you are ready to generate the playlist. The command to use is
-``glob_curves_to_playlist``.::
+Now you are ready to generate the playlist.  First, create a blank playlist::
+
+    hooke> new_playlist --name mylist
+
+Ensure that the new playlist is active::
+
+    hooke> jump_to_playlist -- -1
+    hooke> get_playlist
+    <FilePlaylist mylist>
+
+The ``--`` in the ``jump_to_playlist`` command lets
+``jump_to_playlist`` know that ``-1`` is an argument and not an
+option.  Using the bare ``--`` is a POSIX specification [#POSIX]_
+supported by the `optparse module`_.
+
+.. _optparse module:
+  http://docs.python.org/library/optparse.html#callback-example-6-variable-arguments
+
+.. [#POSIX] `Guideline 10 of POSIX:2008's section 12.2 <http://www.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html#tag_12_02>`_ states:
+
+    "The first ``--`` argument that is not an option-argument should be
+    accepted as a delimiter indicating the end of options. Any
+    following arguments should be treated as operands, even if they
+    begin with the ``-`` character."
+
+Then glob your curves onto the new list::
 
     hooke> glob_curves_to_playlist mycurve.*
 
-You can also be more specific with wildcards.  For example
+You can also be more specific with wildcards.  For example::
 
     hooke> glob_curve_to_playlist mycurve.05*
 
 will take only curves from :file:`mycurve.050` to :file:`mycurve.059`.
 
-Note that by using ``glob_curve_to_playlist`` you just generate the
+Note that by using ``glob_curves_to_playlist`` you just generate the
 playlist in the local session. To save your playlist to a file for
 future reuse, type::
 
@@ -169,7 +198,7 @@ Taking notes
 ------------
 
 You can take notes about the curves you are looking at.  Just type
-``add_note`` followed by the text you want to append to that curve.
+``set_note`` followed by the text you want to attach to that curve.
 Hooke will save the text in your current playlist and in an external
 log file (TODO: no external file yet.  Is this important?).  The
 output will look like this::
@@ -191,8 +220,8 @@ will create sub-playlist :file:`c:\curves\nice.hkp`.  Make sure that
 the target directory (here :file:`c:\curves\`) already exists before
 doing that.
 
-If you change your mind about a note, you can remove it with
-``clear_note``.
+If you change your mind about a note, you can remove it by setting a
+blank note string with ``set_note ''``.
 
 Exporting curves
 ----------------