Generating Notes

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

  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

  OTHER OPTIONS:
          --label                      labels to collect
      -t, --title [TITLE]              title to use in headers

  STANDARD OPTIONS:
      -v, --verbose                    extra verbose output
          --debug                      debug mode
      -h, --help                       show this help information

The default path is /.rb and the default format —rdoc. Here is an example of DNote’s current notes in RDoc format:

  = Development Notes

  == TODO

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

  * TODO: Add ability to read header notes. They oftern
  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)

As you can see by the command help a variety of formats are available, here are examples of the XML, HTML and YAML formats.