OSDN Git Service

add descriptions of snapshot version (melpa / git)
[howm/howm.git] / doc / README.rd
1 =begin
2
3 = howm tutorial
4
5 == First day
6
7 === Write a note.
8
9 * Type Ctrl-C , , to open the menu.
10     [New] Search([String] [Regexp]) [Dup] [<Title] [<Name] [Date>] [Key>] [Update]
11     [All] [Recent] [Schedule] [Todo] [Update Menu]
12 * Confirm the cursor is on [New], and type [return] there to open new note.
13     = 
14     [2002-09-16 20:08] >>> /home/hira/elisp/howm/howm-mode.el
15 * Write anything.
16     = First note
17     [2002-09-16 20:08] >>> /home/hira/elisp/howm/howm-mode.el
18     foo
19     bar
20     baz
21
22
23 == Second day
24
25 === Write today's note.
26
27 * Type Ctrl-C , , and type [return] on [New]. Then, write freely.
28
29 === Read notes.
30
31 * Type Ctrl-C , , to open the menu.
32     [New] Search([String] [Regexp]) [Dup] [<Title] [<Name] [Date>] [Key>] [Update]
33     [All] [Recent] [Schedule] [Todo] [Update Menu]
34 * Move the cursor to [All] and type [return] there to browse all notes.
35 * Move the cursor up and down to view each note.
36 * Type [space] and [backspace] to scroll the note.
37 * Type [return] to open the note.
38
39 === Concatenate notes.
40
41 * Type Ctrl-C , , to open the menu.
42 * Move the cursor to [All] and type [return].
43 * Type @ to concatenate all notes.
44 * Type [space] and [backspace] to scroll the notes.
45 * Type @ to toggle summary-view and concatenated-view.
46 * Type [return] to open the note.
47
48 === Search a word in notes.
49
50 * Type Ctrl-C , , to open the menu.
51 * Move the cursor to [String] and type [return] there to search for a string.
52     Keyword:
53 * Input a string.
54     Keyword: foo
55 * Type [return] to browse matched notes.
56
57 === Search a phrase in notes.
58
59 * Type Ctrl-C , , to open the menu.
60 * Move the cursor to [String] and type [return].
61 * Input a string. Type Ctrl-q and [space] to input a whitespace.
62     Keyword: hoge fuga
63 * Type [return] to browse matched notes.
64
65
66 == Third day
67
68 === Try goto link.
69
70 * Ctrl-C , , and [return] on [New] to open new note.
71 * Write '>>> foo'.
72     = 
73     [2002-09-17 20:15]
74     >>> foo
75 * A line is drawn under it.
76   Move the cursor on it and type [return] to search for 'foo' in all notes.
77
78 === Try come-from link.
79
80 * Write '<<< hoge' in today's note.
81     = 
82     [2002-09-17 20:15]
83     >>> foo
84     <<< hoge
85 * Move the cursor on '<<<' and type [return] to search for 'hoge' in all notes.
86 * Select the first day's note and type [return] to open it.
87 * A line is drawn under 'hoge'.
88   Move the cursor on it and type [return] to search for 'hoge' in all notes.
89 * Remember that '<<< hoge' is always shown first when you search for 'hoge'.
90   Others are sorted by their modification time.
91
92 === Search come-from keyword with completion.
93
94 * Ctrl-C , , and [return] on [String] to search for a keyword.
95     Keyword:
96 * Type 'ho' and type [space] to complete come-from keyword 'hoge'.
97     Keyword: hoge
98 * Type [return] to search for 'hoge'.
99
100
101 == Fourth day
102
103 === Sort notes.
104
105 * Ctrl-C , , and [return] on [All] to browse all notes.
106 * Type S to sort notes.
107     Sort by:
108 * Type [space] to show available criteria.
109 * Type 'da' and type [space] to complete 'date'.
110     Sort by: date
111 * Type [return] to execute it.
112
113 === Filter notes.
114
115 * Ctrl-C , , and [return] on [All] to browse all notes.
116 * Type f to filter notes.
117     Filter by:
118 * Type [space] to show available criteria.
119 * Type 'co' and type [space] to complete 'contents'.
120     Filter by: contents
121 * Type [return] and input 'foo'.
122     Search in result (grep): foo
123 * Type [return] to execute it.
124
125 === Read help.
126
127 * Ctrl-C , , and [return] on [All] to browse all notes.
128 * Type ? and read the help message.
129
130 === Use shortcut.
131
132 * Type Ctrl-C , c to create new note.
133
134
135 == Fifth day
136
137 === Input todo.
138
139 * Type Ctrl-C , c to create new note.
140 * Write as follows.
141     [2003-09-10]- foo
142     [2003-09-10]+ bar
143     [2003-09-10]! baz
144     [2003-09-10]~ qux
145
146 === Browse todo.
147
148 * Ctrl-C , , and [return] on [Todo] to browse all todo.
149 * Move cursor and type [return] to open the note.
150 * Type Ctrl-C , , to show the head of todo under the menu.
151 * Items are sorted by a magic criterion.
152     - sink after the date (reminder)
153     + float after the date (todo)
154     ! float until the date (deadline)
155     ~ sink and float periodically after the date (defer)
156
157 === Finish todo.
158
159 * Ctrl-C , , and [return] on [Todo] to browse all todo.
160 * Move cursor and type [return] to open the note.
161     [2003-09-10]- foo
162 * Move cursor on - and type [return] to show todo-menu.
163     RET (done), x (cancel), symbol (type), num(laziness): 
164 * Type [return] to finish this todo.
165     [2003-09-10]. [2003-09-10]:- foo
166
167 === Input schedule.
168
169 * Type Ctrl-C , c to create new note.
170 * Write as follows.
171     [2003-09-10]@ hoge
172
173 === Browse schedule.
174
175 * Ctrl-C , , and [return] on [Schedule] to browse all schedule.
176 * Type [space] and [backspace] to scroll the list.
177 * Type . to jump to today.
178 * Type Ctrl-C , , to show the head of schedule under the menu.
179 * Type [return] on > at the beginning of line to open the corresponding note.
180
181 === Input recurring tasks.
182
183 * move cursor to '2003-09-10' on the below form in the opened note.
184     [2003-09-10]@ hoge
185 * Type [return] to show date-menu.
186     [Wed] RET(goto), +num(shift), yymmdd(set), ~yymmdd(repeat), .(today): 
187 * Input ~031231 [return] and then type m [return] to the below question.
188     Every? [RET(all), num(days) w(week), m(month), y(year)] 
189 * And monthly tasks are added automatically until 2003-12-31.
190     [2003-09-10]@ hoge
191     [2003-10-10]@ hoge
192     [2003-11-10]@ hoge
193     [2003-12-10]@ hoge
194 * You can use '~1231' instead of '~031231' to input same-year items.
195
196
197 == Sixth day
198
199 === Try action-lock { }.
200
201 * Type Ctrl-C , c to create new note.
202 * Write { }.
203     { }
204 * Move cursor on { } and type [return].
205     {*}
206 * Type [return] again.
207     {-}
208
209 === Try action-lock {_}.
210
211 * Type Ctrl-C , c to create new note.
212 * Write {_}.
213     {_}
214 * Move cursor on {_} and type [return].
215     [2003-09-10 04:12]
216
217 === Try aliases.
218
219 * Write '<<< hoge <<< fuga <<< piyo' in a note.
220     = 
221     [2002-09-17 20:15]
222     <<< hoge <<< fuga <<< piyo
223 * Write 'hoge' in another note.
224 * Write 'fuga' in yet another note.
225 * Put cursor on 'fuga' and type [return].
226   You will see all 'hoge', 'fuga', and 'piyo' are found together.
227
228
229 == Seventh day
230
231 === Try customization.
232
233 * Type Ctrl-C , , to show the menu.
234 * Move cursor on [Preference] and type [return].
235 * Watch customization items and modify them if you like.
236
237 === Try editing menu.
238
239 * Type Ctrl-C , , to show the menu.
240 * Move cursor on [Edit Menu] and type [return].
241 * Delete the line '%random', and type Ctrl-C , , to observe its effect.
242 * Again try [Edit Menu] and write '%random' to restore it.
243 * Type Ctrl-C , , and move cursor to '%Editing Menu%' at the bottom.
244 * Type [return] and read documentation of menu syntax.
245
246 =end