OSDN Git Service

copy old 'master' branch (c3a8f31) just after test160101
[howm/howm.git] / en / 0000-00-00-000000.txt
1 = <<< %menu%
2  %"e"[Remember] %"c"[New] %"D"[Dup] Search(%"s"[String] %"g"[Regexp] %"o"[Occur])
3  %"a"[All] %"l"[Recent] %"A"[Around] %"y"[Schedule] %"t"[Todo] %"b"[Buffers] %"x"[Marks]
4  %"K"[<Title] [<Name] %"d"[Date>] %"i"[Key>] %"r"[Update] %"w"[Random Walk] [Killall]
5  %"."[Today] %":"[Yesterday] %"h"[History] %"R"[Update Menu] [Edit Menu] [Preference]
6 -------------------------------------
7 [Schedule, Todo] -- @schedule, !deadline (until %sdays days from now)
8 !deadline, +todo, -reminder, ~defer (top %tnum entries)
9 %reminder
10 -------------------------------------
11 Recent
12 %recent
13 -------------------------------------
14 Random -- If you do not like this, [Edit Menu] to erase it.
15 %random
16 -------------------------------------
17
18 Format of schedule and todo (Please replace {} with []):
19 {2002-10-21}@1  schedule -- (shown in schedule part. @3 = "3 days schedule to 10-23")
20 {2002-10-21}+7  todo -- float up slowly from the date in 7 days
21 {2002-10-21}!7  deadline -- float up fast from 7 days before the date
22 {2002-10-21}-1  reminder -- float at the date and sink slowly one unit per 1 day
23 {2002-10-21}~30 defer -- float at the date and repeat sinking and floating with 30 days period
24 {2002-10-21}.   done -- sink forever
25 (Numbers after marks are default values.)
26
27 How to remember:
28 * Schedule at(@) the date
29 * Reminder sinks down(-).
30 * Todo floats up(+).
31 * Deadline needs attention!
32 * Defer waves(~) up and down.
33 * Done is the end(.).
34
35 -------------------------------------
36
37 You can edit this menu itself.
38 >>> %Editing Menu%
39
40
41 = <<< %Editing Menu%
42 [Edit Menu] Hit RET on the left button to edit this menu.
43 [Update Menu] Hit RET on the left button to update this menu.
44 --------------------------------------------------------
45
46 *** Format of the menu file ***
47 (Please hit RET on [Edit Menu] and read the source file.)
48
49 == Basic format
50
51 As you see...
52
53 * [xxx] is button.
54 * %REMINDER (in small letters) is schedule and todo list.
55 * %RECENT (in small letters) is list of recent entries.
56 * %RANDOM (in small letters) is list of random entries.
57
58 You can arrange their places as you like.
59 Writing favorite files or goto links may be also convenient.
60 (ex) file:///etc/services   >>> wiki
61
62 == Shortcut
63
64 %"foo"[All]
65 This is displayed as foo[All], and the key "f" executes [All].
66 Exactly speaking, it executes the following sequence:
67 (1) move to closing ", (2) move to next underline, and (3) hit it.
68
69 %"bar%"
70 If you put % at the tail like this, the key "b" means "move cursor here".
71
72 == For lispers
73
74 Display:
75 %here%howm-congrats-count ;; embed value of variable howm-congrats-count
76 %here%(howm-menu-search "search")
77 ;; embed result of (...), that is, search "search" and embed matched lines
78 Functions must be registered for safety.
79 (setq howm-menu-allow (append '(foo bar) howm-menu-allow)) ;; allow foo, bar
80
81 Action:
82 %eval%(message (buffer-name))  ;; evaluate S expr
83 %call%find-file  ;; call function interactively
84 Both are evaluated in the previous buffer before raising menu.
85
86 == Hiding
87
88 '%' + '|' toggles invisibility
89 like this: visible%|invisible%|appear%|disappear  - until the end of line
90 (Newline is removed when the end of line is invisible.)
91
92 == Multiple menus
93
94 Links to %xxx% open "<< < %xxx%" with menu-mode: >>> %menu%
95 When you add new menu, [[%menu%]] may be more convenient because corresponding
96 entry is generated automatically.
97
98 %eval%(howm-menu-open "00000000-000000.txt")  -- open file with menu-mode