Generating Notes

Command-line Interface

As you can see the command-line interface is quite straight-forward.

  Usage: dnote [OPTIONS] path1 [path2 ...]

  OUTPUT FORMAT: (choose one)
          --gnu                        Plain text format (default)
          --rdoc                       RDoc comment format
          --markdown                   Markdown wiki format
          --soap                       SOAP XML envelope format
          --xoxo                       XOXO microformat format
          --xml                        XML markup format
          --html                       HTML markup format
          --yaml                       YAML serialization format
          --json                       JSON serialization format
      -t, --template FILE              Use a custom Erb template

  OTHER OPTIONS:
          --label                      labels to collect
          --title [TITLE]              title to use in headers
      -o, --output [PATH]              name of file or directory

  STANDARD OPTIONS:
          --debug                      debug mode
      -n, --dryrun                     do not actually write to disk
      -h, --help                       show this help information

The default path is **/*.rb and the default format --rdoc.

Example Output

As you can see by the command help a variety of formats are available. HTML is especially nice if you would like to publish your project’s notes online. Here is an example of D’Note’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.