aboutsummaryrefslogtreecommitdiffstats
path: root/doc/todo.txt
blob: d98cece4ac17ce136480041c58fe391f0dd3f141 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
*todo.txt*  To-do list syntax highlighting and mappings

Author:  Teddy Wing <http://teddywing.com>
License: GPLv3+
Version: 0.2.0

==============================================================================
INTRODUCTION                                                            *todo*

Syntax highlighting and mappings to view and manipulate to-do lists. Files
should end in a ".todo" extension.

==============================================================================
EXAMPLE                                                         *todo-example*

    - Regular priority to-dos are prefixed with a "- "
    _ A low priority to-do
    ! A high priority to-do
    x A deleted to-do
    S A partially completed to-do
    v A completed to-do

==============================================================================
MAPPINGS                                                       *todo-mappings*

				*todo-<Plug>TwodoNewTodoBelow*
<Plug>TwodoNewTodoBelow
	Add a new to-do below the current line.

	Default: <LocalLeader>n

				*todo-<Plug>TwodoNewTodoAbove*
<Plug>TwodoNewTodoAbove
	Add a new to-do above the current line.

	Default: <LocalLeader>N

				*todo-<Plug>TwodoMarkComplete*
<Plug>TwodoMarkComplete
	Mark the current to-do complete.

	Default: <LocalLeader>c

				*todo-<Plug>TwodoMarkDeleted*
<Plug>TwodoMarkDeleted
	Mark the current to-do deleted.

	Default: <LocalLeader>d

				*todo-<Plug>TwodoMarkPartiallyCompleted*
<Plug>TwodoMarkPartiallyCompleted
	Mark the current to-do partially complete.

	Default: <LocalLeader>s

				*todo-<Plug>TwodoRemoveOldTodos*
<Plug>TwodoRemoveOldTodos
	Remove todos marked complete and deleted.

	Default: <LocalLeader>R

				*todo-<Plug>TwodoEscalate*
<Plug>TwodoEscalate
	Increase the priority of the current to-do.

	Default: <LocalLeader>=

				*todo-<Plug>TwodoDescalate*
<Plug>TwodoDescalate
	Decrease the priority of the current to-do.

	Default: <LocalLeader>-

				*todo-<Plug>TwodoNextIncomplete*
<Plug>TwodoNextIncomplete
	Move to the next [count] unfinished to-do. (Mnemonic: "unfinished")

	Default: ]u

				*todo-<Plug>TwodoPreviousIncomplete*
<Plug>TwodoPreviousIncomplete
	Move to the previous [count] unfinished to-do. (Mnemonic: "unfinished")

	Default: [u

				*todo-<Plug>TwodoNextRegular*
<Plug>TwodoNextRegular
	Move to the next [count] unfinished to-do. (Mnemonic: "ordinary")

	Default: ]o

				*todo-<Plug>TwodoPreviousRegular*
<Plug>TwodoPreviousRegular
	Move to the previous [count] unfinished to-do. (Mnemonic: "ordinary")

	Default: [o

				*todo-<Plug>TwodoNextImportant*
<Plug>TwodoNextImportant
	Move to the next [count] unfinished to-do. (Mnemonic: "yimportant")

	Default: ]y

				*todo-<Plug>TwodoPreviousImportant*
<Plug>TwodoPreviousImportant
	Move to the previous [count] unfinished to-do. (Mnemonic: "yimportant")

	Default: [y


==============================================================================
COLOURS                                                          *todo-colors*

				*todo-todoUndone*
todoUndone	A regular priority to-do.

				*todo-todoImportant*
todoImportant	To-do with important priority.

				*todo-todoUnimportant*
todoUnimportant	To-do with low priority.

				*todo-todoCompleted*
todoCompleted	Completed to-do.

				*todo-todoDeleted*
todoDeleted	Deleted to-do.


==============================================================================
LICENSE                                                         *todo-license*

Copyright (c) 2016, 2020, 2021 Teddy Wing

Twodo is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Twodo is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Twodo. If not, see <http://www.gnu.org/licenses/>.

 vim:tw=78:ts=8:ft=help:norl: