[dotfiles.git] / base / .vim / doc / todo.txt

*todo.txt*	Vim plugin for Todo.txt files
                     _____         _       _        _   ~
                    |_   _|__   __| | ___ | |___  _| |_ ~
                      | |/ _ \ / _` |/ _ \| __\ \/ / __|~
                      | | (_) | (_| | (_) | |_ >  <| |_ ~
                      |_|\___/ \__,_|\___(_)__/_/\_\\__|~

                              Reference Manual~

==============================================================================
CONTENTS                                                       *todo-contents*

	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|

==============================================================================
1. Commands                                                    *todo-commands*

1.1 Sorting tasks:                                     *todo-commands-sorting*
	`<localleader>s`   Sort the file
	`<localleader>s+`  Sort the file on +Projects
	`<localleader>s@`  Sort the file on @Contexts
	`<localleader>sd`  Sort the file on dates
	`<localleader>sdd` Sort the file on due dates (i.e. due:2015-10-25)

1.2 Edit priority:                                    *todo-commands-priority*
	`<localleader>j`   Decrease the priority of the current line
	`<localleader>k`   Increase the priority of the current line
	`<localleader>a`   Add the priority (A) to the current line
	`<localleader>b`   Add the priority (B) to the current line
	`<localleader>c`   Add the priority (C) to the current line

1.3 Date:                                                 *todo-commands-date*
	`<localleader>d`   Set current task's creation date to the current date
	`date<tab>`        (Insert mode) Insert the current date

1.4 Mark as done:                                         *todo-commands-done*
	`<localleader>x`   Mark current task as done
	`<localleader>X`   Mark all tasks as done
	`<localleader>D`   Move completed tasks to done.txt

See :h <localleader> for more information about the commands' prefix.

==============================================================================
2. Options                                                      *todo-options*

                                                      *'g:todo_existing_date'*
Specify the behavior of date insertion functions when the task already has a
date of creation: >
  let g:todo_existing_date = 'n'
<
  r - replace existing date (default)
  n - do nothing

                                                      *'g:todo_load_python'*
Specify if the plugin should load the python module. Useful if you use Neovim
for example or if perhaps you just don't have/want python for vim: >
  let g:todo_load_python = 1
<
  1 - Load (default)
  0 - Don't load

===============================================================================
vim:ft=help:et:ts=2:sw=2:sts=2:norl
Commit	Line	Data
189288f7	1	todo.txt Vim plugin for Todo.txt files
	2	_____ _ _ _ ~
	3	\|_ _\|__ __\| \| ___ \| \|___ _\| \|_ ~
	4	\| \|/ _ \ / _` \|/ _ \\| __\ \/ / __\|~
	5	\| \| (_) \| (_\| \| (_) \| \|_ > <\| \|_ ~
	6	\|_\|\___/ \__,_\|\___(_)__/_/\_\\__\|~
	7
	8	Reference Manual~
	9
	10	==============================================================================
	11	CONTENTS todo-contents
	12
	13	1. Commands ..................................... \|todo-commands\|
	14	1.1. Sorting tasks ............................ \|todo-commands-sorting\|
	15	1.2. Edit priority ............................ \|todo-commands-priority\|
	16	1.3. Date ..................................... \|todo-commands-date\|
	17	1.4. Mark as done ............................. \|todo-commands-done\|
	18	2. Options ...................................... \|todo-options\|
	19
	20	==============================================================================
	21	1. Commands todo-commands
	22
	23	1.1 Sorting tasks: todo-commands-sorting
	24	`<localleader>s` Sort the file
	25	`<localleader>s+` Sort the file on +Projects
	26	`<localleader>s@` Sort the file on @Contexts
	27	`<localleader>sd` Sort the file on dates
	28	`<localleader>sdd` Sort the file on due dates (i.e. due:2015-10-25)
	29
	30	1.2 Edit priority: todo-commands-priority
	31	`<localleader>j` Decrease the priority of the current line
	32	`<localleader>k` Increase the priority of the current line
	33	`<localleader>a` Add the priority (A) to the current line
	34	`<localleader>b` Add the priority (B) to the current line
	35	`<localleader>c` Add the priority (C) to the current line
	36
	37	1.3 Date: todo-commands-date
	38	`<localleader>d` Set current task's creation date to the current date
	39	`date<tab>` (Insert mode) Insert the current date
	40
	41	1.4 Mark as done: todo-commands-done
	42	`<localleader>x` Mark current task as done
	43	`<localleader>X` Mark all tasks as done
	44	`<localleader>D` Move completed tasks to done.txt
	45
	46	See :h <localleader> for more information about the commands' prefix.
	47
	48	==============================================================================
	49	2. Options todo-options
	50
	51	'g:todo_existing_date'
	52	Specify the behavior of date insertion functions when the task already has a
	53	date of creation: >
	54	let g:todo_existing_date = 'n'
	55	<
	56	r - replace existing date (default)
	57	n - do nothing
	58
	59	'g:todo_load_python'
	60	Specify if the plugin should load the python module. Useful if you use Neovim
	61	for example or if perhaps you just don't have/want python for vim: >
	62	let g:todo_load_python = 1
	63	<
	64	1 - Load (default)
65	0 - Don't load
66
67	===============================================================================
68	vim:ft=help:et:ts=2:sw=2:sts=2:norl