diff --git a/README.markdown b/README.markdown index 59642a5..d881999 100644 --- a/README.markdown +++ b/README.markdown @@ -22,29 +22,29 @@ function for context and projects (see section 1.4). This plugin gives syntax highlighting to [todo.txt](http://todotxt.com/) files. It also defines a few mappings, to help with editing these files: -`-s` : Sort the file +`s` : Sort the file -`-s+` : Sort the file on +Projects +`s+` : Sort the file on +Projects -`-s@` : Sort the file on @Contexts +`s@` : Sort the file on @Contexts -`-j` : Lower the priority of the current line +`j` : Lower the priority of the current line -`-k` : Increase the priority of the current line +`k` : Increase the priority of the current line -`-a` : Add the priority (A) to the current line +`a` : Add the priority (A) to the current line -`-b` : Add the priority (B) to the current line +`b` : Add the priority (B) to the current line -`-c` : Add the priority (C) to the current line +`c` : Add the priority (C) to the current line -`-d` : Insert the current date +`d` : Insert the current date `date` : (Insert mode) Insert the current date -`-x` : Toggle mark task as done (inserts current date as completion date) +`x` : Toggle mark task as done (inserts current date as completion date) -`-X` : Mark all tasks as completed +`X` : Mark all tasks as completed `-D` : Move completed tasks to done.txt @@ -56,10 +56,10 @@ Then you will be able to get the commands help with: :h todo.txt 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 +`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 call to vim sort function by changing the following variables in its vimrc: @@ -67,22 +67,22 @@ see :help sort let g:Todo_txt_first_level_sort_mode="! i" let g:Todo_txt_second_level_sort_mode="i" -Also `-x` is a toggle which allow you to unmark a task as done. +Also `x` is a toggle which allow you to unmark a task as done. We also provide a nice complete function for project and context, to use it add the following lines to your vimrc: - " Use TodoComplete as the user complete - au filetype todo setlocal completefunc=TodoComplete + " Use TodoComplete as the omni complete function for todo files + au filetype todo setlocal omnifunc=TodoComplete 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 + + + au filetype todo imap + + " Auto complete contexts - au filetype todo imap @ @ + au filetype todo imap @ @ The TodoComplete function is designed to complete projects (starting by '+') and context (starting by '@'). If you use it on a regular word, it will do a diff --git a/doc/todo.txt b/doc/todo.txt index 30707d8..fcaeed5 100644 --- a/doc/todo.txt +++ b/doc/todo.txt @@ -3,40 +3,40 @@ ============================================================================== COMMANDS *todo-commands* -`-s` : Sort the file by priority +`s` : Sort the file by priority -`-s+` : Sort the file on +Projects +`s+` : Sort the file on +Projects -`-s@` : Sort the file on @Contexts +`s@` : Sort the file on @Contexts -`-sc` : Sort the file by context then by priority +`sc` : Sort the file by context then by priority -`-scp` : Sort the file by context, project then by priority +`scp` : Sort the file by context, project then by priority -`-sp` : Sort the file by project then by priority +`sp` : Sort the file by project then by priority -`-spc` : Sort the file by project, context then by priority +`spc` : Sort the file by project, context then by priority -`-j` : Lower the priority of the current line +`j` : Lower the priority of the current line -`-k` : Increase the priority of the current line +`k` : Increase the priority of the current line -`-a` : Add the priority (A) to the current line +`a` : Add the priority (A) to the current line -`-b` : Add the priority (B) to the current line +`b` : Add the priority (B) to the current line -`-c` : Add the priority (C) to the current line +`c` : Add the priority (C) to the current line -`-d` : Insert the current date +`d` : Insert the current date `date` : (Insert mode) Insert the current date -`-x` : Toggle mark task as done (inserts or remove current date as +`x` : Toggle mark task as done (inserts or remove current date as completion date) -`-X` : Mark all tasks as completed +`X` : Mark all tasks as completed -`-D` : Move completed tasks to done.txt +`D` : Move completed tasks to done.txt is \ by default, so -s means you type \s @@ -60,16 +60,16 @@ For more information on the available flags see help :sort We also provide a nice complete function for project and context, to use it add the following lines to your vimrc: -" Use TodoComplete as the user complete -au filetype todo setlocal completefunc=TodoComplete +" Use TodoComplete as the omni complete for todo files +au filetype todo setlocal omnifunc=TodoComplete 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 + + +au filetype todo imap + + " Auto complete contexts -au filetype todo imap @ @ +au filetype todo imap @ @ =============================================================================== COMPLETION *todo-complete*