From 25a63d5ecde22e2ad339353f63df0560962a423f Mon Sep 17 00:00:00 2001 From: Leandro Freitas Date: Wed, 6 May 2015 16:39:14 -0300 Subject: [PATCH] Improved documentation --- doc/todo.txt | 69 ++++++++++++++++++++++++++++------------------------ 1 file changed, 37 insertions(+), 32 deletions(-) diff --git a/doc/todo.txt b/doc/todo.txt index b948a82..2a28bf4 100644 --- a/doc/todo.txt +++ b/doc/todo.txt @@ -1,46 +1,51 @@ -*todo.txt* +*todo.txt* Vim plugin for Todo.txt files + _____ _ _ _ ~ + |_ _|__ __| | ___ | |___ _| |_ ~ + | |/ _ \ / _` |/ _ \| __\ \/ / __|~ + | | (_) | (_| | (_) | |_ > <| |_ ~ + |_|\___/ \__,_|\___(_)__/_/\_\\__|~ + + Reference Manual~ ============================================================================== CONTENTS *todo-contents* - 1. Commands ........................... |todo-commands| - 2. Options ............................ |todo-options| + 1. Commands ..................................... |todo-commands| + 1.1. Sorting tasks ............................ |todo-commands-sorting| + 1.2. Edit priority ............................ |todo-commands-priority| + 1.3. Date ..................................... |todo-commands-date| + 1.4. Mark as done ............................. |todo-commands-done| + 2. Options ...................................... |todo-options| ============================================================================== -COMMANDS *todo-commands* +1. Commands *todo-commands* -`-s` : Sort the file - -`-s+` : Sort the file on +Projects - -`-s@` : Sort the file on @Contexts - -`-sd` : Sort the file on dates - -`-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 - -`-d` : Insert the current date - -`date` : (Insert mode) Insert the current date - -`-x` : Mark task as done (inserts current date as completion date) - -`-X` : Mark all tasks as completed - -`-D` : Move completed tasks to done.txt +1.1 Sorting tasks: *todo-commands-sorting* + `s` Sort the file + `s+` Sort the file on +Projects + `s@` Sort the file on @Contexts + `sd` Sort the file on dates + +1.2 Edit priority: *todo-commands-priority* + `j` Decrease 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 + +1.3 Date: *todo-commands-date* + `d` Set current task's creation date to the current date + `date` (Insert mode) Insert the current date + +1.4 Mark as done: *todo-commands-done* + `x` Mark current task as done + `X` Mark all tasks as done + `D` Move completed tasks to done.txt See :h for more information about the commands' prefix. ============================================================================== -OPTIONS *todo-options* +2. Options *todo-options* *'g:todo_existing_date'* Specify the behavior of date insertion functions when the task already has a