*Todo.txt-vim* ##### # # # #### ##### #### ##### # # ##### # # # # # # # # # # # # # # # # # # # ## ## # # # # # # # # ## # ### # # # # ## # # # # # # # # # ## # # # # # # # # # # # # # ## # # # # # # # # # # #### ##### #### ## # # # # # # # # Efficient Todo.txt management in vim =============================================================================== Table of Contents *TodoTxt-Contents* ~ 1. Release notes.................................|TodoTxt-ReleaseNotes| 2. Introduction..................................|TodoTxt-Introduction| 2.1 Todo.txt rules...........................|TodoTxt-Rules| 2.2 Why this Fork............................|TodoTxt-Fork| 2.3 Installation.............................|TodoTxt-Installation| 3. TodoTxt Files.................................|TodoTxt-Files| 4. Completion....................................|TodoTxt-Completion| 5. Hierarchical Sort.............................|TodoTxt-HierarchicalSort| 6. Recurrence....................................|TodoTxt-Recurrence| 7. Mappings......................................|TodoTxt-Mappings| 7.1 Sort.....................................|TodoTxt-Sort| 7.2 Priorities...............................|TodoTxt-Priorities| 7.3 Dates....................................|TodoTxt-Dates| 7.4 Done.txt.................................|TodoTxt-Done| 7.5 Format...................................|TodoTxt-Format| =============================================================================== 1. Release notes *TodoTxt-ReleaseNotes* ~ V0.8.1 Incorporates yet another Fretep work : highlighting for tasks due today. v0.8 Incorporates Fretep's work on overdue dates (PR#13 and PR#16) which removes python dependency, allow to control the cursor position after a sort by todo (see |TodoTxt-Sort| and/or issue #15) and fixes bug when sorting a file containing only lines with due:date (issue #14). v0.7.6 Incorporates [Sietse's work](https://github.com/sietse/todo.txt-vim/commit/57d45200c8b033d31c9191ee0eb0711c801cdb1d) to make cancel and mark as done mapping repeatable using [vim-repeat](https://github.com/tpope/vim-repeat). v0.7.5 Incorporates Fievel's work (https://github.com/fievel/todo.txt-vim/commit/0863e1434e9a89ace06c4856b6cb32ba9906e3de) to make overduedates work on python3. v0.7.4 includes the overduedate support from Guilherme Victal (see pull request #45 on freitass version (https://github.com/freitass/todo.txt-vim/pull/45)), it highlight dates in overdue tasks as an Error. It depends on a Python library, however, and as such will only be able to work if your version of Vim was compiled with the `+python` option (as most common versions do). Since v0.7.3, `TodoComplete` is replaced by `todo#Complete`, you might need to update your vimrc (see |TodoTxt-Completion|). =============================================================================== 2. Introduction *TodoTxt-Introduction* ~ Todo.txt-vim is a plugin to manage todo.txt files it was initially designed by Freitass (https://github.com/freitass/todo.txt-vim) then forked and improved by David Beniamine. 2.1 Todo.txt rules *TodoTxt-Rules* Todo.txt is a standard human readable todo notes file defined here: http://todotxt.com "The todo.txt format is a simple set of rules(https://github.com/todotxt/todotxt/) that make todo.txt both human and machine-readable. The format supports priorities, creation and completion dates, projects and contexts. That's all you need to be productive. See an example Todo.txt file": > (A) Call Mom @Phone +Family (A) Schedule annual checkup +Health (B) Outline chapter 5 +FamilyNovel @Computer (C) Add cover sheets @ComputerOffice +FamilyTPSReports Plan backyard herb garden @ComputerHome Pick up milk @ComputerGroceryStore Research self-publishing services +FamilyNovel @ComputerComputer x Download Todo.txt mobile app @ComputerPhone < 2.2 Why this fork ? *TodoTxt-Fork* This plugin is a fork of freitass todo.txt-vim (https://github.com/freitass/todo.txt-vim). It add several cool functionalities including: + Hierarchical sort: |TodoTxt-Sort| and |TodoTxt-HierarchicalSort|. + A completion function: |TodoTxt-Completion|. + A proper handling of due dates: |TodoTxt-Dates| + A Flexible file naming: |TodoTxt-Files|. + Syntax Highlight for couples key:value. + `x` is a toggle which allow you to unmark a task as done. + `C` Toggle Mark a task cancelled + If the current buffer is a done.txt file, the basic sort sorts on completion date. + ... 2.3 Installation *TodoTxt-Installation* + Vizardry If you have Vizardry(https://github.com/dbeniamine/vizardry) installed, you can run from vim: > :Invoke -u dbeniamine todo.txt-vim < + Pathogen install > git clone https://github.com/dbeniamine/todo.txt-vim.git ~/.vim/bundle/todo.txt-vim < Then from vim: `:Helptags` to update the doc + Quick install > git clone https://github.com/dbeniamine/todo.txt-vim.git cd todo.txt-vim cp -r ./* ~/.vim < If you want the help installed, run `:helptags ~/.vim/doc` inside vim after having copied the files. Then you will be able to get the commands help with: `:h todo.txt` =============================================================================== 3. TodoTxt Files *TodoTxt-Files* ~ This plugin provides a flexible file naming for todo.txt, all the following names are recognized as todo: > YYYY-MM-[Tt]odo.txt YYYY-MM-DD[Tt]odo.txt [Tt]odo-YYYY-MM.txt [Tt]odo-YYYY-MM-DD.txt [Tt]odo.txt [Tt]oday.txt < And obviously the same are recognize as done: > YYYY-MM-[Dd]one.txt YYYY-MM-DD[Dd]one.txt [Dd]one-YYYY-MM.txt [Dd]one-YYYY-MM-DD.txt [Dd]one.txt [Dd]one-[Tt]oday.txt < Moreover, `D` moves the task under the cursor to the done.txt file corresponding to the current todo.txt, aka if you are editing 2015-07-07-todo.txt, the done file while be 2015-07-07-done.txt. If you don't like this behavior, you can set the default done.txt name: > let g:TodoTxtForceDoneName='done.txt' < =============================================================================== 4. Completion *TodoTxt-Completion* ~ This plugin provides a nice complete function for project and context, to use it add the following lines to your vimrc: > " Use todo#complete as the omni complete function for todo files au filetype todo setlocal omnifunc=todo#complete < You can also start automatically the completion when entering '+' or '@' by adding the next lines to your vimrc: > " Auto complete projects au filetype todo imap + + " Auto complete contexts au filetype todo imap @ @ < The `todo#complete` function is designed to complete projects (starting by `+`) and context (starting by `@`). If you use it on a regular word, it will do a normal keyword completion (on all buffers). If you try to complete a project, it will propose all projects in all open buffers and for each of them, it will show their context and the name of the buffers in which they appears in the preview window. It does the same thing for context except that it gives in the preview the list of projects existing in each existing contexts. If you don't want the preview window to open when performing completion, add the following lines to your vimrc: > au filetype todo setlocal completeopt-=preview < If you would like the preview window to open even if there is only one match for a completion, then add the following lines to your vimrc: > au filetype todo setlocal completeopt+=menuone < =============================================================================== 5. Hierarchical sort *TodoTxt-HierarchicalSort* ~ This fork provides a hierarchical sorting function designed to do by project and/or by context sorts and a priority sort. `sc` : Sort the file by context then by priority `scp` : Sort the file by context, project then by priority `sp` : Sort the file by project then by priority `spc` : Sort the file by project, context then by priority The user can give argument for the two calls to vim sort function by changing the following variables: > g:Todo_txt_first_level_sort_mode g:Todo_txt_second_level_sort_mode < Defaults values are: > g:Todo_txt_first_level_sort_mode="i" g:Todo_txt_second_level_sort_mode="i" < For more information on the available flags see |:sort| =============================================================================== 6. Recurrence *TodoTxt-Recurrence* ~ By adding a "rec:" tag to your task, when you complete (`x`) or postpone (`p`) the task, a new recurrence will be created due after the specified amount of time. The format is: `rec:[+][count][d|w|m|y]` Where: d = days, w = weeks, m = months, y = years The optional `+` specifies strict recurrence (see below) Examples: * `rec:2w` - Recurs two weeks after the task is completed. * `rec:3d` - Recurs three days after the task is completed. * `rec:+1w` - Recurs one week from the due date (strict) This is a non-standard but widely adopted keyword. =============================================================================== 7. Mappings *TodoTxt-Mappings* ~ By default todo-txt.vim set all the mappings described in this section. To prevent this behavior, add the following line to your vimrc > let g:Todo_txt_do_not_map=1 < 7.1 Sort *TodoTxt-Sort* `s` : Sort the file by priority `s+` : Sort the file on +Projects `s@` : Sort the file on @Contexts `sc` : Sort the file by context then by priority `scp` : Sort the file by context, project then by priority `sp` : Sort the file by project then by priority `spc` : Sort the file by project, context then by priority `sd` : Sort the file on due dates. Entries with a due date appear sorted by at the beginning of the file, completed tasks are moved to the bottom and the rest of the file is not modified. When you sort by due dates, at the end of the sort, your cursor will be placed at the top of the file. This behavior can be set with the following global variable : let g:TodoTxtSortDueDateCursorPos = "top" Possible values are : + `top` (default): The first line of the buffer, i.e. your most outstanding task + `lastdue`: The last task with a due:date set + `notoverdue`: The first task that is not overdue (requires #13) + `bottom`: The last line of the buffer 7.2 Priorities *TodoTxt-Priorities* `j` : Lower the priority of the current line `k` : Increase the priority of the current line `a` : Add the priority (A) to the current line `b` : Add the priority (B) to the current line `c` : Add the priority (C) to the current line 7.3 Dates *TodoTxt-Dates* `d` : Insert the current date `p` : Postpone the due date (accepts a count) `P` : Decrement the due date (accepts a count) `date` : (Insert mode) Insert the current date `due:` : (Insert mode) Insert `due:` followed by the current date `DUE:` : (Insert mode) Insert `DUE:` followed by the current date If you would like the creation date (today) prefixed on new lines, add the following to your vimrc: > let g:Todo_txt_prefix_creation_date=1 < 7.4 Done *TodoTxt-Done* `x` : Toggle mark task as done (inserts or remove current date as completion date) `C` : Toggle mark task cancelled `X` : Mark all tasks as completed `D` : Move completed tasks to done file, see |TodoTxt-Files| `` is \ by default, so ̀`-s` means you type \s 7.5 Format *TodoTxt-format* `ff` : Try to fix todo.txt format