Mercurial > emacs
comparison man/org.texi @ 71312:e050af4a9e72
(Progress logging): New section.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Sat, 10 Jun 2006 14:16:17 +0000 |
parents | f32b17d18b4b |
children | 0b2c58e8821c |
comparison
equal
deleted
inserted
replaced
71311:289fa893412b | 71312:e050af4a9e72 |
---|---|
1 \input texinfo | 1 \input texinfo |
2 | |
3 @c %**start of header | 2 @c %**start of header |
4 @setfilename ../info/org | 3 @setfilename ../info/org |
5 @settitle Org Mode Manual | 4 @settitle Org Mode Manual |
6 | 5 |
7 @set VERSION 4.36 | 6 @set VERSION 4.37 |
8 @set DATE June 2006 | 7 @set DATE June 2006 |
9 | 8 |
10 @dircategory Emacs | 9 @dircategory Emacs |
11 @direntry | 10 @direntry |
12 * Org Mode: (org). outline-based notes management and organizer | 11 * Org Mode: (org). outline-based notes management and organizer |
144 * CamelCase links:: Activating CamelCase words as links | 143 * CamelCase links:: Activating CamelCase words as links |
145 | 144 |
146 TODO items | 145 TODO items |
147 | 146 |
148 * TODO basics:: Marking and displaying TODO entries | 147 * TODO basics:: Marking and displaying TODO entries |
149 * Progress logging:: Document your productivity | |
150 * TODO extensions:: Workflow and assignments | 148 * TODO extensions:: Workflow and assignments |
151 * Priorities:: Some things are more important than others | 149 * Priorities:: Some things are more important than others |
152 | 150 |
153 Extended use of TODO keywords | 151 Extended use of TODO keywords |
154 | 152 |
158 | 156 |
159 Timestamps | 157 Timestamps |
160 | 158 |
161 * Time stamps:: Assigning a time to a tree entry | 159 * Time stamps:: Assigning a time to a tree entry |
162 * Creating timestamps:: Commands which insert timestamps | 160 * Creating timestamps:: Commands which insert timestamps |
161 * Progress logging:: Documenting when what work was done. | |
162 | |
163 Progress Logging | |
164 | |
165 * Closing items:: When was this entry makred DONE? | |
166 * Clocking work time:: When exactly did you work on this item? | |
163 | 167 |
164 Tags | 168 Tags |
165 | 169 |
166 * Tag inheritance:: Tags use the tree structure of the outline | 170 * Tag inheritance:: Tags use the tree structure of the outline |
167 * Setting tags:: How to assign tags to a headline | 171 * Setting tags:: How to assign tags to a headline |
1919 your file. Org-mode provides methods to give you an overview over all | 1923 your file. Org-mode provides methods to give you an overview over all |
1920 things you have to do. | 1924 things you have to do. |
1921 | 1925 |
1922 @menu | 1926 @menu |
1923 * TODO basics:: Marking and displaying TODO entries | 1927 * TODO basics:: Marking and displaying TODO entries |
1924 * Progress logging:: Document your productivity | |
1925 * TODO extensions:: Workflow and assignments | 1928 * TODO extensions:: Workflow and assignments |
1926 * Priorities:: Some things are more important than others | 1929 * Priorities:: Some things are more important than others |
1927 @end menu | 1930 @end menu |
1928 | 1931 |
1929 @node TODO basics, Progress logging, TODO items, TODO items | 1932 @node TODO basics, TODO extensions, TODO items, TODO items |
1930 @section Basic TODO functionality | 1933 @section Basic TODO functionality |
1931 | 1934 |
1932 Any headline can become a TODO item by starting it with the word TODO, | 1935 Any headline can become a TODO item by starting it with the word TODO, |
1933 for example: | 1936 for example: |
1934 | 1937 |
1976 @c @item @code{org-agenda-include-all-todo} | 1979 @c @item @code{org-agenda-include-all-todo} |
1977 @c If you would like to have all your TODO items listed as part of your | 1980 @c If you would like to have all your TODO items listed as part of your |
1978 @c agenda, customize the variable @code{org-agenda-include-all-todo}. | 1981 @c agenda, customize the variable @code{org-agenda-include-all-todo}. |
1979 @end table | 1982 @end table |
1980 | 1983 |
1981 @node Progress logging, TODO extensions, TODO basics, TODO items | 1984 |
1982 @section Progress Logging | 1985 @node TODO extensions, Priorities, TODO basics, TODO items |
1983 @cindex progress logging | |
1984 @cindex logging, of progress | |
1985 If you want to keep track of @emph{when} a certain TODO item was | |
1986 finished, turn on logging with | |
1987 | |
1988 @lisp | |
1989 (setq org-log-done t) | |
1990 @end lisp | |
1991 | |
1992 @noindent | |
1993 Then each time you turn a TODO entry into DONE using either @kbd{C-c | |
1994 C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line | |
1995 @samp{CLOSED: [timestamp]} will be inserted just after the headline. | |
1996 If you turn the entry back into a TODO item again through further | |
1997 state cycling, that line will be removed again. In the timeline | |
1998 (@pxref{Timeline}) and in the agenda (@pxref{Weekly/Daily agenda}), | |
1999 you can then use the @kbd{L} key to display the TODO items closed on | |
2000 each day, giving you an overview of what has been done on a day. | |
2001 | |
2002 @node TODO extensions, Priorities, Progress logging, TODO items | |
2003 @section Extended use of TODO keywords | 1986 @section Extended use of TODO keywords |
2004 @cindex extended TODO keywords | 1987 @cindex extended TODO keywords |
2005 | 1988 |
2006 The default implementation of TODO entries is just two states: TODO and | 1989 The default implementation of TODO entries is just two states: TODO and |
2007 DONE. You can, however, use the TODO feature for more complicated | 1990 DONE. You can, however, use the TODO feature for more complicated |
2164 planning. | 2147 planning. |
2165 | 2148 |
2166 @menu | 2149 @menu |
2167 * Time stamps:: Assigning a time to a tree entry | 2150 * Time stamps:: Assigning a time to a tree entry |
2168 * Creating timestamps:: Commands which insert timestamps | 2151 * Creating timestamps:: Commands which insert timestamps |
2152 * Progress logging:: Documenting when what work was done. | |
2169 @end menu | 2153 @end menu |
2170 | 2154 |
2171 | 2155 |
2172 @node Time stamps, Creating timestamps, Timestamps, Timestamps | 2156 @node Time stamps, Creating timestamps, Timestamps, Timestamps |
2173 @section Time stamps, deadlines and scheduling | 2157 @section Time stamps, deadlines and scheduling |
2237 @cindex CLOSED keyword | 2221 @cindex CLOSED keyword |
2238 When @code{org-log-done} is non-nil, Org-mode will automatically insert | 2222 When @code{org-log-done} is non-nil, Org-mode will automatically insert |
2239 a special time stamp each time a TODO entry is marked done | 2223 a special time stamp each time a TODO entry is marked done |
2240 (@pxref{Progress logging}). This time stamp is enclosed in square | 2224 (@pxref{Progress logging}). This time stamp is enclosed in square |
2241 brackets instead of angular brackets. | 2225 brackets instead of angular brackets. |
2226 | |
2227 @item Time range with CLOCK keyword | |
2228 @cindex CLOCK keyword | |
2229 When using the clock to time the work that is being done on specific | |
2230 items, time ranges preceeded by the CLOCK keyword are inserted | |
2231 automatically into the file. The time stamps are enclosed in square | |
2232 brackets instead of angular brackets. @xref{Clocking work time}. | |
2233 @c FIXME: Reference needed | |
2242 @end table | 2234 @end table |
2243 | 2235 |
2244 @node Creating timestamps, , Time stamps, Timestamps | 2236 @node Creating timestamps, Progress logging, Time stamps, Timestamps |
2245 @section Creating timestamps | 2237 @section Creating timestamps |
2246 @cindex creating timestamps | 2238 @cindex creating timestamps |
2247 @cindex timestamps, creating | 2239 @cindex timestamps, creating |
2248 | 2240 |
2249 For Org-mode to recognize time stamps, they need to be in the specific | 2241 For Org-mode to recognize time stamps, they need to be in the specific |
2371 @kindex @key{RET} | 2363 @kindex @key{RET} |
2372 @item @key{RET} | 2364 @item @key{RET} |
2373 Choose date in calendar (only if nothing typed into minibuffer). | 2365 Choose date in calendar (only if nothing typed into minibuffer). |
2374 @end table | 2366 @end table |
2375 | 2367 |
2368 @node Progress logging, , Creating timestamps, Timestamps | |
2369 @section Progress Logging | |
2370 @cindex progress logging | |
2371 @cindex logging, of progress | |
2372 | |
2373 Org-mode can automatically record a time stamp when you mark a TODO item | |
2374 as DONE. You can also measure precisely the time you spent on specific | |
2375 items in a project by starting and stopping a clock when you start and | |
2376 stop working on an aspect of a project. | |
2377 | |
2378 @menu | |
2379 * Closing items:: When was this entry makred DONE? | |
2380 * Clocking work time:: When exactly did you work on this item? | |
2381 @end menu | |
2382 | |
2383 @node Closing items, Clocking work time, Progress logging, Progress logging | |
2384 @subsection Closing items | |
2385 | |
2386 If you want to keep track of @emph{when} a certain TODO item was | |
2387 finished, turn on logging with | |
2388 | |
2389 @lisp | |
2390 (setq org-log-done t) | |
2391 @end lisp | |
2392 | |
2393 @noindent | |
2394 Then each time you turn a TODO entry into DONE using either @kbd{C-c | |
2395 C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line | |
2396 @samp{CLOSED: [timestamp]} will be inserted just after the headline. | |
2397 If you turn the entry back into a TODO item again through further | |
2398 state cycling, that line will be removed again. In the timeline | |
2399 (@pxref{Timeline}) and in the agenda (@pxref{Weekly/Daily agenda}), | |
2400 you can then use the @kbd{l} key to display the TODO items closed on | |
2401 each day, giving you an overview of what has been done on a day. | |
2402 | |
2403 @node Clocking work time, , Closing items, Progress logging | |
2404 @subsection Clocking work time | |
2405 | |
2406 Org-mode allows you to clock the time you spent on specific tasks in a | |
2407 project. When you start working on an item, you can start the clock. | |
2408 When you stop working on that tast, or when you makr the task done, the | |
2409 clock is stoppend and the corresponding time interval is recorded. It | |
2410 also computes the total time spent on each subtree of a project. | |
2411 | |
2412 @table @kbd | |
2413 @kindex C-c C-x C-i | |
2414 @item C-c C-x C-i | |
2415 Start the clock on the current item (clock-in). This inserts the CLOCK | |
2416 keyword together with a timestamp. | |
2417 @kindex C-c C-x C-o | |
2418 @item C-c C-x C-o | |
2419 Stop the clock (clock-out). The inserts another timestamp at the same | |
2420 location where the clock was last started. It also directly computes | |
2421 the resulting time in inserts it after the time range as @samp{=> | |
2422 HH:MM}. | |
2423 @kindex C-c C-t | |
2424 @item C-c C-t | |
2425 Changing the TODO state of an item to DONE automatically stops the clock | |
2426 if it is running in this same item. | |
2427 @kindex C-c C-x C-x | |
2428 @item C-c C-x C-x | |
2429 Cancel the current clock. This is useful if a clock was started by | |
2430 mistake, or if you ended up working on something else. | |
2431 @kindex C-c C-x C-d | |
2432 @item C-c C-x C-d | |
2433 Display time summaries for each subtree in the current buffer. This | |
2434 puts overlays at the end of each headline, showing the total time | |
2435 recorded under that heading, including the time of any subheadings. You | |
2436 can use visibility cycling to study the tree, but the overlays disappear | |
2437 automatically when the buffer is changed. | |
2438 @end table | |
2439 | |
2440 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in | |
2441 the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been | |
2442 worked on or closed during a day. | |
2443 | |
2376 @node Tags, Agenda views, Timestamps, Top | 2444 @node Tags, Agenda views, Timestamps, Top |
2377 @chapter Tags | 2445 @chapter Tags |
2378 @cindex tags | 2446 @cindex tags |
2379 @cindex headline tagging | 2447 @cindex headline tagging |
2380 @cindex matching, tags | 2448 @cindex matching, tags |
2956 @code{org-agenda-start-with-follow-mode}. | 3024 @code{org-agenda-start-with-follow-mode}. |
2957 | 3025 |
2958 @kindex l | 3026 @kindex l |
2959 @item l | 3027 @item l |
2960 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while | 3028 Toggle Logbook mode. In Logbook mode, entries that where marked DONE while |
2961 logging was on (variable @code{org-log-done}) are shown in the agenda. | 3029 logging was on (variable @code{org-log-done}) are shown in the agenda, |
3030 as are entries that have been clocked on that day. | |
2962 | 3031 |
2963 @tsubheading{Change display} | 3032 @tsubheading{Change display} |
2964 @kindex o | 3033 @kindex o |
2965 @item o | 3034 @item o |
2966 Delete other windows. | 3035 Delete other windows. |
3073 @item > | 3142 @item > |
3074 Change the time stamp associated with the current line to today. | 3143 Change the time stamp associated with the current line to today. |
3075 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} | 3144 The key @kbd{>} has been chosen, because it is the same as @kbd{S-.} |
3076 on my keyboard. | 3145 on my keyboard. |
3077 | 3146 |
3147 @kindex I | |
3148 @item I | |
3149 Start the clock on the current item. If a clock is running already, it | |
3150 is stopped first. | |
3151 @kindex O | |
3152 @item O | |
3153 Stop the previously started clock. | |
3154 @kindex X | |
3155 @item X | |
3156 Cancel the currently running clock. | |
3157 | |
3158 @tsubheading{Calendar commands} | |
3159 @kindex c | |
3160 @item c | |
3161 Open the Emacs calendar and move to the date at the agenda cursor. | |
3162 | |
3163 @item c | |
3164 When in the calendar, compute and show the Org-mode agenda for the | |
3165 date at the cursor. | |
3166 | |
3078 @cindex diary entries, creating from agenda | 3167 @cindex diary entries, creating from agenda |
3079 @kindex i | 3168 @kindex i |
3080 @item i | 3169 @item i |
3081 Insert a new entry into the diary. Prompts for the type of entry | 3170 Insert a new entry into the diary. Prompts for the type of entry |
3082 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new | 3171 (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new |
3083 entry in the diary, just as @kbd{i d} etc. would do in the calendar. | 3172 entry in the diary, just as @kbd{i d} etc. would do in the calendar. |
3084 The date is taken from the cursor position. | 3173 The date is taken from the cursor position. |
3085 | |
3086 @tsubheading{Calendar commands} | |
3087 @kindex c | |
3088 @item c | |
3089 Open the Emacs calendar and move to the date at the agenda cursor. | |
3090 | |
3091 @item c | |
3092 When in the calendar, compute and show the Org-mode agenda for the | |
3093 date at the cursor. | |
3094 | 3174 |
3095 @kindex M | 3175 @kindex M |
3096 @item M | 3176 @item M |
3097 Show the phases of the moon for the three months around current date. | 3177 Show the phases of the moon for the three months around current date. |
3098 | 3178 |