Skip to content

Commit 6501625

Browse files
committed
README update with a feature description (#13)
1 parent 8c9eb84 commit 6501625

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,69 @@ Items are highlighted in accordance to the following scheme:
6767
[X] Done item (Comment)
6868
```
6969

70+
##### Items moving on state change
71+
72+
By default item when its status is changed is moved in the list in accordance
73+
to the following rules
74+
75+
###### Mark item done
76+
77+
Item marked as done is moved to the end of all done items list.
78+
If done list doesn't exist, item is placed just after the last not done item.
79+
80+
**Before**
81+
82+
```
83+
[ ] Not Done 1
84+
[ ] Will be done now
85+
[ ] Not Done 2
86+
[X] Done
87+
```
88+
89+
**After**
90+
91+
```
92+
[ ] Not Done 1
93+
[ ] Not Done 2
94+
[X] Done
95+
[X] Will be done now
96+
```
97+
98+
###### Mark item undone
99+
100+
Undone item is moved to the end of all not done items list.
101+
If all items are marked done, the items is moved before the first done item.
102+
**Before**
103+
104+
```
105+
[ ] Not Done 1
106+
[ ] Not Done 2
107+
[X] Done
108+
[X] Will be undone now
109+
```
110+
111+
**After**
112+
113+
```
114+
[ ] Not Done 1
115+
[ ] Not Done 2
116+
[ ] Will be done now
117+
[X] Done
118+
```
119+
120+
###### Interaction with items hierarchy
121+
122+
This feature also affect the items in hierarchy in accordance to the rules above
123+
124+
###### Disable the items moving
125+
126+
If you don't want items to be moved after state change, you may add the following
127+
line into your `.vimrc` file:
128+
129+
```
130+
let g:VimTodoListsMoveItems = 0
131+
```
132+
70133
##### Commands
71134

72135
* `:VimTodoListsCreateNewItemAbove` - creates a new item in a line above cursor

0 commit comments

Comments
 (0)