Updated doc/gui.txt and add and use Sphinx' todo extension.

[hooke.git] / doc / tutorial.txt

diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index bea22824b52cb02be324299fcafa8c1ab23ac89e..6bfe3e0ce54f45a8e6d34dadd311e9d4cb14e764 100644 (file)
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -190,9 +190,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 +202,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 +239,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.