OSDN Git Service

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