The notes action adds a note taking ability to todo.txt shell script. It enables you to add notes, i.e. files associated with one or many tasks in your todo file or files.
The syntax is note:notesfile and this can be added to one or many todo items.
There are a couple directories used by these notes actions.
- TODO_DIR/notes directory for active notes files
- TODO_DIR/notes/archive used to hold archived notes with time stamps prepended
NB. make sure the note name is a single word (no spaces, so use - or _ for multiple words), this is the same restriction as projects and contexts. Notes actions also know about files created with the tickle action (43 folders). The notes files are in the format prefix-notename.txt. Prefix being any extra added to the todo.txt file to separate different todo.sh instances. For example, personal_todo.txt, work_todo.txt or test_todo.txt.
Add a note to an item line or lines via notes add action.
Usage: todo.sh notes add note:test_note 1
Notes can only be edited if the note is in the todo.txt file.
Usage: todo.sh notes edit note_name.
To list active notes run notes list, you will get a list of all active notes in your todo.txt file. It also takes an option which displays only those matching a grep of notes file names.
Usage: todo.sh notes list or todo.sh notes lists testing
To show notes, there is a notes cat action.
Usage: todo.sh notes cat note:name
To find those notes that contain a word or phrase, they are listed in the note:notename format for easy copy paste.
Usage: todo.sh notes grep testing
When you have done all tasks associated with a notes file you can archive the notes file. Archiving moves the notes file to the TODO_DIR/notes/archive directory and adds the date and time of archiving to the file name. This way you can track notes over time.
The notes archive action simply moves all notes files no longer in the todo.txt file.
Usage: todo.sh notes archive
The notes unarchive action can be used to copy the latest archived version of a notesfile back to current.
Usage: todo.sh notes unarchive note:test_note
You can list all archived notes in your todo directory. It also takes an option which displays only those matching a grep of notes file names
Usage: todo.sh notes listarchived test