Mercurial > emacs
comparison doc/misc/org.texi @ 101609:6be1e380a009
2009-01-28 Carsten Dominik <dominik@science.uva.nl>
* org.texi (TODO dependencies): New section.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Wed, 28 Jan 2009 14:33:36 +0000 |
parents | 9ef994c968b4 |
children | 4c26fea2986c |
comparison
equal
deleted
inserted
replaced
101608:49a4ee098b57 | 101609:6be1e380a009 |
---|---|
1 \input texinfo | 1 \input texinfo |
2 @c %**start of header | 2 @c %**start of header |
3 @setfilename ../../info/org | 3 @setfilename ../../info/org |
4 @settitle The Org Manual | 4 @settitle The Org Manual |
5 | 5 |
6 @set VERSION 6.19e | 6 @set VERSION 6.20c |
7 @set DATE January 2009 | 7 @set DATE January 2009 |
8 | 8 |
9 @dircategory Emacs | 9 @dircategory Emacs |
10 @direntry | 10 @direntry |
11 * Org Mode: (org). Outline-based notes management and organizer | 11 * Org Mode: (org). Outline-based notes management and organizer |
179 * TODO types:: I do this, Fred does the rest | 179 * TODO types:: I do this, Fred does the rest |
180 * Multiple sets in one file:: Mixing it all, and still finding your way | 180 * Multiple sets in one file:: Mixing it all, and still finding your way |
181 * Fast access to TODO states:: Single letter selection of a state | 181 * Fast access to TODO states:: Single letter selection of a state |
182 * Per-file keywords:: Different files, different requirements | 182 * Per-file keywords:: Different files, different requirements |
183 * Faces for TODO keywords:: Highlighting states | 183 * Faces for TODO keywords:: Highlighting states |
184 * TODO dependencies:: When one tasks needs to wait for others | |
184 | 185 |
185 Progress logging | 186 Progress logging |
186 | 187 |
187 * Closing items:: When was this entry marked DONE? | 188 * Closing items:: When was this entry marked DONE? |
188 * Tracking TODO state changes:: When did the status change? | 189 * Tracking TODO state changes:: When did the status change? |
3098 * TODO types:: I do this, Fred does the rest | 3099 * TODO types:: I do this, Fred does the rest |
3099 * Multiple sets in one file:: Mixing it all, and still finding your way | 3100 * Multiple sets in one file:: Mixing it all, and still finding your way |
3100 * Fast access to TODO states:: Single letter selection of a state | 3101 * Fast access to TODO states:: Single letter selection of a state |
3101 * Per-file keywords:: Different files, different requirements | 3102 * Per-file keywords:: Different files, different requirements |
3102 * Faces for TODO keywords:: Highlighting states | 3103 * Faces for TODO keywords:: Highlighting states |
3104 * TODO dependencies:: When one tasks needs to wait for others | |
3103 @end menu | 3105 @end menu |
3104 | 3106 |
3105 @node Workflow states, TODO types, TODO extensions, TODO extensions | 3107 @node Workflow states, TODO types, TODO extensions, TODO extensions |
3106 @subsection TODO keywords as workflow states | 3108 @subsection TODO keywords as workflow states |
3107 @cindex TODO workflow | 3109 @cindex TODO workflow |
3280 known to Org mode@footnote{Org mode parses these lines only when | 3282 known to Org mode@footnote{Org mode parses these lines only when |
3281 Org mode is activated after visiting a file. @kbd{C-c C-c} with the | 3283 Org mode is activated after visiting a file. @kbd{C-c C-c} with the |
3282 cursor in a line starting with @samp{#+} is simply restarting Org mode | 3284 cursor in a line starting with @samp{#+} is simply restarting Org mode |
3283 for the current buffer.}. | 3285 for the current buffer.}. |
3284 | 3286 |
3285 @node Faces for TODO keywords, , Per-file keywords, TODO extensions | 3287 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions |
3286 @subsection Faces for TODO keywords | 3288 @subsection Faces for TODO keywords |
3287 @cindex faces, for TODO keywords | 3289 @cindex faces, for TODO keywords |
3288 | 3290 |
3289 Org mode highlights TODO keywords with special faces: @code{org-todo} | 3291 Org mode highlights TODO keywords with special faces: @code{org-todo} |
3290 for keywords indicating that an item still has to be acted upon, and | 3292 for keywords indicating that an item still has to be acted upon, and |
3303 @end lisp | 3305 @end lisp |
3304 | 3306 |
3305 While using a list with face properties as shown for CANCELED | 3307 While using a list with face properties as shown for CANCELED |
3306 @emph{should} work, this does not aways seem to be the case. If | 3308 @emph{should} work, this does not aways seem to be the case. If |
3307 necessary, define a special face and use that. | 3309 necessary, define a special face and use that. |
3310 | |
3311 @node TODO dependencies, , Faces for TODO keywords, TODO extensions | |
3312 @subsection TODO dependencies | |
3313 | |
3314 The structure of Org files (hierarchy and lists) makes it easy to define TODO | |
3315 dependencies. Usually, a parent TODO task should not be marked DONE until | |
3316 all subtasks (defined as children tasks) are marked as DONE. And sometimes | |
3317 there is a logical sequence to a number of (sub)tasks, so that one task | |
3318 cannot be acted upon before all siblings above it are done. If you customize | |
3319 the variable @code{org-enforce-todo-dependencies}, Org will block entries | |
3320 from changing state while they have children that are not DONE. Furthermore, | |
3321 if an entry has a property @code{ORDERED}, each of its children will be | |
3322 blocked until all earlier siblings are marked DONE. Here is an example: | |
3323 | |
3324 @example | |
3325 * TODO Blocked until (two) is done | |
3326 ** DONE one | |
3327 ** TODO two | |
3328 | |
3329 * Parent | |
3330 :PROPERTIES: | |
3331 :ORDERED: t | |
3332 :END: | |
3333 ** TODO a | |
3334 ** TODO b, needs to wait for (a) | |
3335 ** TODO c, needs to wait for (a) and (b) | |
3336 @end example | |
3337 | |
3338 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries | |
3339 that cannot be closed because of such dependencies will be shown in a dimmed | |
3340 font or even made invisible in agenda views (@pxref{Agenda Views}). | |
3341 | |
3342 If you need more complex dependency structures, for example dependencies | |
3343 between entries in different trees or files, check out the contributed | |
3344 module @file{org-depend.el}. | |
3308 | 3345 |
3309 @page | 3346 @page |
3310 @node Progress logging, Priorities, TODO extensions, TODO Items | 3347 @node Progress logging, Priorities, TODO extensions, TODO Items |
3311 @section Progress logging | 3348 @section Progress logging |
3312 @cindex progress logging | 3349 @cindex progress logging |
3562 @item C-c C-c | 3599 @item C-c C-c |
3563 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, | 3600 Toggle checkbox at point. With a prefix argument, set it to @samp{[-]}, |
3564 which is considered to be an intermediate state. | 3601 which is considered to be an intermediate state. |
3565 @kindex C-c C-x C-b | 3602 @kindex C-c C-x C-b |
3566 @item C-c C-x C-b | 3603 @item C-c C-x C-b |
3567 Toggle checkbox at point. | 3604 Toggle checkbox status or (with prefix arg) checkbox presence at point. |
3568 @itemize @minus | 3605 @itemize @minus |
3569 @item | 3606 @item |
3570 If there is an active region, toggle the first checkbox in the region | 3607 If there is an active region, toggle the first checkbox in the region |
3571 and set all remaining boxes to the same status as the first. If you | 3608 and set all remaining boxes to the same status as the first. With a prefix |
3572 want to toggle all boxes in the region independently, use a prefix | 3609 arg, add or remove the checkbox for all items in the region. |
3573 argument. | |
3574 @item | 3610 @item |
3575 If the cursor is in a headline, toggle checkboxes in the region between | 3611 If the cursor is in a headline, toggle checkboxes in the region between |
3576 this headline and the next (so @emph{not} the entire subtree). | 3612 this headline and the next (so @emph{not} the entire subtree). |
3577 @item | 3613 @item |
3578 If there is no active region, just toggle the checkbox at point. | 3614 If there is no active region, just toggle the checkbox at point. |
10250 incorporate project planning functionality directly into a notes file. | 10286 incorporate project planning functionality directly into a notes file. |
10251 | 10287 |
10252 A special thanks goes to @i{Bastien Guerry} who has not only written a large | 10288 A special thanks goes to @i{Bastien Guerry} who has not only written a large |
10253 number of extensions to Org (most of them integrated into the core by now), | 10289 number of extensions to Org (most of them integrated into the core by now), |
10254 but has also helped the development and maintenance of Org so much that he | 10290 but has also helped the development and maintenance of Org so much that he |
10255 should be considered co-author of this package. | 10291 should be considered the main co-contributor to this package. |
10256 | 10292 |
10257 Since the first release, literally thousands of emails to me or on | 10293 Since the first release, literally thousands of emails to me or on |
10258 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug | 10294 @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug |
10259 reports, feedback, new ideas, and sometimes patches and add-on code. | 10295 reports, feedback, new ideas, and sometimes patches and add-on code. |
10260 Many thanks to everyone who has helped to improve this package. I am | 10296 Many thanks to everyone who has helped to improve this package. I am |
10425 @item | 10461 @item |
10426 @i{David Wainberg} suggested archiving, and improvements to the linking | 10462 @i{David Wainberg} suggested archiving, and improvements to the linking |
10427 system. | 10463 system. |
10428 @item | 10464 @item |
10429 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and | 10465 @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and |
10430 @file{muse.el}, which have similar goals as Org. Initially the | 10466 @file{muse.el}, which have some overlap with Org. Initially the development |
10431 development of Org was fully independent because I was not aware of the | 10467 of Org was fully independent because I was not aware of the existence of |
10432 existence of these packages. But with time I have occasionally looked | 10468 these packages. But with time I have occasionally looked at John's code and |
10433 at John's code and learned a lot from it. John has also contributed a | 10469 learned a lot from it. John has also contributed a number of great ideas and |
10434 number of great ideas and patches directly to Org, including the attachment | 10470 patches directly to Org, including the attachment system |
10435 system (@file{org-attach.el}) and integration with Apple Mail | 10471 (@file{org-attach.el}), integration with Apple Mail |
10436 (@file{org-mac-message.el}). | 10472 (@file{org-mac-message.el}), and hierarchical dependencies of TODO items. |
10437 @item | 10473 @item |
10438 @i{Carsten Wimmer} suggested some changes and helped fix a bug in | 10474 @i{Carsten Wimmer} suggested some changes and helped fix a bug in |
10439 linking to Gnus. | 10475 linking to Gnus. |
10440 @item | 10476 @item |
10441 @i{Roland Winkler} requested additional key bindings to make Org | 10477 @i{Roland Winkler} requested additional key bindings to make Org |