diff options
| author | Carsten Dominik | 2005-11-24 14:47:17 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2005-11-24 14:47:17 +0000 |
| commit | ebfe0a9cff3f31b104777a0c4803987c21ece54d (patch) | |
| tree | 09c873590784d0492022b887bec3310507a0a5ee | |
| parent | 9981213caf12302a6e8938a09a40218ddbab871f (diff) | |
| download | emacs-ebfe0a9cff3f31b104777a0c4803987c21ece54d.tar.gz emacs-ebfe0a9cff3f31b104777a0c4803987c21ece54d.zip | |
(Structure editing): New item moving commands added.
(Plain Lists): New section.
| -rw-r--r-- | man/org.texi | 130 |
1 files changed, 89 insertions, 41 deletions
diff --git a/man/org.texi b/man/org.texi index 5a8d45638bd..48bf3020833 100644 --- a/man/org.texi +++ b/man/org.texi | |||
| @@ -4,8 +4,8 @@ | |||
| 4 | @setfilename ../info/org | 4 | @setfilename ../info/org |
| 5 | @settitle Org Mode Manual | 5 | @settitle Org Mode Manual |
| 6 | 6 | ||
| 7 | @set VERSION 3.20 | 7 | @set VERSION 3.21 |
| 8 | @set DATE October 2005 | 8 | @set DATE December 2005 |
| 9 | 9 | ||
| 10 | @dircategory Emacs | 10 | @dircategory Emacs |
| 11 | @direntry | 11 | @direntry |
| @@ -105,6 +105,7 @@ Document Structure | |||
| 105 | * Structure editing:: Changing sequence and level of headlines | 105 | * Structure editing:: Changing sequence and level of headlines |
| 106 | * Archiving:: Move done task trees to a different place | 106 | * Archiving:: Move done task trees to a different place |
| 107 | * Sparse trees:: Matches embedded in context | 107 | * Sparse trees:: Matches embedded in context |
| 108 | * Plain Lists:: Editing hand-formatted lists | ||
| 108 | 109 | ||
| 109 | Tables | 110 | Tables |
| 110 | 111 | ||
| @@ -212,15 +213,16 @@ printing and sharing of notes, an Org-mode file can be exported as a | |||
| 212 | structured ASCII file, as HTML, or (todo and agenda items only) as an | 213 | structured ASCII file, as HTML, or (todo and agenda items only) as an |
| 213 | iCalendar file. | 214 | iCalendar file. |
| 214 | 215 | ||
| 215 | Org-mode keeps simple things simple. Not every outline branch needs | 216 | Org-mode keeps simple things simple. When first fired up, it should |
| 216 | to be an action item, not every action item needs to have priority or | 217 | feel like a simple but easy to use outliner. Complexity is not |
| 217 | scheduling information associated with it. Org-mode can be used on | 218 | imposed, but a large amount of functionality is available when you |
| 218 | different levels and in different ways, for example | 219 | need it. Org-mode can be used on different levels and in different |
| 220 | ways, for example | ||
| 219 | 221 | ||
| 220 | @example | 222 | @example |
| 221 | @r{@bullet{} as an outline extension with visibility cycling and structure editing} | 223 | @r{@bullet{} as an outline extension with visibility cycling and structure editing} |
| 222 | @r{@bullet{} as an ASCII system and table editor to take structured notes} | 224 | @r{@bullet{} as an ASCII system and table editor to take structured notes} |
| 223 | @r{@bullet{} as an ASCII table editor with some spreadsheet-like capabilities} | 225 | @r{@bullet{} as an ASCII table editor with spreadsheet-like capabilities} |
| 224 | @r{@bullet{} as a simple hypertext system, with HTML export} | 226 | @r{@bullet{} as a simple hypertext system, with HTML export} |
| 225 | @r{@bullet{} as a TODO list editor} | 227 | @r{@bullet{} as a TODO list editor} |
| 226 | @r{@bullet{} as a full agenda and planner with deadlines and work scheduling} | 228 | @r{@bullet{} as a full agenda and planner with deadlines and work scheduling} |
| @@ -324,6 +326,7 @@ edit the structure of the document. | |||
| 324 | * Structure editing:: Changing sequence and level of headlines | 326 | * Structure editing:: Changing sequence and level of headlines |
| 325 | * Archiving:: Move done task trees to a different place | 327 | * Archiving:: Move done task trees to a different place |
| 326 | * Sparse trees:: Matches embedded in context | 328 | * Sparse trees:: Matches embedded in context |
| 329 | * Plain Lists:: Editing hand-formatted lists | ||
| 327 | @end menu | 330 | @end menu |
| 328 | 331 | ||
| 329 | @node Outlines, Headlines, Document Structure, Document Structure | 332 | @node Outlines, Headlines, Document Structure, Document Structure |
| @@ -347,7 +350,8 @@ key. | |||
| 347 | @cindex outline tree | 350 | @cindex outline tree |
| 348 | 351 | ||
| 349 | Headlines define the structure of an outline tree. The Headlines in | 352 | Headlines define the structure of an outline tree. The Headlines in |
| 350 | Org-mode start with one or more stars, for example | 353 | Org-mode start with one or more stars, on the left margin. For |
| 354 | example | ||
| 351 | 355 | ||
| 352 | @example | 356 | @example |
| 353 | * Top level headline | 357 | * Top level headline |
| @@ -478,7 +482,8 @@ Promote the current subtree by one level | |||
| 478 | Demote the current subtree by one level | 482 | Demote the current subtree by one level |
| 479 | @kindex M-S-@key{up} | 483 | @kindex M-S-@key{up} |
| 480 | @item M-S-@key{up} | 484 | @item M-S-@key{up} |
| 481 | Move subtree up (swap with previous subtree of same level) | 485 | Move subtree up (swap with previous subtree of same |
| 486 | level) | ||
| 482 | @kindex M-S-@key{down} | 487 | @kindex M-S-@key{down} |
| 483 | @item M-S-@key{down} | 488 | @item M-S-@key{down} |
| 484 | Move subtree down (swap with next subtree of same level) | 489 | Move subtree down (swap with next subtree of same level) |
| @@ -530,7 +535,7 @@ this, see the documentation string of the variable | |||
| 530 | agenda, archiving to a different file is a good way to keep archived | 535 | agenda, archiving to a different file is a good way to keep archived |
| 531 | trees from contributing agenda items. | 536 | trees from contributing agenda items. |
| 532 | 537 | ||
| 533 | @node Sparse trees, , Archiving, Document Structure | 538 | @node Sparse trees, Plain Lists, Archiving, Document Structure |
| 534 | @section Sparse trees | 539 | @section Sparse trees |
| 535 | @cindex sparse trees | 540 | @cindex sparse trees |
| 536 | @cindex trees, sparse | 541 | @cindex trees, sparse |
| @@ -573,6 +578,69 @@ Or you can use the command @kbd{C-c C-x v} to copy the visible part of | |||
| 573 | the document to another file (extension @file{.txt}) which then can be | 578 | the document to another file (extension @file{.txt}) which then can be |
| 574 | printed in any desired way. | 579 | printed in any desired way. |
| 575 | 580 | ||
| 581 | @node Plain Lists, , Sparse trees, Document Structure | ||
| 582 | @section Plain Lists | ||
| 583 | @cindex plain lists | ||
| 584 | @cindex lists, plain | ||
| 585 | |||
| 586 | Headlines define the entire structure of the Org-mode file, and also | ||
| 587 | lists (for example TODO items (@pxref{TODO items}) should be created | ||
| 588 | using headline levels. However, when taking notes, the plain text is | ||
| 589 | sometimes easier to read with hand-formatted lists. Org-mode supports | ||
| 590 | editing such lists, and the HTML exporter (@pxref{Exporting}) does | ||
| 591 | parse and format them. | ||
| 592 | |||
| 593 | Org-mode knows ordered and unordered lists. Unordered list items | ||
| 594 | start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using | ||
| 595 | @samp{*} as a bullet, lines must be indented or they will be seen as | ||
| 596 | top-level headlines.} as bullets. Ordered list items start with | ||
| 597 | @samp{1.} or @samp{1)}. Items belonging to the same list must have | ||
| 598 | the same indentation on the first line. In particular, if an ordered | ||
| 599 | list reaches number @samp{10.}, also the 2--digit numbers must be | ||
| 600 | written left-aligned with the other numbers in the list. Indentation | ||
| 601 | also determines the end of a list item. It ends before the next line | ||
| 602 | that is indented like the bullet/number, or less. For example: | ||
| 603 | |||
| 604 | @example | ||
| 605 | ** Lord of the Rings | ||
| 606 | My favorite scenes are (in this order | ||
| 607 | 1. Eowyns fight with the witch king | ||
| 608 | + this was already my favorite scene in the book | ||
| 609 | + I really like Miranda Ott. | ||
| 610 | 2. The attack of the Roherim | ||
| 611 | 3. Peter Jackson being shot by Legolas | ||
| 612 | - on DVD only | ||
| 613 | He makes a really funny face when it happens. | ||
| 614 | @end example | ||
| 615 | |||
| 616 | Org-mode supports these lists by tuning filling and wrapping commands | ||
| 617 | to correctly deal with them. Futhermore, the following commands act | ||
| 618 | on items when the cursor is in the first line of an item (the line | ||
| 619 | with the bullet or number). | ||
| 620 | |||
| 621 | @table @kbd | ||
| 622 | @kindex M-S-@key{up} | ||
| 623 | @kindex M-S-@key{down} | ||
| 624 | @item M-S-@key{up} | ||
| 625 | @itemx M-S-@key{down} | ||
| 626 | Move the item including subitems up/down (swap with previous/next item | ||
| 627 | of same intentation). If the list is ordered, renumbering is | ||
| 628 | automatic. | ||
| 629 | @kindex M-S-@key{left} | ||
| 630 | @kindex M-S-@key{right} | ||
| 631 | @item M-S-@key{left} | ||
| 632 | @itemx M-S-@key{right} | ||
| 633 | Decrease/increase the indentation of the item, including subitems. | ||
| 634 | Initially, the item tree is selected based on current indentation. | ||
| 635 | When these commands are executed several times in direct succession, | ||
| 636 | the initially selected region is used, even if the new indentation | ||
| 637 | would imply a different hierarchy. To use the new hierarchy, break | ||
| 638 | the command chain with a cursor motion or so. | ||
| 639 | @kindex C-c C-c | ||
| 640 | @item C-c C-c | ||
| 641 | Renumber the ordered list at the cursor. | ||
| 642 | @end table | ||
| 643 | |||
| 576 | @node Tables, Hyperlinks, Document Structure, Top | 644 | @node Tables, Hyperlinks, Document Structure, Top |
| 577 | @chapter Tables | 645 | @chapter Tables |
| 578 | @cindex tables | 646 | @cindex tables |
| @@ -2265,29 +2333,9 @@ exporter implements the following interpretation: | |||
| 2265 | @cindex lists, hand-formatted | 2333 | @cindex lists, hand-formatted |
| 2266 | @item | 2334 | @item |
| 2267 | Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as | 2335 | Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as |
| 2268 | bullet@footnote{When using @samp{*} as a bullet, lines must be | 2336 | bullet, or with @samp{1.} or @samp{2)} as enumerator will be recognized and |
| 2269 | indented or they will be seen as top-level headlines.}, or | 2337 | transformed into HTML lists. See @xref{Plain Lists}. |
| 2270 | with @samp{1.}, @samp{2.} as enumerator will be recognized and | 2338 | |
| 2271 | transformed into HTML lists. The | ||
| 2272 | lists is terminated by the next headline, or by a line that is | ||
| 2273 | indented like the bullet/enumerator in the first line, or less. For | ||
| 2274 | example: | ||
| 2275 | @example | ||
| 2276 | ** Lord of the Rings | ||
| 2277 | Some of my favorite scenes are | ||
| 2278 | - Eowyns fight | ||
| 2279 | - The attack of the Roherim | ||
| 2280 | (this may be favorite one) | ||
| 2281 | - Peter Jackson being shot by Legolas, | ||
| 2282 | in the extended DVD edition only | ||
| 2283 | My favorite characters are (in this sequence): | ||
| 2284 | 1. Sam | ||
| 2285 | 2. Eowyn | ||
| 2286 | 3. Aragorn | ||
| 2287 | Among the others I don't really have a preference. | ||
| 2288 | @end example | ||
| 2289 | By default, only no nesting of lists is allowed, but see the variable | ||
| 2290 | @code{org-export-local-list-max-depth}. | ||
| 2291 | @cindex underlined text | 2339 | @cindex underlined text |
| 2292 | @cindex bold text | 2340 | @cindex bold text |
| 2293 | @cindex italic text | 2341 | @cindex italic text |
| @@ -2772,9 +2820,9 @@ Kevin Rogers contributed code to access VM files on remote hosts. | |||
| 2772 | Juergen Vollmer contributed code generating the table of contents | 2820 | Juergen Vollmer contributed code generating the table of contents |
| 2773 | in HTML output, and other export improvements. | 2821 | in HTML output, and other export improvements. |
| 2774 | @item | 2822 | @item |
| 2775 | Christian Egli converted the documentation into TeXInfo format. He | 2823 | Christian Egli converted the documentation into TeXInfo format and |
| 2776 | also showed me his plans for a multifile summary for Org-mode. Some of | 2824 | patched basic CSS formatting support into the HTML exporter. He also |
| 2777 | his ideas have found their way into the agenda. | 2825 | inspired the agenda by showing me his plans for a multifile summary. |
| 2778 | @item | 2826 | @item |
| 2779 | Philip Rooke created the Org-mode reference card. He also helped with | 2827 | Philip Rooke created the Org-mode reference card. He also helped with |
| 2780 | beta testing and contributed a number of very useful ideas. | 2828 | beta testing and contributed a number of very useful ideas. |
| @@ -2790,10 +2838,10 @@ Linking to VM/BBDB/GNUS was inspired by Tom Shannon's | |||
| 2790 | @item | 2838 | @item |
| 2791 | Scheduling TODO items was inspired by John Wiegley's @file{planner.el}. | 2839 | Scheduling TODO items was inspired by John Wiegley's @file{planner.el}. |
| 2792 | @item | 2840 | @item |
| 2793 | Sacha Chua, the current maintainer of Planner, offered linking code | 2841 | Sacha Chua, the current maintainer of Planner, suggested to copy |
| 2794 | from Planner. I made use of the offer for links to RMAIL and Wanderlust. | 2842 | linking code from Planner (I took code for RMAIL and Wanderlust). |
| 2795 | @item | 2843 | @item |
| 2796 | Oliver Oppitz sent several useful suggestions. | 2844 | Oliver Oppitz made useful suggestions. |
| 2797 | @item | 2845 | @item |
| 2798 | Carsten Wimmer suggested some changes and helped fix a bug in linking | 2846 | Carsten Wimmer suggested some changes and helped fix a bug in linking |
| 2799 | to GNUS. | 2847 | to GNUS. |
| @@ -2807,8 +2855,8 @@ Emacs-Lisp compiler happy. | |||
| 2807 | Kai Grossjohann pointed out that a number of key bindings in Org-mode | 2855 | Kai Grossjohann pointed out that a number of key bindings in Org-mode |
| 2808 | conflict with other packages. | 2856 | conflict with other packages. |
| 2809 | @item | 2857 | @item |
| 2810 | Roland Winkler pointed out that additional keybindings are need to use | 2858 | Roland Winkler pointed out that additional keybindings are needed to |
| 2811 | Org-mode on a tty. | 2859 | use Org-mode on a tty. |
| 2812 | @end itemize | 2860 | @end itemize |
| 2813 | 2861 | ||
| 2814 | @node Index, Key Index, Miscellaneous, Top | 2862 | @node Index, Key Index, Miscellaneous, Top |