dnote 1.2.0 → 1.2.1

data/README.rdoc

@@ -23,19 +23,14 @@ it needs to follow this simple set of rules:
 
   # LABEL: description ...
 
-2) Specially designated notes can omit the colon. By default these are +TODO+,
-+FIXME+ and +OPTIMIZE+.
-
-  # TODO description ...
-
-3) Any note that requires more than one line must remain flush to the left
+2) Any note that requires more than one line must remain flush to the left
 margin (the margin is set by the first line). This is done because RDoc will mistake
 the note for a <tt>&lt;pre&gt;</tt> block if it is indented.
 
   # LABEL: description ...
   # continue ...
 
-4) An alternative to the previous limitation is to indent the whole note, making it 
+3) An alternative to the previous limitation is to indent the whole note, making it 
 a <tt>&lt;pre&gt;</tt> block when rendered by RDoc. Then the text layout is free-form.
 
   # This is a description of something...
@@ -46,31 +41,40 @@ a <tt>&lt;pre&gt;</tt> block when rendered by RDoc. Then the text layout is free
 That's all there is to it, if I can convince the developers of RDoc to recognize labels,
 we may eventually be able to relax the flush rule too, which would be very nice.
 
+There is also a command-line option, <code>--no-colon</code>, which deactives the need for
+a colon after the note label. However this often produces false positives, so it's use is
+discouraged.
+
 
 === Generating Notes
 
 As you can see the commandline interface is pretty straight-forward.
 
-  Usage: dnote [OPTIONS] path1 [path2 ...]
+  USAGE:
+
+    dnote [OPTIONS] path1 [path2 ...]
    
   OUTPUT FORMAT: (choose one)
-          --rdoc                       RDoc comment format
-          --markdown                   Markdown wiki format
-          --xml                        XML markup format
-          --html                       HTML markup format
-          --yaml                       YAML serialization format
-          --json                       JSON serialization format
+      -f, --format NAME                select a format [text]
+      -c, --custom FILE                use a custom ERB template
+          --file                       shortcut for text/file format
+          --list                       shortcut for text/list format
    
   OTHER OPTIONS:
-          --label                      labels to collect
-      -t, --title [TITLE]              title to use in headers
-   
-  STANDARD OPTIONS:
-      -v, --verbose                    extra verbose output
+      -l, --label LABEL                labels to collect
+          --[no-]colon                 match labels with/without colon suffix
+      -x, --exclude PATH               exclude file or directory
+      -i, --ignore NAME                ignore based on any part of the pathname
+      -t, --title TITLE                title to use in header
+      -o, --output PATH                name of file or directory
+      -n, --dryrun                     do not actually write to disk
           --debug                      debug mode
+   
+  COMMAND OPTIONS:
+      -T, --templates                  list available format templates
       -h, --help                       show this help information
 
-The default path is <tt>**/*.rb</tt> and the default format is <tt>--rdoc</tt>. 
+The default path is <tt>**/*.rb</tt> and the default format is <tt>-f rdoc</tt>. 
 Here is an example of DNote's current notes in RDoc format:
 
   = Development Notes

data/lib/dnote.rb

@@ -1,5 +1,5 @@
 module DNote
-  VERSION = "1.2.0"  #:till: VERSION = "<%= version %>"
+  VERSION = "1.2.1"  #:till: VERSION = "<%= version %>"
 
   require 'dnote/session'
 

data/lib/dnote/format.rb

@@ -16,7 +16,7 @@ module DNote
 
     #DEFAULT_OUTPUT_DIR = "log/dnote"
 
-    EXTENSIONS = { 'soap'=>'xml', 'xoxo'=>'xml' }
+    EXTENSIONS = { 'text'=>'txt', 'soap'=>'xml', 'xoxo'=>'xml' }
 
     #
     attr :notes
@@ -103,7 +103,8 @@ module DNote
     #
     def write(result, fname=nil)
       if output.end_with?('/') || File.directory?(output)
-        ext  = EXTENSIONS[format] || format
+        fmt  = format.split('/').first
+        ext  = EXTENSIONS[fmt] || fmt
         file = File.join(output, fname || "notes.#{ext}")
       else
         file = output

data/lib/dnote/session.rb

@@ -219,7 +219,7 @@ module DNote
           session.exclude << path
         end
 
-        opt.on("--ignore", "-i NAME", "ignore based on any part of the pathname") do |name|
+        opt.on("--ignore", "-i NAME", "ignore file based on any part of pathname") do |name|
           session.ignore << name
         end
 
@@ -227,7 +227,7 @@ module DNote
           session.title = title
         end
 
-        opt.on("--output", "-o PATH", "name of file or directory") do |path|
+        opt.on("--output", "-o PATH", "save to file or directory") do |path|
           session.output = path
         end
 

data/meta/version

@@ -1 +1 @@
-1.2.0
+1.2.1

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -05:00
+date: 2010-02-20 00:00:00 -05:00
 default_executable: 
 dependencies: []