OSDN Git Service

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