Updated tutorial's new_playlist call for new PlaylistAddingCommand syntax

[hooke.git] / doc / tutorial.txt

diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index bea22824b52cb02be324299fcafa8c1ab23ac89e..6bba6cbee80c43abf7ec9df926f7d9d900fb5ec4 100644 (file)
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -42,7 +42,7 @@ to run the Hooke shell.::
 If you are running hooke from the source directory (see
 :doc:`install`), the equivalent command is::
 
-    $ python bin/hooke
+    $ python bin/hk.py
 
 You may need to give the full path for Python on Windows systems, and
 also check that the current working directory (`.`) is in your
@@ -123,7 +123,7 @@ You can list the files in the directory using ``ls`` or ``dir``
 
 Now you are ready to generate the playlist.  First, create a blank playlist::
 
-    hooke> new_playlist --name mylist
+    hooke> new_playlist --output_playlist mylist
 
 Ensure that the new playlist is active::
 
@@ -134,7 +134,8 @@ Ensure that the new playlist is active::
 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`_.
+supported by the `optparse module`_.  You don't need to jump if
+the new playlist is your only loaded playlist.
 
 .. _optparse module:
   http://docs.python.org/library/optparse.html#callback-example-6-variable-arguments
@@ -190,9 +191,11 @@ You can also jump to a given curve::
 
     hooke> jump_to_curve 14
 
-will jump to the 14th curve in the playlist.  TODO: jump_to_curve
-<PATH>, where the path can be either an absolute path or a path
-relative to the directory holding the playlist file.
+will jump to the 14th curve in the playlist.
+
+.. todo:: ``jump_to_curve <PATH>``, where the path can be either an
+  absolute path or a path relative to the directory holding the
+  playlist file.
 
 Taking notes
 ------------
@@ -200,8 +203,11 @@ Taking notes
 You can take notes about the curves you are looking at.  Just type
 ``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::
+log file.
+
+.. todo:: No external file yet.  Is this important?
+
+The output will look like this::
 
     Notes taken at Sun Sep 17 20:42:07 2006
     /home/cyclopia/work/tris/20060620a.041 | This is a note
@@ -234,8 +240,9 @@ the filename extension, so ``export_block foo.png``, ``export_block
 foo.eps``, and ``export_block foo.txt`` will save PNG, EPS, and
 TAB-delimited text files respectively.
 
-TODO: multiple cycles?  Solution: blank lines for "breaks", add option
-to extract specific sections using Python's slice notation.
+.. todo:: Multiple cycles in exported data?  Solution: blank lines for
+  "breaks", add option to extract specific sections using Python's
+  slice notation.
 
 If you don't want the entire block, try the ``cut`` command.