diff options
| author | Carsten Dominik | 2005-04-15 06:55:07 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2005-04-15 06:55:07 +0000 |
| commit | 5b69c9caaaad8bf3ab3abc558f24218b9cd25870 (patch) | |
| tree | b8d8890d7d7ee6c3538ec47615073e38c6f97ec8 | |
| parent | a9f07b61abe6f7812328e92ff8baf0ebcf26b556 (diff) | |
| download | emacs-5b69c9caaaad8bf3ab3abc558f24218b9cd25870.tar.gz emacs-5b69c9caaaad8bf3ab3abc558f24218b9cd25870.zip | |
Update to version 3.06
| -rw-r--r-- | man/org.texi | 259 |
1 files changed, 143 insertions, 116 deletions
diff --git a/man/org.texi b/man/org.texi index d1a388f958a..c066a00fd15 100644 --- a/man/org.texi +++ b/man/org.texi | |||
| @@ -3,7 +3,7 @@ | |||
| 3 | @setfilename ../info/org | 3 | @setfilename ../info/org |
| 4 | @settitle Org Mode Manual | 4 | @settitle Org Mode Manual |
| 5 | 5 | ||
| 6 | @set VERSION 3.05 | 6 | @set VERSION 3.06 |
| 7 | @set DATE April 2005 | 7 | @set DATE April 2005 |
| 8 | 8 | ||
| 9 | @dircategory Emacs | 9 | @dircategory Emacs |
| @@ -92,7 +92,7 @@ Software Foundation raise funds for GNU development.'' | |||
| 92 | Introduction | 92 | Introduction |
| 93 | 93 | ||
| 94 | * Summary:: Brief summary of what Org-mode does | 94 | * Summary:: Brief summary of what Org-mode does |
| 95 | * Installation:: How to install Org-mode | 95 | * Installation and Activation:: How to install Org-mode |
| 96 | 96 | ||
| 97 | Document Structure | 97 | Document Structure |
| 98 | 98 | ||
| @@ -106,8 +106,8 @@ Document Structure | |||
| 106 | TODO items | 106 | TODO items |
| 107 | 107 | ||
| 108 | * TODO basics:: Marking and displaying TODO entries | 108 | * TODO basics:: Marking and displaying TODO entries |
| 109 | * Priorities:: Some things are more important than others | ||
| 110 | * TODO extensions:: Workflow and assignments | 109 | * TODO extensions:: Workflow and assignments |
| 110 | * Priorities:: Some things are more important than others | ||
| 111 | 111 | ||
| 112 | Extended use of TODO keywords | 112 | Extended use of TODO keywords |
| 113 | 113 | ||
| @@ -133,8 +133,8 @@ Timestamps | |||
| 133 | 133 | ||
| 134 | Timeline and Agenda | 134 | Timeline and Agenda |
| 135 | 135 | ||
| 136 | * Timeline (single file):: Time-sorted view for single file | 136 | * Timeline:: Time-sorted view for single file |
| 137 | * Agenda (multiple files):: Your weekly planner | 137 | * Agenda:: Your weekly planner |
| 138 | * Agenda commands:: Remote editing of org trees | 138 | * Agenda commands:: Remote editing of org trees |
| 139 | * Calendar/Diary integration:: Integrating Anniversaries and more | 139 | * Calendar/Diary integration:: Integrating Anniversaries and more |
| 140 | 140 | ||
| @@ -168,10 +168,10 @@ Miscellaneous | |||
| 168 | 168 | ||
| 169 | @menu | 169 | @menu |
| 170 | * Summary:: Brief summary of what Org-mode does | 170 | * Summary:: Brief summary of what Org-mode does |
| 171 | * Installation:: How to install Org-mode | 171 | * Installation and Activation:: How to install Org-mode |
| 172 | @end menu | 172 | @end menu |
| 173 | 173 | ||
| 174 | @node Summary, Installation, Introduction, Introduction | 174 | @node Summary, Installation and Activation, Introduction, Introduction |
| 175 | @section Summary | 175 | @section Summary |
| 176 | @cindex summary | 176 | @cindex summary |
| 177 | 177 | ||
| @@ -214,8 +214,8 @@ and example files. This page is located at | |||
| 214 | 214 | ||
| 215 | @page | 215 | @page |
| 216 | 216 | ||
| 217 | @node Installation, , Summary, Introduction | 217 | @node Installation and Activation, , Summary, Introduction |
| 218 | @section Installation | 218 | @section Installation and Activation |
| 219 | @cindex installation | 219 | @cindex installation |
| 220 | @cindex autoload | 220 | @cindex autoload |
| 221 | @cindex global keybindings | 221 | @cindex global keybindings |
| @@ -236,12 +236,15 @@ define @emph{global} keys for the commands @command{org-store-link} | |||
| 236 | and @command{org-agenda} - please choose suitable keys yourself. | 236 | and @command{org-agenda} - please choose suitable keys yourself. |
| 237 | 237 | ||
| 238 | @lisp | 238 | @lisp |
| 239 | ;; These lines only if org-mode is not part of the X/Emacs distribution. | ||
| 239 | (autoload 'org-mode "org" "Org mode" t) | 240 | (autoload 'org-mode "org" "Org mode" t) |
| 240 | (autoload 'org-diary "org" "Diary entries from Org mode") | 241 | (autoload 'org-diary "org" "Diary entries from Org mode") |
| 241 | (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t) | 242 | (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t) |
| 242 | (autoload 'org-store-link "org" "Store a link to the current location" t) | 243 | (autoload 'org-store-link "org" "Store a link to the current location" t) |
| 243 | (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t) | 244 | (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t) |
| 244 | (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode") | 245 | (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode") |
| 246 | |||
| 247 | ;; The following lines are always needed. Choose your own keys. | ||
| 245 | (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) | 248 | (add-to-list 'auto-mode-alist '("\\.org$" . org-mode)) |
| 246 | (define-key global-map "\C-cl" 'org-store-link) | 249 | (define-key global-map "\C-cl" 'org-store-link) |
| 247 | (define-key global-map "\C-ca" 'org-agenda) | 250 | (define-key global-map "\C-ca" 'org-agenda) |
| @@ -257,7 +260,8 @@ MY PROJECTS -*- mode: org; -*- | |||
| 257 | @end example | 260 | @end example |
| 258 | 261 | ||
| 259 | @noindent which will select Org-mode for this buffer no matter what | 262 | @noindent which will select Org-mode for this buffer no matter what |
| 260 | the file's name is. | 263 | the file's name is. See also the variable |
| 264 | @code{org-insert-mode-line-in-empty-file'}. | ||
| 261 | 265 | ||
| 262 | @node Document Structure, TODO items, Introduction, Top | 266 | @node Document Structure, TODO items, Introduction, Top |
| 263 | @chapter Document Structure | 267 | @chapter Document Structure |
| @@ -361,9 +365,9 @@ buffer: | |||
| 361 | @example | 365 | @example |
| 362 | #+STARTUP: fold | 366 | #+STARTUP: fold |
| 363 | #+STARTUP: nofold | 367 | #+STARTUP: nofold |
| 368 | #+STARTUP: content | ||
| 364 | @end example | 369 | @end example |
| 365 | 370 | ||
| 366 | |||
| 367 | @node Motion, Structure editing, Visibility cycling, Document Structure | 371 | @node Motion, Structure editing, Visibility cycling, Document Structure |
| 368 | @section Motion | 372 | @section Motion |
| 369 | @cindex motion, between headlines | 373 | @cindex motion, between headlines |
| @@ -411,6 +415,9 @@ visible. | |||
| 411 | @kindex M-@key{RET} | 415 | @kindex M-@key{RET} |
| 412 | @item M-@key{RET} | 416 | @item M-@key{RET} |
| 413 | Insert new heading with same level as current | 417 | Insert new heading with same level as current |
| 418 | @kindex M-S-@key{RET} | ||
| 419 | @item M-S-@key{RET} | ||
| 420 | Insert new TODO entry with same level as current heading. | ||
| 414 | @kindex M-@key{left} | 421 | @kindex M-@key{left} |
| 415 | @item M-@key{left} | 422 | @item M-@key{left} |
| 416 | Promote current heading by one level | 423 | Promote current heading by one level |
| @@ -437,7 +444,7 @@ Kill subtree, i.e. remove it from buffer but save in kill ring. | |||
| 437 | Copy subtree to kill ring. | 444 | Copy subtree to kill ring. |
| 438 | @kindex C-c C-h C-y | 445 | @kindex C-c C-h C-y |
| 439 | @item C-c C-h C-y | 446 | @item C-c C-h C-y |
| 440 | Yank subtree from kill ring. This does modify the level of subtree to | 447 | Yank subtree from kill ring. This does modify the level of the subtree to |
| 441 | make sure the tree fits in nicely at the yank position. The yank | 448 | make sure the tree fits in nicely at the yank position. The yank |
| 442 | level can also be specified with a prefix arg, or by yanking after a | 449 | level can also be specified with a prefix arg, or by yanking after a |
| 443 | headline marker like @samp{****}. | 450 | headline marker like @samp{****}. |
| @@ -513,11 +520,11 @@ things you have to do. | |||
| 513 | 520 | ||
| 514 | @menu | 521 | @menu |
| 515 | * TODO basics:: Marking and displaying TODO entries | 522 | * TODO basics:: Marking and displaying TODO entries |
| 516 | * Priorities:: Some things are more important than others | ||
| 517 | * TODO extensions:: Workflow and assignments | 523 | * TODO extensions:: Workflow and assignments |
| 524 | * Priorities:: Some things are more important than others | ||
| 518 | @end menu | 525 | @end menu |
| 519 | 526 | ||
| 520 | @node TODO basics, Priorities, TODO items, TODO items | 527 | @node TODO basics, TODO extensions, TODO items, TODO items |
| 521 | @section Basic TODO functionality | 528 | @section Basic TODO functionality |
| 522 | 529 | ||
| 523 | Any headline can become a TODO item by starting it with the word TODO, | 530 | Any headline can become a TODO item by starting it with the word TODO, |
| @@ -538,49 +545,20 @@ Rotate the TODO state of the current item between | |||
| 538 | ,-> (unmarked) -> TODO -> DONE --. | 545 | ,-> (unmarked) -> TODO -> DONE --. |
| 539 | '--------------------------------' | 546 | '--------------------------------' |
| 540 | @end example | 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}). | ||
| 541 | @kindex C-c C-v | 550 | @kindex C-c C-v |
| 542 | @cindex sparse tree, for TODO | 551 | @cindex sparse tree, for TODO |
| 543 | @item C-c C-v | 552 | @item C-c C-v |
| 544 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds | 553 | View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds |
| 545 | the entire buffer, but shows all TODO items and the headings hierarchy | 554 | the entire buffer, but shows all TODO items and the headings hierarchy |
| 546 | above them. With prefix arg, show also the DONE entries. | 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. | ||
| 547 | @end table | 559 | @end table |
| 548 | 560 | ||
| 549 | @node Priorities, TODO extensions, TODO basics, TODO items | 561 | @node TODO extensions, Priorities, TODO basics, TODO items |
| 550 | @section Priorities | ||
| 551 | @cindex priorities | ||
| 552 | |||
| 553 | If you use Org-mode extensively to organize your work, you may end up | ||
| 554 | with a number of TODO entries so large that you'd like to prioritize | ||
| 555 | them. You can do this by placing a @emph{priority cookie} into the | ||
| 556 | headline, like this | ||
| 557 | |||
| 558 | @example | ||
| 559 | *** TODO [#A] Write letter to Sam Fortune | ||
| 560 | @end example | ||
| 561 | |||
| 562 | @noindent | ||
| 563 | With its standard setup, Org-mode supports priorities @samp{A}, | ||
| 564 | @samp{B}, and @samp{C}. @samp{A} is the highest priority. An entry | ||
| 565 | without a cookie is treated as priority @samp{B}. Priorities make a | ||
| 566 | difference only in the multi-file agenda (@pxref{Agenda (multiple files)}). | ||
| 567 | |||
| 568 | @table @kbd | ||
| 569 | @kindex @kbd{C-c ,} | ||
| 570 | @item @kbd{C-c ,} | ||
| 571 | Set the priority of the current item. The command prompts for a | ||
| 572 | priority character @samp{A}, @samp{B} or @samp{C}. When you press | ||
| 573 | @key{SPC} instead, the priority cookie is removed from the headline. | ||
| 574 | @kindex S-@key{up} | ||
| 575 | @kindex S-@key{down} | ||
| 576 | @item S-@key{up} | ||
| 577 | @itemx S-@key{down} | ||
| 578 | Increase/decrease priority of current item. Note that these keys are | ||
| 579 | also used to modify time stamps (@pxref{Creating timestamps}). | ||
| 580 | @end table | ||
| 581 | |||
| 582 | |||
| 583 | @node TODO extensions, , Priorities, TODO items | ||
| 584 | @section Extended use of TODO keywords | 562 | @section Extended use of TODO keywords |
| 585 | @cindex extended TODO keywords | 563 | @cindex extended TODO keywords |
| 586 | 564 | ||
| @@ -624,9 +602,11 @@ If you define many keywords, you can use in-buffer completion (see | |||
| 624 | @cindex types as TODO keywords | 602 | @cindex types as TODO keywords |
| 625 | 603 | ||
| 626 | The second possibility is to use TODO keywords to indicate different | 604 | The second possibility is to use TODO keywords to indicate different |
| 627 | types of action items. For example, when you work with several people | 605 | types of action items. For example, you might want to indicate that |
| 628 | on a single project, you might want to assign action items to | 606 | items are for ``work'' or ``home''. Or, when you work with several |
| 629 | persons. | 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: | ||
| 630 | 610 | ||
| 631 | @lisp | 611 | @lisp |
| 632 | (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") | 612 | (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE") |
| @@ -634,12 +614,15 @@ persons. | |||
| 634 | @end lisp | 614 | @end lisp |
| 635 | 615 | ||
| 636 | In this case, different keywords do not indicate a sequence, but | 616 | In this case, different keywords do not indicate a sequence, but |
| 637 | rather different types. This changes the behavior of the command | 617 | rather different types. So it is normally not useful to change from |
| 638 | @kbd{C-c C-t} slightly. When used several times in succession, it | 618 | one type to another. Therefore, in this case the the behavior of the |
| 639 | will still cycle through all names. But when when you return to the | 619 | command @kbd{C-c C-t} is changed slightly@footnote{This is also true |
| 640 | item after some time and execute @kbd{C-c C-t} again, it will switch | 620 | for the @kbd{t} command in the timeline and agenda buffers}. When |
| 641 | from each name directly to DONE. Use prefix arguments or completion | 621 | used several times in succession, it will still cycle through all |
| 642 | to quickly select a specific name. | 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. | ||
| 643 | 626 | ||
| 644 | @node Per file keywords, , TODO types, TODO extensions | 627 | @node Per file keywords, , TODO types, TODO extensions |
| 645 | @subsection Setting up TODO keywords for individual files | 628 | @subsection Setting up TODO keywords for individual files |
| @@ -647,11 +630,12 @@ to quickly select a specific name. | |||
| 647 | @cindex per file keywords | 630 | @cindex per file keywords |
| 648 | 631 | ||
| 649 | It can be very useful to use different aspects of the TODO mechanism | 632 | It can be very useful to use different aspects of the TODO mechanism |
| 650 | in different files. For this you need to add special lines to the | 633 | in different files, which is not possible with the global settings |
| 651 | file which set the keywords and interpretation for that file only. | 634 | described above. For file-local settings, you need to add special |
| 652 | For example, to set one of the two examples discussed above, you | 635 | lines to the file which set the keywords and interpretation for that |
| 653 | need one of the following lines, starting in column zero anywhere in | 636 | file only. For example, to set one of the two examples discussed |
| 654 | the file: | 637 | above, you need one of the following lines, starting in column zero |
| 638 | anywhere in the file: | ||
| 655 | 639 | ||
| 656 | @example | 640 | @example |
| 657 | #+SEQ_TODO: TODO FEEDBACK VERIFY DONE | 641 | #+SEQ_TODO: TODO FEEDBACK VERIFY DONE |
| @@ -664,11 +648,15 @@ the file: | |||
| 664 | @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. | 648 | @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion. |
| 665 | 649 | ||
| 666 | @cindex DONE, final TODO keyword | 650 | @cindex DONE, final TODO keyword |
| 667 | Remember that the last keyword must always mean that the | 651 | Remember that the last keyword must always mean that the item is DONE |
| 668 | item is DONE (you may use a different word, though). After changing | 652 | (you may use a different word, though). Also note that in each file, |
| 669 | these lines, use @kbd{M-x normal-mode} to make the changes known to | 653 | only one of the two aspects of TODO keywords can be used. After |
| 670 | Org-mode. Also note that in each file, only one of the two aspects | 654 | changing one of these lines, use @kbd{C-c C-c} with the cursor still |
| 671 | of TODO keywords can be used. | 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.}. | ||
| 672 | 660 | ||
| 673 | If you want to use very many keywords, for example when working with a | 661 | If you want to use very many keywords, for example when working with a |
| 674 | large group of people, you may split the names over several lines: | 662 | large group of people, you may split the names over several lines: |
| @@ -680,6 +668,43 @@ large group of people, you may split the names over several lines: | |||
| 680 | #+TYP_TODO: DONE | 668 | #+TYP_TODO: DONE |
| 681 | @end example | 669 | @end example |
| 682 | 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 | |||
| 683 | @node Tables, Hyperlinks, TODO items, Top | 708 | @node Tables, Hyperlinks, TODO items, Top |
| 684 | @chapter Tables | 709 | @chapter Tables |
| 685 | @cindex tables | 710 | @cindex tables |
| @@ -995,7 +1020,7 @@ RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to the | |||
| 995 | current article/entry. For W3 and W3M buffer, the link goes to the | 1020 | current article/entry. For W3 and W3M buffer, the link goes to the |
| 996 | current URL. For any other files, the link will just point to the file. | 1021 | current URL. For any other files, the link will just point to the file. |
| 997 | The key binding @kbd{C-c l} is only a suggestion - see | 1022 | The key binding @kbd{C-c l} is only a suggestion - see |
| 998 | @ref{Installation}. | 1023 | @ref{Installation and Activation}. |
| 999 | 1024 | ||
| 1000 | @kindex C-c C-l | 1025 | @kindex C-c C-l |
| 1001 | @item C-c C-l | 1026 | @item C-c C-l |
| @@ -1048,7 +1073,6 @@ directly to the correct location in your Org-mode outline tree. The | |||
| 1048 | following customization will tell @emph{Remember} to use org files as | 1073 | following customization will tell @emph{Remember} to use org files as |
| 1049 | target, and to create annotations compatible with Org-mode links. | 1074 | target, and to create annotations compatible with Org-mode links. |
| 1050 | 1075 | ||
| 1051 | |||
| 1052 | @c FIXME: The autoload will not be necessary when Org-mode is part of Emacs | 1076 | @c FIXME: The autoload will not be necessary when Org-mode is part of Emacs |
| 1053 | @example | 1077 | @example |
| 1054 | (autoload 'org-remember-annotation "org") | 1078 | (autoload 'org-remember-annotation "org") |
| @@ -1113,7 +1137,7 @@ A time stamp is a specification of a date (possibly with time) in a | |||
| 1113 | special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16 | 1137 | special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16 |
| 1114 | Tue 09:39>}. A time stamp can appear anywhere in the headline or body | 1138 | Tue 09:39>}. A time stamp can appear anywhere in the headline or body |
| 1115 | of an org-tree entry. Its presence allows to show entries on specific | 1139 | of an org-tree entry. Its presence allows to show entries on specific |
| 1116 | dates in the agenda (@pxref{Agenda (multiple files)}). We distinguish: | 1140 | dates in the agenda (@pxref{Agenda}). We distinguish: |
| 1117 | 1141 | ||
| 1118 | @table @var | 1142 | @table @var |
| 1119 | @cindex timestamp | 1143 | @cindex timestamp |
| @@ -1192,7 +1216,7 @@ instead. | |||
| 1192 | @kindex C-c C-o | 1216 | @kindex C-c C-o |
| 1193 | @item C-c C-o | 1217 | @item C-c C-o |
| 1194 | Access the agenda for the date given by the time stamp at point | 1218 | Access the agenda for the date given by the time stamp at point |
| 1195 | (@pxref{Agenda (multiple files)}). | 1219 | (@pxref{Agenda}). |
| 1196 | 1220 | ||
| 1197 | @kindex C-c C-d | 1221 | @kindex C-c C-d |
| 1198 | @item C-c C-d | 1222 | @item C-c C-d |
| @@ -1303,13 +1327,13 @@ which covers all of your current projects, action items and | |||
| 1303 | appointments. | 1327 | appointments. |
| 1304 | 1328 | ||
| 1305 | @menu | 1329 | @menu |
| 1306 | * Timeline (single file):: Time-sorted view for single file | 1330 | * Timeline:: Time-sorted view for single file |
| 1307 | * Agenda (multiple files):: Your weekly planner | 1331 | * Agenda:: Your weekly planner |
| 1308 | * Agenda commands:: Remote editing of org trees | 1332 | * Agenda commands:: Remote editing of org trees |
| 1309 | * Calendar/Diary integration:: Integrating Anniversaries and more | 1333 | * Calendar/Diary integration:: Integrating Anniversaries and more |
| 1310 | @end menu | 1334 | @end menu |
| 1311 | 1335 | ||
| 1312 | @node Timeline (single file), Agenda (multiple files), Timeline and Agenda, Timeline and Agenda | 1336 | @node Timeline, Agenda, Timeline and Agenda, Timeline and Agenda |
| 1313 | @section Timeline for a single file | 1337 | @section Timeline for a single file |
| 1314 | @cindex single file summary | 1338 | @cindex single file summary |
| 1315 | @cindex agenda, for single file | 1339 | @cindex agenda, for single file |
| @@ -1335,9 +1359,9 @@ The timeline is shown in a temporary buffer @file{*Org Agenda*}. The | |||
| 1335 | commands available in the Agenda buffer are listed in @ref{Agenda | 1359 | commands available in the Agenda buffer are listed in @ref{Agenda |
| 1336 | commands}. | 1360 | commands}. |
| 1337 | 1361 | ||
| 1338 | @node Agenda (multiple files), Agenda commands, Timeline (single file), Timeline and Agenda | 1362 | @node Agenda, Agenda commands, Timeline, Timeline and Agenda |
| 1339 | @section Agenda from multiple files | 1363 | @section Agenda |
| 1340 | @cindex agenda, from multiple files | 1364 | @cindex agenda |
| 1341 | 1365 | ||
| 1342 | An agenda can be compiled from one or more org files. The main | 1366 | An agenda can be compiled from one or more org files. The main |
| 1343 | purpose of this command is to act like a planner, in order to show you | 1367 | purpose of this command is to act like a planner, in order to show you |
| @@ -1374,7 +1398,7 @@ when the variable @code{org-agenda-include-all-todo} is @code{t}), all | |||
| 1374 | unfinished TODO items (also those without a date) are also listed at | 1398 | unfinished TODO items (also those without a date) are also listed at |
| 1375 | the beginning of the buffer, before the first date.@* | 1399 | the beginning of the buffer, before the first date.@* |
| 1376 | The key binding @kbd{C-c a} is only a suggestion - see | 1400 | The key binding @kbd{C-c a} is only a suggestion - see |
| 1377 | @ref{Installation}. | 1401 | @ref{Installation and Activation}. |
| 1378 | @end table | 1402 | @end table |
| 1379 | 1403 | ||
| 1380 | The commands available in the Agenda buffer are listed in | 1404 | The commands available in the Agenda buffer are listed in |
| @@ -1384,24 +1408,18 @@ The commands available in the Agenda buffer are listed in | |||
| 1384 | 1408 | ||
| 1385 | @cindex category | 1409 | @cindex category |
| 1386 | In the agenda buffer, each entry is preceded by a @emph{category}, | 1410 | In the agenda buffer, each entry is preceded by a @emph{category}, |
| 1387 | which is derived from the file name. You can also set the category of | 1411 | which is derived from the file name. The category can also be set |
| 1388 | a file through file variables, for example by making the first line of | 1412 | with a special line anywhere in the buffer, looking like this: |
| 1389 | the file look like this: | ||
| 1390 | |||
| 1391 | @cindex file variables | ||
| 1392 | @example | ||
| 1393 | Planet Finder -*- mode: org; org-category: Cheops -*- | ||
| 1394 | @end example | ||
| 1395 | @noindent | ||
| 1396 | Or, like with TODO keywords (@pxref{Per file keywords}), you can | ||
| 1397 | insert a special line anywhere in the file: | ||
| 1398 | |||
| 1399 | @example | 1413 | @example |
| 1400 | #+CATEGORY: Cheops | 1414 | #+CATEGORY: Cheops |
| 1401 | @end example | 1415 | @end example |
| 1402 | @noindent | 1416 | @noindent |
| 1403 | The display looks best if the category is no longer than 10 characters. | 1417 | 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 | ||
| 1419 | will only be active the next time you visit this file with Emacs. | ||
| 1404 | 1420 | ||
| 1421 | The display in the agenda buffer looks best if the category is no | ||
| 1422 | longer than 10 characters. | ||
| 1405 | 1423 | ||
| 1406 | @subsection Sorting of agenda items | 1424 | @subsection Sorting of agenda items |
| 1407 | @cindex sorting, of agenda items | 1425 | @cindex sorting, of agenda items |
| @@ -1427,7 +1445,7 @@ plus additional increments for overdue scheduled or deadline items. | |||
| 1427 | Sorting can be customized using the variable | 1445 | Sorting can be customized using the variable |
| 1428 | @code{org-agenda-sorting-strategy}. | 1446 | @code{org-agenda-sorting-strategy}. |
| 1429 | 1447 | ||
| 1430 | @node Agenda commands, Calendar/Diary integration, Agenda (multiple files), Timeline and Agenda | 1448 | @node Agenda commands, Calendar/Diary integration, Agenda, Timeline and Agenda |
| 1431 | @section Commands in the agenda buffer | 1449 | @section Commands in the agenda buffer |
| 1432 | 1450 | ||
| 1433 | Entries in the agenda buffer are linked back to the org file or diary | 1451 | Entries in the agenda buffer are linked back to the org file or diary |
| @@ -1443,6 +1461,13 @@ commands are available for both timelines and the agenda. The | |||
| 1443 | exceptions are marked. | 1461 | exceptions are marked. |
| 1444 | 1462 | ||
| 1445 | @table @kbd | 1463 | @table @kbd |
| 1464 | @tsubheading{Motion} | ||
| 1465 | @kindex n | ||
| 1466 | @item n | ||
| 1467 | Next line (same as @key{up}). | ||
| 1468 | @kindex p | ||
| 1469 | @item p | ||
| 1470 | Previous line (same as @key{down}). | ||
| 1446 | @tsubheading{View/GoTo org file} | 1471 | @tsubheading{View/GoTo org file} |
| 1447 | @kindex mouse-3 | 1472 | @kindex mouse-3 |
| 1448 | @kindex @key{SPC} | 1473 | @kindex @key{SPC} |
| @@ -1470,7 +1495,6 @@ Toggle follow mode. In follow mode, as you move the cursor through | |||
| 1470 | the agenda buffer, the other window always shows the corresponding | 1495 | the agenda buffer, the other window always shows the corresponding |
| 1471 | location in the org file. | 1496 | location in the org file. |
| 1472 | 1497 | ||
| 1473 | |||
| 1474 | @tsubheading{Change display} | 1498 | @tsubheading{Change display} |
| 1475 | @kindex o | 1499 | @kindex o |
| 1476 | @item o | 1500 | @item o |
| @@ -1515,8 +1539,8 @@ Digit argument. | |||
| 1515 | Change the TODO state of the item, both in the agenda and in the | 1539 | Change the TODO state of the item, both in the agenda and in the |
| 1516 | original org file. | 1540 | original org file. |
| 1517 | 1541 | ||
| 1518 | @kindex p | 1542 | @kindex , |
| 1519 | @item p | 1543 | @item , |
| 1520 | Set the priority for the current item. Org-mode prompts for the | 1544 | Set the priority for the current item. Org-mode prompts for the |
| 1521 | priority character. If you reply with @key{SPC}, the priority cookie | 1545 | priority character. If you reply with @key{SPC}, the priority cookie |
| 1522 | is removed from the entry. | 1546 | is removed from the entry. |
| @@ -1526,13 +1550,17 @@ is removed from the entry. | |||
| 1526 | Display weighted priority of current item. | 1550 | Display weighted priority of current item. |
| 1527 | 1551 | ||
| 1528 | @kindex + | 1552 | @kindex + |
| 1553 | @kindex S-@key{up} | ||
| 1529 | @item + | 1554 | @item + |
| 1555 | @item S-@key{up} | ||
| 1530 | Increase the priority of the current item. The priority is changed in | 1556 | Increase the priority of the current item. The priority is changed in |
| 1531 | the original buffer, but the agenda is not resorted. Use the @kbd{r} | 1557 | the original buffer, but the agenda is not resorted. Use the @kbd{r} |
| 1532 | key for this. | 1558 | key for this. |
| 1533 | 1559 | ||
| 1534 | @kindex - | 1560 | @kindex - |
| 1561 | @kindex S-@key{down} | ||
| 1535 | @item - | 1562 | @item - |
| 1563 | @item S-@key{down} | ||
| 1536 | Decrease the priority of the current item. | 1564 | Decrease the priority of the current item. |
| 1537 | 1565 | ||
| 1538 | @kindex S-@key{right} | 1566 | @kindex S-@key{right} |
| @@ -1568,10 +1596,9 @@ The date is taken from the cursor position. | |||
| 1568 | @item c | 1596 | @item c |
| 1569 | Open the Emacs calendar and move to the date at the agenda cursor. | 1597 | Open the Emacs calendar and move to the date at the agenda cursor. |
| 1570 | 1598 | ||
| 1571 | @kindex C | 1599 | @item c |
| 1572 | @item C | 1600 | When in the calendar, compute and show the Org-mode agenda for the |
| 1573 | Convert the date at cursor into many other cultural and historic | 1601 | date at the cursor. |
| 1574 | calendars. | ||
| 1575 | 1602 | ||
| 1576 | @kindex M | 1603 | @kindex M |
| 1577 | @item M | 1604 | @item M |
| @@ -1579,8 +1606,13 @@ Show the phases of the moon for three month around current date. | |||
| 1579 | 1606 | ||
| 1580 | @kindex S | 1607 | @kindex S |
| 1581 | @item S | 1608 | @item S |
| 1582 | Show sunrise and sunset times. The location must be set with calendar | 1609 | Show sunrise and sunset times. The geographical location must be set |
| 1583 | variables, see documentation of the Emacs calendar. | 1610 | with calendar variables, see documentation of the Emacs calendar. |
| 1611 | |||
| 1612 | @kindex C | ||
| 1613 | @item C | ||
| 1614 | Convert the date at cursor into many other cultural and historic | ||
| 1615 | calendars. | ||
| 1584 | 1616 | ||
| 1585 | @kindex H | 1617 | @kindex H |
| 1586 | @item H | 1618 | @item H |
| @@ -1643,7 +1675,8 @@ file, in order to edit existing diary entries. Also the @kbd{i} | |||
| 1643 | command to insert new entries for the current date works in the agenda | 1675 | command to insert new entries for the current date works in the agenda |
| 1644 | buffer, as well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to | 1676 | buffer, as well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to |
| 1645 | display Sunrise/Sunset times, show lunar phases and to convert to | 1677 | display Sunrise/Sunset times, show lunar phases and to convert to |
| 1646 | other calendars, respectively. | 1678 | other calendars, respectively. @kbd{c} can be used to switch back and |
| 1679 | forth between calendar and agenda. | ||
| 1647 | 1680 | ||
| 1648 | @node Agenda to diary, , Diary to agenda, Calendar/Diary integration | 1681 | @node Agenda to diary, , Diary to agenda, Calendar/Diary integration |
| 1649 | @subsection Including the agenda into the diary | 1682 | @subsection Including the agenda into the diary |
| @@ -1651,8 +1684,8 @@ other calendars, respectively. | |||
| 1651 | If you prefer to use the Emacs diary as your main instrument and if | 1684 | If you prefer to use the Emacs diary as your main instrument and if |
| 1652 | you wish to include the Org-mode agenda into it, the following steps | 1685 | you wish to include the Org-mode agenda into it, the following steps |
| 1653 | are necessary: Autoload the function @command{org-diary} as shown | 1686 | are necessary: Autoload the function @command{org-diary} as shown |
| 1654 | above under @ref{Installation}. You also need to use @emph{fancy | 1687 | above under @ref{Installation and Activation}. You also need to use |
| 1655 | diary display} by setting in @file{.emacs}: | 1688 | @emph{fancy diary display} by setting in @file{.emacs}: |
| 1656 | 1689 | ||
| 1657 | @lisp | 1690 | @lisp |
| 1658 | (add-hook 'diary-display-hook 'fancy-diary-display) | 1691 | (add-hook 'diary-display-hook 'fancy-diary-display) |
| @@ -2038,11 +2071,6 @@ planner. | |||
| 2038 | Org mode cooperates with table.el, see @ref{table.el}. | 2071 | Org mode cooperates with table.el, see @ref{table.el}. |
| 2039 | @end table | 2072 | @end table |
| 2040 | 2073 | ||
| 2041 | @c EmacsWiki | ||
| 2042 | @c organizer-mode | ||
| 2043 | @c todo-mode | ||
| 2044 | @c records mode | ||
| 2045 | |||
| 2046 | @page @c FIXME | 2074 | @page @c FIXME |
| 2047 | 2075 | ||
| 2048 | @node Acknowledgments, Bugs, Interaction, Miscellaneous | 2076 | @node Acknowledgments, Bugs, Interaction, Miscellaneous |
| @@ -2068,9 +2096,9 @@ in HTML output, and other export improvements. | |||
| 2068 | Christian Egli converted the documentation into TeXInfo format. He | 2096 | Christian Egli converted the documentation into TeXInfo format. He |
| 2069 | also showed me his plans for a multifile summary for Org-mode. Some of | 2097 | also showed me his plans for a multifile summary for Org-mode. Some of |
| 2070 | his ideas have found their way into the agenda. | 2098 | his ideas have found their way into the agenda. |
| 2071 | @item | 2099 | @item |
| 2072 | Philip Rooke created the Org-mode reference card and did some | 2100 | Philip Rooke created the Org-mode reference card. He also helped with |
| 2073 | beta-testing. | 2101 | beta testing and contributed a number of very useful ideas. |
| 2074 | @item | 2102 | @item |
| 2075 | Linking to VM/BBDB/GNUS was inspired by Tom Shannon's | 2103 | Linking to VM/BBDB/GNUS was inspired by Tom Shannon's |
| 2076 | @file{organizer-mode.el}. | 2104 | @file{organizer-mode.el}. |
| @@ -2102,8 +2130,8 @@ the file), it does so silently. No error message is displayed. | |||
| 2102 | Under XEmacs, if Org-mode entries are included into the diary, it is | 2130 | Under XEmacs, if Org-mode entries are included into the diary, it is |
| 2103 | not possible to jump back from the diary to the org file. Apparently, | 2131 | not possible to jump back from the diary to the org file. Apparently, |
| 2104 | the text properties are lost when the fancy-diary-display is used. | 2132 | the text properties are lost when the fancy-diary-display is used. |
| 2105 | However, from Org-mode's agenda (created with @kbd{C-c C-r} or | 2133 | However, from Org-mode's timeline and agenda buffers (created with |
| 2106 | @kbd{M-x org-agenda}), things do work correctly. | 2134 | @kbd{C-c C-r} and @kbd{C-c a}), things do work correctly. |
| 2107 | @item | 2135 | @item |
| 2108 | Linux should also have a default viewer application, using mailcap. | 2136 | Linux should also have a default viewer application, using mailcap. |
| 2109 | Maybe we can use GNUS or VM mime code? Or dired's guessing commands? | 2137 | Maybe we can use GNUS or VM mime code? Or dired's guessing commands? |
| @@ -2126,7 +2154,6 @@ The exporters work well, but could be made more efficient. | |||
| 2126 | 2154 | ||
| 2127 | @bye | 2155 | @bye |
| 2128 | 2156 | ||
| 2129 | |||
| 2130 | @ignore | 2157 | @ignore |
| 2131 | arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac | 2158 | arch-tag: 7893d1fe-cc57-4d13-b5e5-f494a1bcc7ac |
| 2132 | @end ignore | 2159 | @end ignore |