README.md

taskpaper

This library implements the TaskPaper file format in Go.

Usage

Below is a short example program that parses TaskPaper document and shows the resulting data structure:

doc, _ := taskpaper.Unmarshal([]byte(strings.TrimSpace(`
My Project:
- Task A
  - Task B
- Task C
  Some note for Task C
`)))
data, _ := json.MarshalIndent(doc, "", "  ")
fmt.Printf("%s\n", data)

{
  "Kind": "document",
  "Children": [
    {
      "Kind": "project",
      "Content": "My Project",
      "Children": [
        {
          "Kind": "task",
          "Content": "Task A",
          "Children": [
            {
              "Kind": "task",
              "Content": "Task B"
            }
          ]
        },
        {
          "Kind": "task",
          "Content": "Task C",
          "Children": [
            {
              "Kind": "note",
              "Content": "Some note for Task C"
            }
          ]
        }
      ]
    }
  ]
}

File Format

Since there is only a reference implementation, but no specification for the file format, I decided to define the TaskPaper ABNF that is implemented by this library as follows:

; The last item has no trailing CR.
document  = *(item CR) *1item
item      = (task / project / note)
task      = "- " content
project   = content ":"
note      = content
; The first tag needs no space in front of it, and the last tag doesn't need
; a space after it.
content   = *1(tag " ") *(" " tag " " / OCTET) *1(" " tag)
; A tag name or value can be empty which is weird, but you can try it in
; TaskPaper.
tag       = "@" tag_name *1("(" tag_value ")")
tag_name  = *OCTET
tag_value = *OCTET