Generating Notes

Command-line Interface

The command-line interface is fairly straight-forward.

  USAGE:

    dnote [OPTIONS] path1 [path2 ...]

  OUTPUT FORMAT: (choose one)
      -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:
      -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 **/*.rb and the default format -f rdoc.

Example Output

Using the -T optoion you can see that DNote provides a variety of formats. HTML is especially nice if you would like to publish your project’s notes online. Here is an example of DNote’s own notes in RDoc format:

  = Development Notes

  == TODO

  === file://lib/dnote/notes.rb

  * TODO: Add ability to read header notes. They often
  have a outline format, rather then the single line. (19)
  * TODO: Need good CSS file. (22)
  * TODO: Need XSL? (24)

  === file://plug/syckle/services/dnote.rb

  * TODO: Should this service be part of the +site+ cycle? (18)

  (4 TODOs)

Notice the line numbers for each note is given in parenthesis, making it easy to track down in own code.