Skip to content

Commit 30096f2

Browse files
aserebryakovaserebryakov
committed
Merge branch 'dev'
2 parents 11e1fc7 + 9b929ae commit 30096f2

File tree

3 files changed

+158
-66
lines changed

3 files changed

+158
-66
lines changed

‎README.md‎

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Plugin is automatically applied for files with `.todo` extension.
2828

2929
##### TODO Items
3030

31-
The sequence matching the expression '^\s\*[ ].\*' marks a line as a TODO list item.
31+
The sequence matching the expression `^\s\*- [ ].\*` marks a line as a TODO list item.
3232

3333
###### Example
3434

3535
```
36-
[ ] Not done
37-
[X] Done
36+
- [ ] Not done
37+
- [X] Done
3838
```
3939

4040
##### Items Hierarchy
@@ -45,9 +45,9 @@ to be **parent** and the second to be **child**.
4545
###### Example
4646

4747
```
48-
[ ] Parent
49-
[ ] Child1
50-
[ ] Child2
48+
- [ ] Parent
49+
- [ ] Child1
50+
- [ ] Child2
5151
```
5252

5353
###### Rules:
@@ -62,9 +62,9 @@ to be **parent** and the second to be **child**.
6262
Items are highlighted in accordance to the following scheme:
6363

6464
```
65-
[ ] ! Important item (Underlined)
66-
[ ] Normal item (Normal)
67-
[X] Done item (Comment)
65+
- [ ] ! Important item (Underlined)
66+
- [ ] Normal item (Normal)
67+
- [X] Done item (Comment)
6868
```
6969

7070
##### Items moving on state change
@@ -80,19 +80,19 @@ If done list doesn't exist, item is placed just after the last not done item.
8080
*Before*
8181

8282
```
83-
[ ] Not Done 1
84-
[ ] Will be done now
85-
[ ] Not Done 2
86-
[X] Done
83+
- [ ] Not Done 1
84+
- [ ] Will be done now
85+
- [ ] Not Done 2
86+
- [X] Done
8787
```
8888

8989
*After*
9090

9191
```
92-
[ ] Not Done 1
93-
[ ] Not Done 2
94-
[X] Done
95-
[X] Will be done now
92+
- [ ] Not Done 1
93+
- [ ] Not Done 2
94+
- [X] Done
95+
- [X] Will be done now
9696
```
9797

9898
###### Mark item undone
@@ -103,18 +103,18 @@ If all items are marked done, the items is moved before the first done item.
103103
*Before*
104104

105105
```
106-
[ ] Not Done 1
107-
[ ] Not Done 2
108-
[X] Done
109-
[X] Will be undone now
106+
- [ ] Not Done 1
107+
- [ ] Not Done 2
108+
- [X] Done
109+
- [X] Will be undone now
110110
```
111111
*After*
112112

113113
```
114-
[ ] Not Done 1
115-
[ ] Not Done 2
116-
[ ] Will be done now
117-
[X] Done
114+
- [ ] Not Done 1
115+
- [ ] Not Done 2
116+
- [ ] Will be done now
117+
- [X] Done
118118
```
119119

120120
###### Interaction with items hierarchy
@@ -138,6 +138,8 @@ let g:VimTodoListsMoveItems = 0
138138
* `:VimTodoListsGoToNextItem` - go to the next item
139139
* `:VimTodoListsGoToPreviousItem` - go to the previous item
140140
* `:VimTodoListsToggleItem` - toggles the current item (or selected items in visual mode)
141+
* `:VimTodoListsIncreaseIndent` - increases the indent of current line
142+
* `:VimTodoListsDecreaseIndent` - decreases the indent of current line
141143

142144
##### Default key mappings
143145

@@ -149,6 +151,8 @@ let g:VimTodoListsMoveItems = 0
149151
* `O` - create new item below the cursor
150152
* `<Space>` - toggle current item
151153
* `<CR>` - create new item in `insert mode`
154+
* `<Tab>` - increases the indent of current (or selected) line(s)
155+
* `<Shift-Tab>` - decreases the indent of current (or selected) line(s)
152156
* `<leader>e` - switch to normal editing mode
153157

154158
###### Normal editing mode
@@ -174,6 +178,21 @@ function! VimTodoListsCustomMappings()
174178
endfunction
175179
```
176180

181+
##### Automatic date insertion
182+
183+
Automatic date insertion may be enabled by setting the following in `.vimrc`:
184+
185+
```
186+
let g:VimTodoListsDatesEnabled = 1
187+
```
188+
189+
Date format may be changed by setting the format variable to a valid
190+
`strftime()` string:
191+
192+
```
193+
let g:VimTodoListsDatesFormat = "%a %b, %Y"
194+
```
195+
177196
Future features
178197
---------------
179198

@@ -235,7 +254,14 @@ Changelog
235254

236255
* Added items moving on state change
237256

257+
#### 0.7.0
258+
259+
* Added automatic date insertion feature
260+
* Added mappings for fast increasing/decreasing indent
261+
* Items list are made markdown compatible (old files updated automatically on load)
262+
238263
Credits
239264
-------
240265

241266
* Alexander Serebryakov, author ([GitHub](https://github.com/aserebryakov))
267+
* Jake Mason, automatic date insertion ([GitHub](https://github.com/jakemason))

‎doc/vim-todo-lists.txt‎

Lines changed: 53 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*vim-todo-lists.txt* Version 0.6.0
1+
*vim-todo-lists.txt* Version 0.7.0
22
*vim-todo-lists*
33

44
Plugin for TODO lists management.
@@ -50,14 +50,13 @@ Plugin is automatically applied for files with `.todo` extension.
5050
TODO Items
5151
----------
5252

53-
The sequence matching the expression '^ [ ] ' marks a line as a TODO list
54-
item.
53+
The sequence matching the expression `^\s\*- [ ].\*` marks a line as a TODO list item.
5554

5655
Example
5756
-------
5857

59-
[ ] Not done
60-
[X] Done
58+
- [ ] Not done
59+
- [X] Done
6160

6261
Items Hierarchy
6362
---------------
@@ -68,9 +67,9 @@ to be 'parent' and the second to be 'child'.
6867
Example
6968
-------
7069

71-
[ ] Parent
72-
[ ] Child1
73-
[ ] Child2
70+
- [ ] Parent
71+
- [ ] Child1
72+
- [ ] Child2
7473

7574
Rules:
7675
* Changing state of the parent item changes the state of all children items accorndantly
@@ -84,9 +83,9 @@ Items Highlighting
8483

8584
Items are highlighted in accordance to the following scheme:
8685

87-
[ ] ! Important item (Underlined)
88-
[ ] Normal item (Normal)
89-
[X] Done item (Comment)
86+
- [ ] ! Important item (Underlined)
87+
- [ ] Normal item (Normal)
88+
- [X] Done item (Comment)
9089

9190

9291

@@ -105,18 +104,18 @@ If done list doesn't exist, item is placed just after the last not done item.
105104
Before
106105
------
107106

108-
[ ] Not Done 1
109-
[ ] Will be done now
110-
[ ] Not Done 2
111-
[X] Done
107+
- [ ] Not Done 1
108+
- [ ] Will be done now
109+
- [ ] Not Done 2
110+
- [X] Done
112111

113112
After
114113
-----
115114

116-
[ ] Not Done 1
117-
[ ] Not Done 2
118-
[X] Done
119-
[X] Will be done now
115+
- [ ] Not Done 1
116+
- [ ] Not Done 2
117+
- [X] Done
118+
- [X] Will be done now
120119

121120
Mark item undone
122121
----------------
@@ -127,18 +126,18 @@ If all items are marked done, the items is moved before the first done item.
127126
Before
128127
------
129128

130-
[ ] Not Done 1
131-
[ ] Not Done 2
132-
[X] Done
133-
[X] Will be undone now
129+
- [ ] Not Done 1
130+
- [ ] Not Done 2
131+
- [X] Done
132+
- [X] Will be undone now
134133

135134
After
136135
-----
137136

138-
[ ] Not Done 1
139-
[ ] Not Done 2
140-
[ ] Will be done now
141-
[X] Done
137+
- [ ] Not Done 1
138+
- [ ] Not Done 2
139+
- [ ] Will be done now
140+
- [X] Done
142141

143142
Interaction with items hierarchy
144143
--------------------------------
@@ -159,6 +158,7 @@ Commands
159158
*:VimTodoListsCreateNewItemAbove* *:VimTodoListsCreateNewItemBelow*
160159
*:VimTodoListsCreateNewItem* *:VimTodoListsGoToNextItem*
161160
*:VimTodoListsGoToPreviousItem* *:VimTodoListsToggleItem*
161+
*:VimTodoListsIncreaseIndent* *:VimTodoListsDecreaseIndent*
162162

163163
* :VimTodoListsCreateNewItemAbove - creates a new item in a line above cursor
164164
* :VimTodoListsCreateNewItemBelow - creates a new item in a line below cursor
@@ -167,6 +167,8 @@ Commands
167167
* :VimTodoListsGoToPreviousItem - go to the previous item
168168
* :VimTodoListsToggleItem - toggles the current item (or selected items
169169
in visual mode)
170+
* :VimTodoListsIncreaseIndent - increases the indent of current line
171+
* :VimTodoListsDecreaseIndent - decreases the indent of current line
170172

171173

172174
Default key bindings
@@ -180,6 +182,8 @@ Item editing mode
180182
* o - create new item above the cursor
181183
* O - create new item below the cursor
182184
* <Space> - toggle current item
185+
* <Tab> - increases the indent of current (or selected) line(s)
186+
* <Shift-Tab> - decreases the indent of current (or selected) line(s)
183187
* <CR> - create new item in insert mode
184188
* <leader>e - switch to normal editing mode
185189

@@ -190,6 +194,19 @@ Normal editing mode
190194
* <Space> - toggle current item
191195
* <leader>e - switch to item editing mode
192196

197+
198+
Automatic date insertion
199+
------------------------
200+
201+
Automatic date insertion may be enabled by setting the following in .vimrc:
202+
203+
let g:VimTodoListsDatesEnabled = 1
204+
205+
Date format may be changed by setting the format variable to a valid
206+
strftime() string:
207+
208+
let g:VimTodoListsDatesFormat = "%a %b, %Y"
209+
193210
==============================================================================
194211
4. Future Features *VimTodoListsFutureFeatures*
195212

@@ -211,7 +228,7 @@ https://github.com/aserebryakov/vim-todo-lists
211228

212229
MIT License
213230

214-
Copyright (c) 2017 Alexander Serebryakov ([email protected])
231+
Copyright (c) 2018 Alexander Serebryakov ([email protected])
215232

216233
Permission is hereby granted, free of charge, to any person obtaining a copy
217234
of this software and associated documentation files (the "Software"), to deal
@@ -271,10 +288,18 @@ SOFTWARE.
271288

272289
* Added items moving on state change
273290

291+
0.7.0
292+
293+
* Added automatic date insertion feature
294+
* Added mappings for fast increasing/decreasing indent
295+
* Items list are made markdown compatible (old files updated automatically on
296+
load)
297+
274298
==============================================================================
275299
8. Credits *VimTodoListsCredits*
276300

277301
* Alexander Serebryakov (author) https://github.com/aserebryakov
302+
* Jake Mason (automatic date insertion) https://github.com/jakemason
278303

279304
==============================================================================
280305
# vim:tw=78:ts=8:ft=help:norl:

0 commit comments

Comments
 (0)