Mercurial > emacs
comparison man/org.texi @ 90159:08185296b491
Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-44
Merge from emacs--cvs-trunk--0
Patches applied:
* emacs--cvs-trunk--0 (patch 272-288)
- src/xdisp.c (dump_glyph_row): Don't display overlay_arrow_p field.
- Update from CVS
- Merge from gnus--rel--5.10
* gnus--rel--5.10 (patch 67)
- Update from CVS
author | Miles Bader <miles@gnu.org> |
---|---|
date | Thu, 05 May 2005 00:04:55 +0000 |
parents | 88492f3ccffa |
children | 55227ff1f8d5 |
comparison
equal
deleted
inserted
replaced
90158:bf4846baba9a | 90159:08185296b491 |
---|---|
1 \input texinfo | 1 \input texinfo |
2 @c %**start of header | 2 @c %**start of header |
3 @c @setfilename org | |
3 @setfilename ../info/org | 4 @setfilename ../info/org |
4 @settitle Org Mode Manual | 5 @settitle Org Mode Manual |
5 | 6 |
6 @set VERSION 3.06 | 7 @set VERSION 3.08 |
7 @set DATE April 2005 | 8 @set DATE April 2005 |
8 | 9 |
9 @dircategory Emacs | 10 @dircategory Emacs |
10 @direntry | 11 @direntry |
11 * Org Mode: (org). Outline-based notes management and organizer | 12 * Org Mode: (org). Outline-based notes management and organizer |
74 @end ifnottex | 75 @end ifnottex |
75 | 76 |
76 @menu | 77 @menu |
77 * Introduction:: Getting started | 78 * Introduction:: Getting started |
78 * Document Structure:: A tree works like your brain | 79 * Document Structure:: A tree works like your brain |
79 * TODO items:: Every tree branch can be a TODO item | |
80 * Tables:: Pure magic for quick formatting | 80 * Tables:: Pure magic for quick formatting |
81 * Hyperlinks:: Notes in context | 81 * Hyperlinks:: Notes in context |
82 * TODO items:: Every tree branch can be a TODO item | |
82 * Timestamps:: Assign date and time to items | 83 * Timestamps:: Assign date and time to items |
83 * Timeline and Agenda:: Use time-stamped items to produce an agenda | 84 * Timeline and Agenda:: Use time-stamped items to produce an agenda |
84 * Exporting:: Sharing and publishing of notes | 85 * Exporting:: Sharing and publishing of notes |
85 * Miscellaneous:: All the rest which did not fit elsewhere | 86 * Miscellaneous:: All the rest which did not fit elsewhere |
86 * Index:: The fast road to specific information | 87 * Index:: The fast road to specific information |
91 | 92 |
92 Introduction | 93 Introduction |
93 | 94 |
94 * Summary:: Brief summary of what Org-mode does | 95 * Summary:: Brief summary of what Org-mode does |
95 * Installation and Activation:: How to install Org-mode | 96 * Installation and Activation:: How to install Org-mode |
97 * Feedback:: Bug reportes, ideas, patches etc. | |
96 | 98 |
97 Document Structure | 99 Document Structure |
98 | 100 |
99 * Outlines:: Org-mode is based on outline-mode | 101 * Outlines:: Org-mode is based on outline-mode |
100 * Headlines:: How to typeset org-tree headlines | 102 * Headlines:: How to typeset org-tree headlines |
101 * Visibility cycling:: Show ad hide, much simplified | 103 * Visibility cycling:: Show ad hide, much simplified |
102 * Motion:: Jumping to other headlines | 104 * Motion:: Jumping to other headlines |
103 * Structure editing:: Changing sequence and level of headlines | 105 * Structure editing:: Changing sequence and level of headlines |
104 * Sparse trees:: Matches embedded in context | 106 * Sparse trees:: Matches embedded in context |
105 | 107 |
108 Tables | |
109 | |
110 * Built-in table editor:: Simple tables | |
111 * table.el:: Complex tables | |
112 * orgtbl-mode:: The table editor as minor mode | |
113 | |
114 Hyperlinks | |
115 | |
116 * Links:: URL-like links to the world | |
117 * Remember:: Org-trees store quick notes | |
118 | |
106 TODO items | 119 TODO items |
107 | 120 |
108 * TODO basics:: Marking and displaying TODO entries | 121 * TODO basics:: Marking and displaying TODO entries |
109 * TODO extensions:: Workflow and assignments | 122 * TODO extensions:: Workflow and assignments |
110 * Priorities:: Some things are more important than others | 123 * Priorities:: Some things are more important than others |
112 Extended use of TODO keywords | 125 Extended use of TODO keywords |
113 | 126 |
114 * Workflow states:: From TODO to DONE in steps | 127 * Workflow states:: From TODO to DONE in steps |
115 * TODO types:: I do this, Fred the rest | 128 * TODO types:: I do this, Fred the rest |
116 * Per file keywords:: Different files, different requirements | 129 * Per file keywords:: Different files, different requirements |
117 | |
118 Tables | |
119 | |
120 * Built-in table editor:: Simple tables | |
121 * table.el:: Complex tables | |
122 * orgtbl-mode:: The table editor as minor mode | |
123 | |
124 Hyperlinks | |
125 | |
126 * Links:: URL-like links to the world | |
127 * Remember:: Org-trees store quick notes | |
128 | 130 |
129 Timestamps | 131 Timestamps |
130 | 132 |
131 * Time stamps:: Assigning a time to a tree entry | 133 * Time stamps:: Assigning a time to a tree entry |
132 * Creating timestamps:: Commands which insert timestamps | 134 * Creating timestamps:: Commands which insert timestamps |
167 @cindex introduction | 169 @cindex introduction |
168 | 170 |
169 @menu | 171 @menu |
170 * Summary:: Brief summary of what Org-mode does | 172 * Summary:: Brief summary of what Org-mode does |
171 * Installation and Activation:: How to install Org-mode | 173 * Installation and Activation:: How to install Org-mode |
174 * Feedback:: Bug reportes, ideas, patches etc. | |
172 @end menu | 175 @end menu |
173 | 176 |
174 @node Summary, Installation and Activation, Introduction, Introduction | 177 @node Summary, Installation and Activation, Introduction, Introduction |
175 @section Summary | 178 @section Summary |
176 @cindex summary | 179 @cindex summary |
212 and example files. This page is located at | 215 and example files. This page is located at |
213 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. | 216 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
214 | 217 |
215 @page | 218 @page |
216 | 219 |
217 @node Installation and Activation, , Summary, Introduction | 220 @node Installation and Activation, Feedback, Summary, Introduction |
218 @section Installation and Activation | 221 @section Installation and Activation |
219 @cindex installation | 222 @cindex installation |
220 @cindex autoload | 223 @cindex autoload |
221 @cindex global keybindings | 224 @cindex global keybindings |
222 @cindex keybindings, global | 225 @cindex keybindings, global |
261 | 264 |
262 @noindent which will select Org-mode for this buffer no matter what | 265 @noindent which will select Org-mode for this buffer no matter what |
263 the file's name is. See also the variable | 266 the file's name is. See also the variable |
264 @code{org-insert-mode-line-in-empty-file'}. | 267 @code{org-insert-mode-line-in-empty-file'}. |
265 | 268 |
266 @node Document Structure, TODO items, Introduction, Top | 269 @node Feedback, , Installation and Activation, Introduction |
270 @section Feedback | |
271 @cindex feedback | |
272 @cindex bug reports | |
273 @cindex maintainer | |
274 @cindex author | |
275 | |
276 If you find problems with Org-mode, or if you have questions, remarks, | |
277 or ideas about it, please contact the maintainer Carsten Dominik at | |
278 @value{MAINTAINEREMAIL}. | |
279 | |
280 For bug reports, please provide as much information as possible, | |
281 including the version information of Emacs (@kbd{C-h v emacs-version | |
282 @key{RET}}) and Org-mode (@kbd{M-x org-version}), as well as the | |
283 Org-mode related setup in @file{.emacs}. If an error occurs, a | |
284 traceback can be very useful. Often a small example file helps, along | |
285 with clear information about: | |
286 @enumerate | |
287 @item What exactly did you do? | |
288 @item What did you expect to happen? | |
289 @item What happened instead? | |
290 @end enumerate | |
291 @noindent Thanks for helping to improve this mode. | |
292 | |
293 | |
294 @node Document Structure, Tables, Introduction, Top | |
267 @chapter Document Structure | 295 @chapter Document Structure |
268 @cindex document structure | 296 @cindex document structure |
269 @cindex structure of document | 297 @cindex structure of document |
270 | 298 |
271 Org-mode is based on outline mode and provides flexible commands to | 299 Org-mode is based on outline mode and provides flexible commands to |
501 XEmacs uses selective display for outlining, not text properties}. | 529 XEmacs uses selective display for outlining, not text properties}. |
502 Or you can use the command @kbd{C-c C-x v} to copy the visible part of | 530 Or you can use the command @kbd{C-c C-x v} to copy the visible part of |
503 the document to another file (extension @file{.txt}) which then can be | 531 the document to another file (extension @file{.txt}) which then can be |
504 printed in any desired way. | 532 printed in any desired way. |
505 | 533 |
506 @node TODO items, Tables, Document Structure, Top | 534 @node Tables, Hyperlinks, Document Structure, Top |
507 @chapter TODO items | |
508 @cindex TODO items | |
509 | |
510 Org-mode does not maintain TODO lists as a separate document. TODO | |
511 items are an integral part of the notes file, because TODO items | |
512 usually come up while taking notes! With Org-mode, you simply mark | |
513 any entry in a tree as being a TODO item. In this way, the | |
514 information is not duplicated, and the entire context from which the | |
515 item emerged is always present when you check. | |
516 | |
517 Of course, this technique causes TODO items to be scattered throughout | |
518 your file. Org-mode provides methods to give you an overview over all | |
519 things you have to do. | |
520 | |
521 @menu | |
522 * TODO basics:: Marking and displaying TODO entries | |
523 * TODO extensions:: Workflow and assignments | |
524 * Priorities:: Some things are more important than others | |
525 @end menu | |
526 | |
527 @node TODO basics, TODO extensions, TODO items, TODO items | |
528 @section Basic TODO functionality | |
529 | |
530 Any headline can become a TODO item by starting it with the word TODO, | |
531 for example | |
532 | |
533 @example | |
534 *** TODO Write letter to Sam Fortune | |
535 @end example | |
536 | |
537 @noindent | |
538 The most important commands to work with TODO entries are: | |
539 | |
540 @table @kbd | |
541 @kindex C-c C-t | |
542 @item C-c C-t | |
543 Rotate the TODO state of the current item between | |
544 @example | |
545 ,-> (unmarked) -> TODO -> DONE --. | |
546 '--------------------------------' | |
547 @end example | |
548 The same rotation can also be done ``remotely'' from the timeline and | |
549 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). | |
550 @kindex C-c C-v | |
551 @cindex sparse tree, for TODO | |
552 @item C-c C-v | |
553 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds | |
554 the entire buffer, but shows all TODO items and the headings hierarchy | |
555 above them. With prefix arg, show also the DONE entries. | |
556 @item C-u C-c a | |
557 A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) | |
558 collects all unfinished TODO items into a single place. | |
559 @end table | |
560 | |
561 @node TODO extensions, Priorities, TODO basics, TODO items | |
562 @section Extended use of TODO keywords | |
563 @cindex extended TODO keywords | |
564 | |
565 The default implementation of TODO entries is just two states: TODO | |
566 and DONE. You can, however, use the TODO feature for more | |
567 complicated things by configuring the variables | |
568 @code{org-todo-keywords} and @code{org-todo-interpretation}. Using | |
569 special setup, you can even use TODO keywords in different ways in | |
570 different org files. | |
571 | |
572 @menu | |
573 * Workflow states:: From TODO to DONE in steps | |
574 * TODO types:: I do this, Fred the rest | |
575 * Per file keywords:: Different files, different requirements | |
576 @end menu | |
577 | |
578 @node Workflow states, TODO types, TODO extensions, TODO extensions | |
579 @subsection TODO keywords as workflow states | |
580 @cindex TODO workflow | |
581 @cindex workflow states as TODO keywords | |
582 | |
583 You can use TODO keywords to indicate different states in the process | |
584 of working on an item, for example | |
585 | |
586 @lisp | |
587 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") | |
588 org-todo-interpretation 'sequence) | |
589 @end lisp | |
590 | |
591 With this setup, the command @kbd{C-c C-t} will cycle an entry from | |
592 TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also | |
593 use a prefix argument to quickly select a specific state. For example | |
594 @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. | |
595 If you define many keywords, you can use in-buffer completion (see | |
596 @ref{Completion}) to insert these words into the buffer. | |
597 | |
598 @node TODO types, Per file keywords, Workflow states, TODO extensions | |
599 @subsection TODO keywords as types | |
600 @cindex TODO types | |
601 @cindex names as TODO keywords | |
602 @cindex types as TODO keywords | |
603 | |
604 The second possibility is to use TODO keywords to indicate different | |
605 types of action items. For example, you might want to indicate that | |
606 items are for ``work'' or ``home''. Or, when you work with several | |
607 people on a single project, you might want to assign action items | |
608 directly to persons, by using their names as TODO keywords. This | |
609 would be set up like this: | |
610 | |
611 @lisp | |
612 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") | |
613 org-todo-interpretation 'type) | |
614 @end lisp | |
615 | |
616 In this case, different keywords do not indicate a sequence, but | |
617 rather different types. So it is normally not useful to change from | |
618 one type to another. Therefore, in this case the the behavior of the | |
619 command @kbd{C-c C-t} is changed slightly@footnote{This is also true | |
620 for the @kbd{t} command in the timeline and agenda buffers}. When | |
621 used several times in succession, it will still cycle through all | |
622 names. But when when you return to the item after some time and | |
623 execute @kbd{C-c C-t} again, it will switch from each name directly to | |
624 DONE. Use prefix arguments or completion to quickly select a specific | |
625 name. | |
626 | |
627 @node Per file keywords, , TODO types, TODO extensions | |
628 @subsection Setting up TODO keywords for individual files | |
629 @cindex keyword options | |
630 @cindex per file keywords | |
631 | |
632 It can be very useful to use different aspects of the TODO mechanism | |
633 in different files, which is not possible with the global settings | |
634 described above. For file-local settings, you need to add special | |
635 lines to the file which set the keywords and interpretation for that | |
636 file only. For example, to set one of the two examples discussed | |
637 above, you need one of the following lines, starting in column zero | |
638 anywhere in the file: | |
639 | |
640 @example | |
641 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE | |
642 #+TYP_TODO: Fred Sara Lucy Mike DONE | |
643 @end example | |
644 | |
645 @cindex Completing option keywords | |
646 @kindex M-@key{TAB} | |
647 @noindent To make sure you are using the correct keyword, type | |
648 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
649 | |
650 @cindex DONE, final TODO keyword | |
651 Remember that the last keyword must always mean that the item is DONE | |
652 (you may use a different word, though). Also note that in each file, | |
653 only one of the two aspects of TODO keywords can be used. After | |
654 changing one of these lines, use @kbd{C-c C-c} with the cursor still | |
655 in the line to make the changes known to Org-mode@footnote{Org-mode | |
656 parses these lines only when Org-mode is activated after visiting a | |
657 file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-} | |
658 is simply restarting Org-mode, making sure that these changes will be | |
659 respected.}. | |
660 | |
661 If you want to use very many keywords, for example when working with a | |
662 large group of people, you may split the names over several lines: | |
663 | |
664 @example | |
665 #+TYP_TODO: Fred Sara Lucy Mike | |
666 #+TYP_TODO: Luis George Jules Jessica | |
667 #+TYP_TODO: Kim Arnold Peter | |
668 #+TYP_TODO: DONE | |
669 @end example | |
670 | |
671 @node Priorities, , TODO extensions, TODO items | |
672 @section Priorities | |
673 @cindex priorities | |
674 | |
675 If you use Org-mode extensively to organize your work, you may end up | |
676 with a number of TODO entries so large that you'd like to prioritize | |
677 them. This can be done by placing a @emph{priority cookie} into the | |
678 headline, like this | |
679 | |
680 @example | |
681 *** TODO [#A] Write letter to Sam Fortune | |
682 @end example | |
683 | |
684 @noindent | |
685 With its standard setup, Org-mode supports priorities @samp{A}, | |
686 @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry | |
687 without a cookie is treated as priority @samp{B}. Priorities make a | |
688 difference only in the agenda (@pxref{Agenda}). | |
689 | |
690 @table @kbd | |
691 @kindex @kbd{C-c ,} | |
692 @item @kbd{C-c ,} | |
693 Set the priority of the current item. The command prompts for a | |
694 priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
695 @key{SPC} instead, the priority cookie is removed from the headline. | |
696 The priorities can also be changed ``remotely'' from the timeline and | |
697 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
698 | |
699 @kindex S-@key{up} | |
700 @kindex S-@key{down} | |
701 @item S-@key{up} | |
702 @itemx S-@key{down} | |
703 Increase/decrease priority of current item. Note that these keys are | |
704 also used to modify time stamps (@pxref{Creating timestamps}). | |
705 @end table | |
706 | |
707 | |
708 @node Tables, Hyperlinks, TODO items, Top | |
709 @chapter Tables | 535 @chapter Tables |
710 @cindex tables | 536 @cindex tables |
711 | 537 |
712 For taking notes, tables are an essential tool because they allow | 538 For taking notes, tables are an essential tool because they allow |
713 immediate and clear structuring of data. Org-mode has a very fast and | 539 immediate and clear structuring of data. Org-mode has a very fast and |
949 @cindex orgtbl-mode | 775 @cindex orgtbl-mode |
950 @cindex Minor mode for tables | 776 @cindex Minor mode for tables |
951 | 777 |
952 If you like the intuitive way the Org-mode table editor works, you | 778 If you like the intuitive way the Org-mode table editor works, you |
953 might want to use it also in other modes like text-mode or mail-mode. | 779 might want to use it also in other modes like text-mode or mail-mode. |
954 The minor mode Orgtbl-mode make this possible. You can always toggle | 780 The minor mode Orgtbl-mode makes this possible. You can always toggle |
955 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for | 781 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for |
956 example in mail mode, use | 782 example in mail mode, use |
957 @lisp | 783 @lisp |
958 (add-hook 'mail-mode-hook 'turn-on-orgtbl) | 784 (add-hook 'mail-mode-hook 'turn-on-orgtbl) |
959 @end lisp | 785 @end lisp |
960 | 786 |
961 @node Hyperlinks, Timestamps, Tables, Top | 787 @node Hyperlinks, TODO items, Tables, Top |
962 @chapter Hyperlinks | 788 @chapter Hyperlinks |
963 @cindex hyperlinks | 789 @cindex hyperlinks |
964 | 790 |
965 Just like HMTL, Org-mode provides links to other files, usenet | 791 Just like HMTL, Org-mode provides links to other files, usenet |
966 articles, emails and much more. | 792 articles, emails and much more. |
1004 bbdb:Richard Stallman @r{BBDB link} | 830 bbdb:Richard Stallman @r{BBDB link} |
1005 shell:ls *.org @r{A shell command} | 831 shell:ls *.org @r{A shell command} |
1006 @end example | 832 @end example |
1007 | 833 |
1008 A link may contain space characters and is terminated by the end of | 834 A link may contain space characters and is terminated by the end of |
1009 the line. Therefore, there can be only one link per line (but see the | 835 the line or, in tables, by the end of the table field. Therefore, |
836 outside of tables there can be only one link per line (but see the | |
1010 variable @code{org-allow-space-in-links}). | 837 variable @code{org-allow-space-in-links}). |
1011 | 838 |
1012 @cindex storing links | 839 @cindex storing links |
1013 @table @kbd | 840 @table @kbd |
1014 @kindex C-c l | 841 @kindex C-c l |
1113 If not, a headline is constructed from the current date and some | 940 If not, a headline is constructed from the current date and some |
1114 additional data. If the variable @code{org-adapt-indentation} is | 941 additional data. If the variable @code{org-adapt-indentation} is |
1115 non-nil, the entire text is also indented so that it starts in the | 942 non-nil, the entire text is also indented so that it starts in the |
1116 same column as the headline (after the asterisks). | 943 same column as the headline (after the asterisks). |
1117 | 944 |
1118 @node Timestamps, Timeline and Agenda, Hyperlinks, Top | 945 @node TODO items, Timestamps, Hyperlinks, Top |
946 @chapter TODO items | |
947 @cindex TODO items | |
948 | |
949 Org-mode does not maintain TODO lists as a separate document. TODO | |
950 items are an integral part of the notes file, because TODO items | |
951 usually come up while taking notes! With Org-mode, you simply mark | |
952 any entry in a tree as being a TODO item. In this way, the | |
953 information is not duplicated, and the entire context from which the | |
954 item emerged is always present when you check. | |
955 | |
956 Of course, this technique causes TODO items to be scattered throughout | |
957 your file. Org-mode provides methods to give you an overview over all | |
958 things you have to do. | |
959 | |
960 @menu | |
961 * TODO basics:: Marking and displaying TODO entries | |
962 * TODO extensions:: Workflow and assignments | |
963 * Priorities:: Some things are more important than others | |
964 @end menu | |
965 | |
966 @node TODO basics, TODO extensions, TODO items, TODO items | |
967 @section Basic TODO functionality | |
968 | |
969 Any headline can become a TODO item by starting it with the word TODO, | |
970 for example | |
971 | |
972 @example | |
973 *** TODO Write letter to Sam Fortune | |
974 @end example | |
975 | |
976 @noindent | |
977 The most important commands to work with TODO entries are: | |
978 | |
979 @table @kbd | |
980 @kindex C-c C-t | |
981 @item C-c C-t | |
982 Rotate the TODO state of the current item between | |
983 @example | |
984 ,-> (unmarked) -> TODO -> DONE --. | |
985 '--------------------------------' | |
986 @end example | |
987 The same rotation can also be done ``remotely'' from the timeline and | |
988 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}). | |
989 @kindex C-c C-v | |
990 @cindex sparse tree, for TODO | |
991 @item C-c C-v | |
992 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds | |
993 the entire buffer, but shows all TODO items and the headings hierarchy | |
994 above them. With prefix arg, show also the DONE entries. | |
995 @item C-u C-c a | |
996 A @kbd{C-u} argument to the @code{org-agenda command} (@pxref{Agenda}) | |
997 collects all unfinished TODO items into a single place. | |
998 @end table | |
999 | |
1000 @node TODO extensions, Priorities, TODO basics, TODO items | |
1001 @section Extended use of TODO keywords | |
1002 @cindex extended TODO keywords | |
1003 | |
1004 The default implementation of TODO entries is just two states: TODO | |
1005 and DONE. You can, however, use the TODO feature for more | |
1006 complicated things by configuring the variables | |
1007 @code{org-todo-keywords} and @code{org-todo-interpretation}. Using | |
1008 special setup, you can even use TODO keywords in different ways in | |
1009 different org files. | |
1010 | |
1011 @menu | |
1012 * Workflow states:: From TODO to DONE in steps | |
1013 * TODO types:: I do this, Fred the rest | |
1014 * Per file keywords:: Different files, different requirements | |
1015 @end menu | |
1016 | |
1017 @node Workflow states, TODO types, TODO extensions, TODO extensions | |
1018 @subsection TODO keywords as workflow states | |
1019 @cindex TODO workflow | |
1020 @cindex workflow states as TODO keywords | |
1021 | |
1022 You can use TODO keywords to indicate different states in the process | |
1023 of working on an item, for example | |
1024 | |
1025 @lisp | |
1026 (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE") | |
1027 org-todo-interpretation 'sequence) | |
1028 @end lisp | |
1029 | |
1030 With this setup, the command @kbd{C-c C-t} will cycle an entry from | |
1031 TODO to FEEDBACK, then to VERIFY, and finally too DONE. You may also | |
1032 use a prefix argument to quickly select a specific state. For example | |
1033 @kbd{C-3 C-c C-t} will change the state immediately to VERIFY. | |
1034 If you define many keywords, you can use in-buffer completion (see | |
1035 @ref{Completion}) to insert these words into the buffer. | |
1036 | |
1037 @node TODO types, Per file keywords, Workflow states, TODO extensions | |
1038 @subsection TODO keywords as types | |
1039 @cindex TODO types | |
1040 @cindex names as TODO keywords | |
1041 @cindex types as TODO keywords | |
1042 | |
1043 The second possibility is to use TODO keywords to indicate different | |
1044 types of action items. For example, you might want to indicate that | |
1045 items are for ``work'' or ``home''. Or, when you work with several | |
1046 people on a single project, you might want to assign action items | |
1047 directly to persons, by using their names as TODO keywords. This | |
1048 would be set up like this: | |
1049 | |
1050 @lisp | |
1051 (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") | |
1052 org-todo-interpretation 'type) | |
1053 @end lisp | |
1054 | |
1055 In this case, different keywords do not indicate a sequence, but | |
1056 rather different types. So it is normally not useful to change from | |
1057 one type to another. Therefore, in this case the the behavior of the | |
1058 command @kbd{C-c C-t} is changed slightly@footnote{This is also true | |
1059 for the @kbd{t} command in the timeline and agenda buffers}. When | |
1060 used several times in succession, it will still cycle through all | |
1061 names. But when when you return to the item after some time and | |
1062 execute @kbd{C-c C-t} again, it will switch from each name directly to | |
1063 DONE. Use prefix arguments or completion to quickly select a specific | |
1064 name. | |
1065 | |
1066 @node Per file keywords, , TODO types, TODO extensions | |
1067 @subsection Setting up TODO keywords for individual files | |
1068 @cindex keyword options | |
1069 @cindex per file keywords | |
1070 | |
1071 It can be very useful to use different aspects of the TODO mechanism | |
1072 in different files, which is not possible with the global settings | |
1073 described above. For file-local settings, you need to add special | |
1074 lines to the file which set the keywords and interpretation for that | |
1075 file only. For example, to set one of the two examples discussed | |
1076 above, you need one of the following lines, starting in column zero | |
1077 anywhere in the file: | |
1078 | |
1079 @example | |
1080 #+SEQ_TODO: TODO FEEDBACK VERIFY DONE | |
1081 #+TYP_TODO: Fred Sara Lucy Mike DONE | |
1082 @end example | |
1083 | |
1084 @cindex Completing option keywords | |
1085 @kindex M-@key{TAB} | |
1086 @noindent To make sure you are using the correct keyword, type | |
1087 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | |
1088 | |
1089 @cindex DONE, final TODO keyword | |
1090 Remember that the last keyword must always mean that the item is DONE | |
1091 (you may use a different word, though). Also note that in each file, | |
1092 only one of the two aspects of TODO keywords can be used. After | |
1093 changing one of these lines, use @kbd{C-c C-c} with the cursor still | |
1094 in the line to make the changes known to Org-mode@footnote{Org-mode | |
1095 parses these lines only when Org-mode is activated after visiting a | |
1096 file. @kbd{C-c C-c} with the cursor in a line starting with @samp{#-} | |
1097 is simply restarting Org-mode, making sure that these changes will be | |
1098 respected.}. | |
1099 | |
1100 If you want to use very many keywords, for example when working with a | |
1101 large group of people, you may split the names over several lines: | |
1102 | |
1103 @example | |
1104 #+TYP_TODO: Fred Sara Lucy Mike | |
1105 #+TYP_TODO: Luis George Jules Jessica | |
1106 #+TYP_TODO: Kim Arnold Peter | |
1107 #+TYP_TODO: DONE | |
1108 @end example | |
1109 | |
1110 @node Priorities, , TODO extensions, TODO items | |
1111 @section Priorities | |
1112 @cindex priorities | |
1113 | |
1114 If you use Org-mode extensively to organize your work, you may end up | |
1115 with a number of TODO entries so large that you'd like to prioritize | |
1116 them. This can be done by placing a @emph{priority cookie} into the | |
1117 headline, like this | |
1118 | |
1119 @example | |
1120 *** TODO [#A] Write letter to Sam Fortune | |
1121 @end example | |
1122 | |
1123 @noindent | |
1124 With its standard setup, Org-mode supports priorities @samp{A}, | |
1125 @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry | |
1126 without a cookie is treated as priority @samp{B}. Priorities make a | |
1127 difference only in the agenda (@pxref{Agenda}). | |
1128 | |
1129 @table @kbd | |
1130 @kindex @kbd{C-c ,} | |
1131 @item @kbd{C-c ,} | |
1132 Set the priority of the current item. The command prompts for a | |
1133 priority character @samp{A}, @samp{B} or @samp{C}. When you press | |
1134 @key{SPC} instead, the priority cookie is removed from the headline. | |
1135 The priorities can also be changed ``remotely'' from the timeline and | |
1136 agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | |
1137 | |
1138 @kindex S-@key{up} | |
1139 @kindex S-@key{down} | |
1140 @item S-@key{up} | |
1141 @itemx S-@key{down} | |
1142 Increase/decrease priority of current item. Note that these keys are | |
1143 also used to modify time stamps (@pxref{Creating timestamps}). | |
1144 @end table | |
1145 | |
1146 | |
1147 | |
1148 @node Timestamps, Timeline and Agenda, TODO items, Top | |
1119 @chapter Timestamps | 1149 @chapter Timestamps |
1120 | 1150 |
1121 Items can be labeled with timestamps to make them useful for project | 1151 Items can be labeled with timestamps to make them useful for project |
1122 planning. | 1152 planning. |
1123 | 1153 |
1413 @example | 1443 @example |
1414 #+CATEGORY: Cheops | 1444 #+CATEGORY: Cheops |
1415 @end example | 1445 @end example |
1416 @noindent | 1446 @noindent |
1417 After changing this line, press @kbd{C-c C-c} with the cursor still in | 1447 After changing this line, press @kbd{C-c C-c} with the cursor still in |
1418 the line, to make the changes know to org-mode. Otherwise, the change | 1448 the line, to make the changes known to org-mode. Otherwise, the |
1419 will only be active the next time you visit this file with Emacs. | 1449 change will only be active the next time you visit this file with |
1420 | 1450 Emacs. |
1421 The display in the agenda buffer looks best if the category is no | 1451 |
1452 The display in the agenda buffer looks best if the category is not | |
1422 longer than 10 characters. | 1453 longer than 10 characters. |
1423 | 1454 |
1424 @subsection Sorting of agenda items | 1455 @subsection Sorting of agenda items |
1425 @cindex sorting, of agenda items | 1456 @cindex sorting, of agenda items |
1426 @cindex priorities, of agenda items | 1457 @cindex priorities, of agenda items |
2076 @node Acknowledgments, Bugs, Interaction, Miscellaneous | 2107 @node Acknowledgments, Bugs, Interaction, Miscellaneous |
2077 @section Acknowledgments | 2108 @section Acknowledgments |
2078 @cindex acknowledgments | 2109 @cindex acknowledgments |
2079 | 2110 |
2080 Org-mode was written by Carsten Dominik, who still maintains it at the | 2111 Org-mode was written by Carsten Dominik, who still maintains it at the |
2081 Org-mode homepage | 2112 Org-mode homepage @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. |
2082 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}. The following | 2113 The following people have helped the development along with ideas, |
2083 people have helped the development along with ideas, suggestions and | 2114 suggestions and patches. |
2084 patches. | |
2085 | 2115 |
2086 @itemize @bullet | 2116 @itemize @bullet |
2087 @item | 2117 @item |
2088 Matthias Rempe (Oelde) provided ideas and suggestions, a patch | 2118 Matthias Rempe (Oelde) provided ideas and suggestions, a patch |
2089 introducing Windows NT/2000 support, and quality control. | 2119 introducing Windows NT/2000 support, and quality control. |
2110 @item | 2140 @item |
2111 Oliver Oppitz sent several useful suggestions. | 2141 Oliver Oppitz sent several useful suggestions. |
2112 @item | 2142 @item |
2113 Carsten Wimmer suggested some changes and helped fix a bug in linking | 2143 Carsten Wimmer suggested some changes and helped fix a bug in linking |
2114 to GNUS. | 2144 to GNUS. |
2145 @item | |
2146 Stefan Monnier provided a patch with lots of little fixes to keep the | |
2147 Emacs-Lisp compiler happy. | |
2115 @end itemize | 2148 @end itemize |
2116 | 2149 |
2117 @node Bugs, , Acknowledgments, Miscellaneous | 2150 @node Bugs, , Acknowledgments, Miscellaneous |
2118 @section Bugs | 2151 @section Bugs |
2119 @cindex bugs | 2152 @cindex bugs |
2152 | 2185 |
2153 @printindex ky | 2186 @printindex ky |
2154 | 2187 |
2155 @bye | 2188 @bye |
2156 | 2189 |
2190 | |
2157 @ignore | 2191 @ignore |
2158 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac | 2192 arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac |
2159 @end ignore | 2193 @end ignore |