Mercurial > emacs
comparison man/org.texi @ 69225:a2d5fbc00b3e
(Interaction): Added item about `org-mouse.el' by Piotr
Zielinski.
(Managing links, Managing links): Documented that also mouse-1 can
be used to activate a link.
(Headlines, FAQ): Added entry about hiding leading stars.
(Miscellaneous): Resorted the sections in this chapter to a more
logical sequence.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Wed, 01 Mar 2006 07:08:45 +0000 |
parents | 5ddb96998b75 |
children | 05d354109b2c |
comparison
equal
deleted
inserted
replaced
69224:e80276821f75 | 69225:a2d5fbc00b3e |
---|---|
2 @c %**start of header | 2 @c %**start of header |
3 @c @setfilename org | 3 @c @setfilename org |
4 @setfilename ../info/org | 4 @setfilename ../info/org |
5 @settitle Org Mode Manual | 5 @settitle Org Mode Manual |
6 | 6 |
7 @set VERSION 4.06 | 7 @set VERSION 4.07 |
8 @set DATE February 2006 | 8 @set DATE March 2006 |
9 | 9 |
10 @dircategory Emacs | 10 @dircategory Emacs |
11 @direntry | 11 @direntry |
12 * Org Mode: (org). outline-based notes management and organizer | 12 * Org Mode: (org). outline-based notes management and organizer |
13 @end direntry | 13 @end direntry |
186 | 186 |
187 Miscellaneous | 187 Miscellaneous |
188 | 188 |
189 * Completion:: M-TAB knows what you need | 189 * Completion:: M-TAB knows what you need |
190 * Customization:: Adapting Org-mode to your taste | 190 * Customization:: Adapting Org-mode to your taste |
191 * Clean view:: Getting rid of leading stars in the outline | |
192 * TTY keys:: Using Org-mode on a tty | |
191 * FAQ:: Frequently asked questions | 193 * FAQ:: Frequently asked questions |
192 * Interaction:: Other Emacs packages | 194 * Interaction:: Other Emacs packages |
193 * TTY keys:: Using Org-mode on a tty | |
194 * Bugs:: Things which do not work perfectly | 195 * Bugs:: Things which do not work perfectly |
195 * Acknowledgments:: These people provided feedback and more | 196 * Acknowledgments:: These people provided feedback and more |
196 | 197 |
197 @end detailmenu | 198 @end detailmenu |
198 @end menu | 199 @end menu |
376 some text | 377 some text |
377 *** 3rd level | 378 *** 3rd level |
378 more text | 379 more text |
379 * Another top level headline | 380 * Another top level headline |
380 @end example | 381 @end example |
382 @noindent Some people find the many stars too noisy and would prefer an | |
383 outline that has whitespace followed by a single star as headline | |
384 starters. @ref{Clean view} describes a setup to realize this. | |
381 | 385 |
382 @node Visibility cycling, Motion, Headlines, Document Structure | 386 @node Visibility cycling, Motion, Headlines, Document Structure |
383 @section Visibility cycling | 387 @section Visibility cycling |
384 @cindex cycling, visibility | 388 @cindex cycling, visibility |
385 @cindex visibility cycling | 389 @cindex visibility cycling |
510 level) | 514 level) |
511 @kindex M-S-@key{down} | 515 @kindex M-S-@key{down} |
512 @item M-S-@key{down} | 516 @item M-S-@key{down} |
513 Move subtree down (swap with next subtree of same level) | 517 Move subtree down (swap with next subtree of same level) |
514 @kindex C-c C-x C-w | 518 @kindex C-c C-x C-w |
519 @kindex C-c C-x C-k | |
515 @item C-c C-x C-w | 520 @item C-c C-x C-w |
521 @itemx C-c C-x C-k | |
516 Kill subtree, i.e. remove it from buffer but save in kill ring. | 522 Kill subtree, i.e. remove it from buffer but save in kill ring. |
517 @kindex C-c C-x M-w | 523 @kindex C-c C-x M-w |
518 @item C-c C-x M-w | 524 @item C-c C-x M-w |
519 Copy subtree to kill ring. | 525 Copy subtree to kill ring. |
520 @kindex C-c C-x C-y | 526 @kindex C-c C-x C-y |
625 @cindex sparse tree, tag based | 631 @cindex sparse tree, tag based |
626 | 632 |
627 If you wish to implement a tag system to cross-correlate information, | 633 If you wish to implement a tag system to cross-correlate information, |
628 this can be done as well in Org-mode. Every headline can contain a | 634 this can be done as well in Org-mode. Every headline can contain a |
629 list of tags, at the end of the headline. Tags are normal words | 635 list of tags, at the end of the headline. Tags are normal words |
630 containing letters and @samp{_}, but no numbers. Tags must be | 636 containing letters, numbers, @samp{_}, and @samp{@@}. Tags must be |
631 preceded and followed by a single colon; like @samp{:WORK:}. Several | 637 preceded and followed by a single colon; like @samp{:WORK:}. Several |
632 tags can be specified like @samp{:WORK:URGENT:}. | 638 tags can be specified like @samp{:WORK:URGENT:}. |
633 | 639 |
634 @cindex inheritance, of tags | 640 @cindex inheritance, of tags |
635 Tags make use of the hierarchical structure of outline trees. If a | 641 Tags make use of the hierarchical structure of outline trees. If a |
707 headline levels. However, when taking notes, the plain text is | 713 headline levels. However, when taking notes, the plain text is |
708 sometimes easier to read with hand-formatted lists. Org-mode supports | 714 sometimes easier to read with hand-formatted lists. Org-mode supports |
709 editing such lists, and the HTML exporter (@pxref{Exporting}) does | 715 editing such lists, and the HTML exporter (@pxref{Exporting}) does |
710 parse and format them. | 716 parse and format them. |
711 | 717 |
712 Org-mode knows ordered and unordered lists. Unordered list items | 718 Org-mode knows ordered and unordered lists. Unordered list items start |
713 start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using | 719 with @samp{-}, @samp{+}, or @samp{*}@footnote{When using @samp{*} as a |
714 @samp{*} as a bullet, lines must be indented or they will be seen as | 720 bullet, lines must be indented or they will be seen as top-level |
715 top-level headlines.} as bullets. Ordered list items start with | 721 headlines. Also, when you are hiding leading stars to get a clean |
716 @samp{1.} or @samp{1)}. Items belonging to the same list must have | 722 outline view, plain list items starting with a star are visually |
717 the same indentation on the first line. In particular, if an ordered | 723 indistinguishable from true headlines. In short: Even though @samp{*} |
718 list reaches number @samp{10.}, also the 2--digit numbers must be | 724 is supported, it may be better to not use it for plain list items} as |
719 written left-aligned with the other numbers in the list. Indentation | 725 bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items |
720 also determines the end of a list item. It ends before the next line | 726 belonging to the same list must have the same indentation on the first |
721 that is indented like the bullet/number, or less. For example: | 727 line. In particular, if an ordered list reaches number @samp{10.}, also |
728 the 2--digit numbers must be written left-aligned with the other numbers | |
729 in the list. Indentation also determines the end of a list item. It | |
730 ends before the next line that is indented like the bullet/number, or | |
731 less. For example: | |
722 | 732 |
723 @example | 733 @example |
724 ** Lord of the Rings | 734 ** Lord of the Rings |
725 My favorite scenes are (in this order) | 735 My favorite scenes are (in this order) |
726 1. Eowyns fight with the witch king | 736 1. Eowyns fight with the witch king |
1048 @subsection Formula syntax | 1058 @subsection Formula syntax |
1049 @cindex formula syntax | 1059 @cindex formula syntax |
1050 @cindex syntax, of formulas | 1060 @cindex syntax, of formulas |
1051 | 1061 |
1052 A formula can be any algebraic expression understood by the Emacs | 1062 A formula can be any algebraic expression understood by the Emacs |
1053 @file{calc} package. Before evaluation by @code{calc-eval} | 1063 @file{calc} package. Note that @file{calc} has the slightly |
1054 (@pxref{Calling Calc from Your Lisp Programs,calc-eval,Calling calc | 1064 non-standard conversion that @samp{/} has lower precedence than |
1055 from Your Lisp Programs,calc,GNU Emacs Calc Manual}), variable | 1065 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}. Before |
1056 substitution takes place: | 1066 evaluation by @code{calc-eval} (@pxref{Calling Calc from Your Lisp |
1067 Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU Emacs | |
1068 Calc Manual}), variable substitution takes place: | |
1057 | 1069 |
1058 @example | 1070 @example |
1059 $ @r{refers to the current field} | 1071 $ @r{refers to the current field} |
1060 $3 @r{refers to the field in column 3 of the current row} | 1072 $3 @r{refers to the field in column 3 of the current row} |
1061 $3..$7 @r{a vector of the fields in columns 3-7 of current row} | 1073 $3..$7 @r{a vector of the fields in columns 3-7 of current row} |
1519 command to insert a link. Links in Org-mode are plain text, and you | 1531 command to insert a link. Links in Org-mode are plain text, and you |
1520 can type or paste them straight into the buffer. | 1532 can type or paste them straight into the buffer. |
1521 | 1533 |
1522 @cindex following links | 1534 @cindex following links |
1523 @kindex C-c C-o | 1535 @kindex C-c C-o |
1524 @kindex mouse-2 | |
1525 @item C-c C-o | 1536 @item C-c C-o |
1526 @itemx mouse-2 | |
1527 Open link at point. This will launch a web browser for URLs (using | 1537 Open link at point. This will launch a web browser for URLs (using |
1528 @command{browse-url-at-point}), run vm/gnus/bbdb for the corresponding | 1538 @command{browse-url-at-point}), run vm/gnus/bbdb for the corresponding |
1529 links, and execute the command in a shell link. When the cursor is on | 1539 links, and execute the command in a shell link. When the cursor is on |
1530 a CamelCase link, this commands runs the corresponding search. When | 1540 a CamelCase link, this commands runs the corresponding search. When |
1531 the cursor is on a TAGS list in a headline, it creates the | 1541 the cursor is on a TAGS list in a headline, it creates the |
1540 | 1550 |
1541 @strong{IMPORTANT}: Be careful not to use any dangerous commands in a | 1551 @strong{IMPORTANT}: Be careful not to use any dangerous commands in a |
1542 shell link. | 1552 shell link. |
1543 | 1553 |
1544 @kindex mouse-2 | 1554 @kindex mouse-2 |
1555 @kindex mouse-1 | |
1545 @item mouse-2 | 1556 @item mouse-2 |
1546 On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} would. | 1557 @itemx mouse-1 |
1558 On links, @kbd{mouse-2} will open the link just like @kbd{C-c C-o} | |
1559 would. Under Emacs 22, also @kbd{mouse-1} will follow a link. | |
1547 | 1560 |
1548 @kindex mouse-3 | 1561 @kindex mouse-3 |
1549 @item mouse-3 | 1562 @item mouse-3 |
1550 Like @kbd{mouse-2}, but force file links to be opened with Emacs. | 1563 Like @kbd{mouse-2}, but force file links to be opened with Emacs. |
1551 | 1564 |
2485 @kindex L | 2498 @kindex L |
2486 @item L | 2499 @item L |
2487 Display original location and recenter that window. | 2500 Display original location and recenter that window. |
2488 | 2501 |
2489 @kindex mouse-2 | 2502 @kindex mouse-2 |
2503 @kindex mouse-1 | |
2490 @kindex @key{TAB} | 2504 @kindex @key{TAB} |
2491 @item mouse-2 | 2505 @item mouse-2 |
2506 @itemx mouse-1 | |
2492 @itemx @key{TAB} | 2507 @itemx @key{TAB} |
2493 Go to the original location of the item in another window. | 2508 Go to the original location of the item in another window. Under Emacs |
2509 22, also @kbd{mouse-1} will works for this. | |
2494 | 2510 |
2495 @kindex @key{RET} | 2511 @kindex @key{RET} |
2496 @itemx @key{RET} | 2512 @itemx @key{RET} |
2497 Go to the original location of the item and delete other windows. | 2513 Go to the original location of the item and delete other windows. |
2498 | 2514 |
2950 @chapter Miscellaneous | 2966 @chapter Miscellaneous |
2951 | 2967 |
2952 @menu | 2968 @menu |
2953 * Completion:: M-TAB knows what you need | 2969 * Completion:: M-TAB knows what you need |
2954 * Customization:: Adapting Org-mode to your taste | 2970 * Customization:: Adapting Org-mode to your taste |
2971 * Clean view:: Getting rid of leading stars in the outline | |
2972 * TTY keys:: Using Org-mode on a tty | |
2955 * FAQ:: Frequently asked questions | 2973 * FAQ:: Frequently asked questions |
2956 * Interaction:: Other Emacs packages | 2974 * Interaction:: Other Emacs packages |
2957 * TTY keys:: Using Org-mode on a tty | |
2958 * Bugs:: Things which do not work perfectly | 2975 * Bugs:: Things which do not work perfectly |
2959 * Acknowledgments:: These people provided feedback and more | 2976 * Acknowledgments:: These people provided feedback and more |
2960 @end menu | 2977 @end menu |
2961 | 2978 |
2962 @node Completion, Customization, Miscellaneous, Miscellaneous | 2979 @node Completion, Customization, Miscellaneous, Miscellaneous |
3000 @item | 3017 @item |
3001 Elsewhere, complete dictionary words using ispell. | 3018 Elsewhere, complete dictionary words using ispell. |
3002 @end itemize | 3019 @end itemize |
3003 @end table | 3020 @end table |
3004 | 3021 |
3005 @node Customization, FAQ, Completion, Miscellaneous | 3022 |
3023 @node Customization, Clean view, Completion, Miscellaneous | |
3006 @section Customization | 3024 @section Customization |
3007 @cindex customization | 3025 @cindex customization |
3008 @cindex options, for customization | 3026 @cindex options, for customization |
3009 @cindex variables, for customization | 3027 @cindex variables, for customization |
3010 | 3028 |
3012 Org-mode. For the sake of compactness of the manual, we are not | 3030 Org-mode. For the sake of compactness of the manual, we are not |
3013 describing the variables here. A structured overview of customization | 3031 describing the variables here. A structured overview of customization |
3014 variables is available with @kbd{M-x org-customize}. Or select | 3032 variables is available with @kbd{M-x org-customize}. Or select |
3015 @code{Browse Org Group} from the @code{Org->Customization} menu. | 3033 @code{Browse Org Group} from the @code{Org->Customization} menu. |
3016 | 3034 |
3017 @node FAQ, Interaction, Customization, Miscellaneous | 3035 @node Clean view, TTY keys, Customization, Miscellaneous |
3036 @section A cleaner outline view | |
3037 @cindex hiding leading stars | |
3038 @cindex clean outline view | |
3039 | |
3040 Some people find it noisy and distracting that the Org-mode headlines | |
3041 are starting with a potentially large number of stars. For example in | |
3042 the example tree from @ref{Headlines}: | |
3043 | |
3044 @example | |
3045 * Top level headline | |
3046 ** Second level | |
3047 *** 3rd level | |
3048 some text | |
3049 *** 3rd level | |
3050 more text | |
3051 * Another top level headline | |
3052 @end example | |
3053 | |
3054 @noindent | |
3055 Unfortunately this is deeply ingrained into the code of Org-mode and | |
3056 cannot be easily changed. You can, however, modify the display in such | |
3057 a way that all leading stars become invisible and the outline more easy | |
3058 to read. To do this, customize the variable | |
3059 @code{org-hide-leading-stars} like this: | |
3060 | |
3061 @lisp | |
3062 (setq org-hide-leading-stars t) | |
3063 @end lisp | |
3064 | |
3065 @noindent | |
3066 and restart emacs (this is necessary to make this change effective). | |
3067 The tree then becomes | |
3068 | |
3069 @example | |
3070 * Top level headline | |
3071 * Second level | |
3072 * 3rd level | |
3073 some text | |
3074 * 3rd level | |
3075 more text | |
3076 * Another top level headline | |
3077 @end example | |
3078 | |
3079 @noindent | |
3080 Note that the leading stars are not truly replaced by whitespace, they | |
3081 are only fontified with the face @code{org-hide} that uses the | |
3082 background color as font color. If are are not using either white or | |
3083 black background, you may have to customize this face to get the wanted | |
3084 effect. Another possibility is to set this font such that the extra | |
3085 stars are @i{almost} invisible, for example using the color | |
3086 @code{grey90} on a white background. | |
3087 | |
3088 Things become cleaner still if you skip all the even levels and use only | |
3089 odd levels 1, 3, 5..., effectively adding two stars to go from one | |
3090 outline level to the next: | |
3091 | |
3092 @example | |
3093 * Top level headline | |
3094 * Second level | |
3095 * 3rd level | |
3096 some text | |
3097 * 3rd level | |
3098 more text | |
3099 * Another top level headline | |
3100 @end example | |
3101 | |
3102 @noindent | |
3103 In order to make the structure editing and export commands handle this | |
3104 convention correctly, use (again a restart of emacs will be needed) | |
3105 | |
3106 @lisp | |
3107 (setq org-odd-levels-only t) | |
3108 @end lisp | |
3109 | |
3110 @noindent | |
3111 You can convert an Org-mode file from single-star-per-level to | |
3112 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels | |
3113 RET} in that file. It is not possible to use this setting on a | |
3114 file-local basis, so you need to decide which format to use. | |
3115 | |
3116 @node TTY keys, FAQ, Clean view, Miscellaneous | |
3117 @section Using org-mode on a tty | |
3118 @cindex tty keybindings | |
3119 | |
3120 Org-mode uses a number of keys that are not accessible on a tty. This | |
3121 applies to most special keys like cursor keys, @key{TAB} and | |
3122 @key{RET}, when these are combined with modifier keys like @key{Meta} | |
3123 and/or @key{Shift}. Org-mode uses these bindings because it needs to | |
3124 provide keys for a large number of commands, and because these keys | |
3125 appeared particularly easy to remember. In order to still be able to | |
3126 access the core functionality of Org-mode on a tty, alternative | |
3127 bindings are provided. Here is a complete list of these bindings, | |
3128 which are obviously more cumbersome to use. Note that sometimes a | |
3129 work-around can be better. For example changing a time stamp is | |
3130 really only fun with @kbd{S-@key{cursor}} keys. On a tty you would | |
3131 rather use @kbd{C-c .} to re-insert the timestamp. | |
3132 | |
3133 @page | |
3134 @multitable @columnfractions 0.15 0.2 0.2 | |
3135 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
3136 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
3137 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
3138 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
3139 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}} | |
3140 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab | |
3141 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
3142 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
3143 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
3144 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
3145 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
3146 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
3147 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
3148 @item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
3149 @item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
3150 @item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab | |
3151 @item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab | |
3152 @end multitable | |
3153 | |
3154 @node FAQ, Interaction, TTY keys, Miscellaneous | |
3018 @section Frequently asked questions | 3155 @section Frequently asked questions |
3019 @cindex FAQ | 3156 @cindex FAQ |
3020 | 3157 |
3021 @enumerate | 3158 @enumerate |
3022 @item @b{Org-mode seems to be a useful default mode for the various | 3159 @item @b{Org-mode seems to be a useful default mode for the various |
3023 @file{README} files I have scattered through my directories. How do I | 3160 @file{README} files I have scattered through my directories. How do I |
3024 turn it on for all @file{README} files?} | 3161 turn it on for all @file{README} files?} |
3025 @example | 3162 @example |
3026 (add-to-list 'auto-mode-alist '("README$" . org-mode)) | 3163 (add-to-list 'auto-mode-alist '("README$" . org-mode)) |
3027 @end example | 3164 @end example |
3165 | |
3166 @item @b{All these stars are driving me mad, I just find the Emacs | |
3167 outlines unreadable. Can't you just put white space and a single star as a | |
3168 starter for headlines?}@* | |
3169 See @ref{Clean view}. | |
3028 | 3170 |
3029 @item @b{I would like to have two windows on the same Org-mode | 3171 @item @b{I would like to have two windows on the same Org-mode |
3030 file, but with different outline visibility. Is that possible?}@* | 3172 file, but with different outline visibility. Is that possible?}@* |
3031 @cindex @code{make-indirect-buffer} | 3173 @cindex @code{make-indirect-buffer} |
3032 @cindex indirect buffers | 3174 @cindex indirect buffers |
3136 also the documentation of the @command{org-diary} function. | 3278 also the documentation of the @command{org-diary} function. |
3137 | 3279 |
3138 @end enumerate | 3280 @end enumerate |
3139 | 3281 |
3140 | 3282 |
3141 @node Interaction, TTY keys, FAQ, Miscellaneous | 3283 @node Interaction, Bugs, FAQ, Miscellaneous |
3142 @section Interaction with other packages | 3284 @section Interaction with other packages |
3143 @cindex packages, interaction with other | 3285 @cindex packages, interaction with other |
3144 Org-mode can cooperate with the following packages: | 3286 Org-mode can cooperate with the following packages: |
3145 | 3287 |
3146 @table @asis | 3288 @table @asis |
3289 @cindex @file{org-mouse.el} | |
3290 @item @file{org-mouse.el} by Piotr Zielinski | |
3291 This package implements extended mouse functionality for Org-mode. It | |
3292 allows to cycle visibility and to edit the document structure with the | |
3293 mouse. It also provides a context-sensitive menu that changes depending | |
3294 on the context of a mouse-click. Use a search engine to find this | |
3295 package on the web. | |
3147 @cindex @file{table.el} | 3296 @cindex @file{table.el} |
3148 @item @file{table.el} by Takaaki Ota | 3297 @item @file{table.el} by Takaaki Ota |
3149 Org mode cooperates with table.el, see @ref{table.el}. | 3298 Org mode cooperates with table.el, see @ref{table.el}. @file{table.el} |
3299 is part of Emacs 22. | |
3150 @cindex @file{calc.el} | 3300 @cindex @file{calc.el} |
3151 @item @file{calc.el} by Dave Gillespie | 3301 @item @file{calc.el} by Dave Gillespie |
3152 Org-mode uses the calc package for implementing spreadsheet | 3302 Org-mode uses the calc package for implementing spreadsheet |
3153 functionality in its tables (@pxref{Table calculations}). Org-modes | 3303 functionality in its tables (@pxref{Table calculations}). Org-modes |
3154 checks for the availability of calc by looking for the function | 3304 checks for the availability of calc by looking for the function |
3187 Yes, these are unfortunately more difficult to remember. If you want | 3337 Yes, these are unfortunately more difficult to remember. If you want |
3188 to have other replacement keys, look at the variable | 3338 to have other replacement keys, look at the variable |
3189 @code{org-disputed-keys}. | 3339 @code{org-disputed-keys}. |
3190 @item @file{remember.el} by John Wiegley | 3340 @item @file{remember.el} by John Wiegley |
3191 Org mode cooperates with remember, see @ref{Remember}. | 3341 Org mode cooperates with remember, see @ref{Remember}. |
3342 @file{remember.el} is not part of Emacs, find it on the web. | |
3192 @cindex @file{planner.el} | 3343 @cindex @file{planner.el} |
3193 @item @file{planner.el} by John Wiegley | 3344 @item @file{planner.el} by John Wiegley |
3194 Planner is another tool to plan work and keep track of tasks. Planner | 3345 Planner is another tool to plan work and keep track of tasks. Planner |
3195 uses a multi-file approach with project pages and day pages. Is based | 3346 uses a multi-file approach with project pages and day pages. Is based |
3196 on Emacs-Wiki. If Planner is your primary tool, it can be useful to | 3347 on Emacs-Wiki. If Planner is your primary tool, it can be useful to |
3197 display the agenda entries resulting from org files in day-pages of | 3348 display the agenda entries resulting from org files in day-pages of |
3198 the planner. This can be done through the diary of the calendar: | 3349 the planner. This can be done through the diary of the calendar: |
3199 Integrate org files into the diary as described above, and then turn | 3350 Integrate org files into the diary as described above, and then turn |
3200 on the diary support of planner. | 3351 on the diary support of planner. Planner is not part of Emacs, find it |
3352 on the web. | |
3201 @end table | 3353 @end table |
3202 | 3354 |
3203 @node TTY keys, Bugs, Interaction, Miscellaneous | 3355 @node Bugs, Acknowledgments, Interaction, Miscellaneous |
3204 @section Using org-mode on a tty | |
3205 @cindex tty keybindings | |
3206 | |
3207 Org-mode uses a number of keys that are not accessible on a tty. This | |
3208 applies to most special keys like cursor keys, @key{TAB} and | |
3209 @key{RET}, when these are combined with modifier keys like @key{Meta} | |
3210 and/or @key{Shift}. Org-mode uses these bindings because it needs to | |
3211 provide keys for a large number of commands, and because these keys | |
3212 appeared particularly easy to remember. In order to still be able to | |
3213 access the core functionality of Org-mode on a tty, alternative | |
3214 bindings are provided. Here is a complete list of these bindings, | |
3215 which are obviously more cumbersome to use. Note that sometimes a | |
3216 work-around can be better. For example changing a time stamp is | |
3217 really only fun with @kbd{S-@key{cursor}} keys. On a tty you would | |
3218 rather use @kbd{C-c .} to re-insert the timestamp. | |
3219 | |
3220 @page | |
3221 @multitable @columnfractions 0.15 0.2 0.2 | |
3222 @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2} | |
3223 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab | |
3224 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}} | |
3225 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab | |
3226 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}} | |
3227 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab | |
3228 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}} | |
3229 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab | |
3230 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}} | |
3231 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab | |
3232 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab | |
3233 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}} | |
3234 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab | |
3235 @item @kbd{S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab | |
3236 @item @kbd{S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab | |
3237 @item @kbd{S-@key{up}} @tab @kbd{C-c C-x @key{up}} @tab | |
3238 @item @kbd{S-@key{down}} @tab @kbd{C-c C-x @key{down}} @tab | |
3239 @end multitable | |
3240 | |
3241 @node Bugs, Acknowledgments, TTY keys, Miscellaneous | |
3242 @section Bugs | 3356 @section Bugs |
3243 @cindex bugs | 3357 @cindex bugs |
3244 | 3358 |
3245 Here is a list of things which should work differently, but which I | 3359 Here is a list of things which should work differently, but which I |
3246 have found too hard to fix. | 3360 have found too hard to fix. |
3247 | 3361 |
3248 @itemize @bullet | 3362 @itemize @bullet |
3249 @c @item | |
3250 @c If you call @code{fill-paragraph} (bound to @kbd{M-q}) in a table, the | |
3251 @c filling is correctly disabled. However, if some text directly | |
3252 @c (without an empty line in between) precedes or follows a table, calling | |
3253 @c @code{fill-paragraph} in that text will also fill the table like | |
3254 @c normal text. Also, @code{fill-region} does bypass the | |
3255 @c @code{fill-paragraph} code and will fill tables like normal text. | |
3256 @item | 3363 @item |
3257 Text in an entry protected with the @samp{QUOTE} keyword should not | 3364 Text in an entry protected with the @samp{QUOTE} keyword should not |
3258 autowrap. | 3365 autowrap. |
3259 @item | 3366 @item |
3260 When the application called by @kbd{C-c C-o} to open a file link fails | 3367 When the application called by @kbd{C-c C-o} to open a file link fails |
3261 (for example because the application does not exits or refuses to open | 3368 (for example because the application does not exits or refuses to open |
3262 the file), it does so silently. No error message is displayed. | 3369 the file), it does so silently. No error message is displayed. |
3370 @item | |
3371 Plain list items should be able to hold a TODO item. Unfortunately this | |
3372 has so many technical problems that I will only consider this change for | |
3373 the next major release (5.0). | |
3263 @item | 3374 @item |
3264 The remote-editing commands in the agenda buffer cannot be undone with | 3375 The remote-editing commands in the agenda buffer cannot be undone with |
3265 @code{undo} called from within the agenda buffer. But you can go to | 3376 @code{undo} called from within the agenda buffer. But you can go to |
3266 the corresponding buffer (using @key{TAB} or @key{RET} and execute | 3377 the corresponding buffer (using @key{TAB} or @key{RET} and execute |
3267 @code{undo} there. | 3378 @code{undo} there. |
3274 not possible to jump back from the diary to the org file. Apparently, | 3385 not possible to jump back from the diary to the org file. Apparently, |
3275 the text properties are lost when the fancy-diary-display is used. | 3386 the text properties are lost when the fancy-diary-display is used. |
3276 However, from Org-mode's timeline and agenda buffers (created with | 3387 However, from Org-mode's timeline and agenda buffers (created with |
3277 @kbd{C-c C-r} and @kbd{C-c a}), things do work correctly. | 3388 @kbd{C-c C-r} and @kbd{C-c a}), things do work correctly. |
3278 @item | 3389 @item |
3279 Linux should also have a default viewer application, using mailcap. | 3390 You can only make a single word boldface or italic. To emphasize |
3280 Maybe we can use GNUS or VM mime code? Or dired's guessing commands? | 3391 several words in a row, each much have the emphasize markers, like in |
3281 Any hints (or even patches) are appreciated. | 3392 @samp{*three* *bold* *words*}. |
3282 @item | |
3283 When you write @samp{x = a /b/ c}, b will be exported in italics. | |
3284 @item | 3393 @item |
3285 The exporters work well, but could be made more efficient. | 3394 The exporters work well, but could be made more efficient. |
3286 @end itemize | 3395 @end itemize |
3287 | 3396 |
3288 @page | 3397 @page |
3351 Carsten Wimmer suggested some changes and helped fix a bug in linking | 3460 Carsten Wimmer suggested some changes and helped fix a bug in linking |
3352 to GNUS. | 3461 to GNUS. |
3353 @item | 3462 @item |
3354 Roland Winkler pointed out that additional keybindings are needed to | 3463 Roland Winkler pointed out that additional keybindings are needed to |
3355 use Org-mode on a tty. | 3464 use Org-mode on a tty. |
3465 @item | |
3466 Piotr Zielinski wrote @file{org-mouse.el} and pointed out to me that | |
3467 Emacs 22 can be made to follow links using mouse-1 clicks. | |
3356 @c @item | 3468 @c @item |
3357 @c Nic Ferrier and Christian Egli implemented XML export. | 3469 @c Nic Ferrier and Christian Egli implemented XML export. |
3358 @end itemize | 3470 @end itemize |
3359 | 3471 |
3360 @node Index, Key Index, Miscellaneous, Top | 3472 @node Index, Key Index, Miscellaneous, Top |