aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Dominik2005-11-24 14:47:17 +0000
committerCarsten Dominik2005-11-24 14:47:17 +0000
commitebfe0a9cff3f31b104777a0c4803987c21ece54d (patch)
tree09c873590784d0492022b887bec3310507a0a5ee
parent9981213caf12302a6e8938a09a40218ddbab871f (diff)
downloademacs-ebfe0a9cff3f31b104777a0c4803987c21ece54d.tar.gz
emacs-ebfe0a9cff3f31b104777a0c4803987c21ece54d.zip
(Structure editing): New item moving commands added.
(Plain Lists): New section.
-rw-r--r--man/org.texi130
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
109Tables 110Tables
110 111
@@ -212,15 +213,16 @@ printing and sharing of notes, an Org-mode file can be exported as a
212structured ASCII file, as HTML, or (todo and agenda items only) as an 213structured ASCII file, as HTML, or (todo and agenda items only) as an
213iCalendar file. 214iCalendar file.
214 215
215Org-mode keeps simple things simple. Not every outline branch needs 216Org-mode keeps simple things simple. When first fired up, it should
216to be an action item, not every action item needs to have priority or 217feel like a simple but easy to use outliner. Complexity is not
217scheduling information associated with it. Org-mode can be used on 218imposed, but a large amount of functionality is available when you
218different levels and in different ways, for example 219need it. Org-mode can be used on different levels and in different
220ways, 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
349Headlines define the structure of an outline tree. The Headlines in 352Headlines define the structure of an outline tree. The Headlines in
350Org-mode start with one or more stars, for example 353Org-mode start with one or more stars, on the left margin. For
354example
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
478Demote the current subtree by one level 482Demote 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}
481Move subtree up (swap with previous subtree of same level) 485Move subtree up (swap with previous subtree of same
486level)
482@kindex M-S-@key{down} 487@kindex M-S-@key{down}
483@item M-S-@key{down} 488@item M-S-@key{down}
484Move subtree down (swap with next subtree of same level) 489Move subtree down (swap with next subtree of same level)
@@ -530,7 +535,7 @@ this, see the documentation string of the variable
530agenda, archiving to a different file is a good way to keep archived 535agenda, archiving to a different file is a good way to keep archived
531trees from contributing agenda items. 536trees 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
573the document to another file (extension @file{.txt}) which then can be 578the document to another file (extension @file{.txt}) which then can be
574printed in any desired way. 579printed 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
586Headlines define the entire structure of the Org-mode file, and also
587lists (for example TODO items (@pxref{TODO items}) should be created
588using headline levels. However, when taking notes, the plain text is
589sometimes easier to read with hand-formatted lists. Org-mode supports
590editing such lists, and the HTML exporter (@pxref{Exporting}) does
591parse and format them.
592
593Org-mode knows ordered and unordered lists. Unordered list items
594start with @samp{-}, @samp{+}, or @samp{*}@footnote{When using
595@samp{*} as a bullet, lines must be indented or they will be seen as
596top-level headlines.} as bullets. Ordered list items start with
597@samp{1.} or @samp{1)}. Items belonging to the same list must have
598the same indentation on the first line. In particular, if an ordered
599list reaches number @samp{10.}, also the 2--digit numbers must be
600written left-aligned with the other numbers in the list. Indentation
601also determines the end of a list item. It ends before the next line
602that is indented like the bullet/number, or less. For example:
603
604@example
605** Lord of the Rings
606My favorite scenes are (in this order
6071. Eowyns fight with the witch king
608 + this was already my favorite scene in the book
609 + I really like Miranda Ott.
6102. The attack of the Roherim
6113. Peter Jackson being shot by Legolas
612 - on DVD only
613 He makes a really funny face when it happens.
614@end example
615
616Org-mode supports these lists by tuning filling and wrapping commands
617to correctly deal with them. Futhermore, the following commands act
618on items when the cursor is in the first line of an item (the line
619with 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}
626Move the item including subitems up/down (swap with previous/next item
627of same intentation). If the list is ordered, renumbering is
628automatic.
629@kindex M-S-@key{left}
630@kindex M-S-@key{right}
631@item M-S-@key{left}
632@itemx M-S-@key{right}
633Decrease/increase the indentation of the item, including subitems.
634Initially, the item tree is selected based on current indentation.
635When these commands are executed several times in direct succession,
636the initially selected region is used, even if the new indentation
637would imply a different hierarchy. To use the new hierarchy, break
638the command chain with a cursor motion or so.
639@kindex C-c C-c
640@item C-c C-c
641Renumber 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
2267Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as 2335Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as
2268bullet@footnote{When using @samp{*} as a bullet, lines must be 2336bullet, or with @samp{1.} or @samp{2)} as enumerator will be recognized and
2269indented or they will be seen as top-level headlines.}, or 2337transformed into HTML lists. See @xref{Plain Lists}.
2270with @samp{1.}, @samp{2.} as enumerator will be recognized and 2338
2271transformed into HTML lists. The
2272lists is terminated by the next headline, or by a line that is
2273indented like the bullet/enumerator in the first line, or less. For
2274example:
2275@example
2276** Lord of the Rings
2277Some 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
2283My favorite characters are (in this sequence):
2284 1. Sam
2285 2. Eowyn
2286 3. Aragorn
2287Among the others I don't really have a preference.
2288@end example
2289By 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.
2772Juergen Vollmer contributed code generating the table of contents 2820Juergen Vollmer contributed code generating the table of contents
2773in HTML output, and other export improvements. 2821in HTML output, and other export improvements.
2774@item 2822@item
2775Christian Egli converted the documentation into TeXInfo format. He 2823Christian Egli converted the documentation into TeXInfo format and
2776also showed me his plans for a multifile summary for Org-mode. Some of 2824patched basic CSS formatting support into the HTML exporter. He also
2777his ideas have found their way into the agenda. 2825inspired the agenda by showing me his plans for a multifile summary.
2778@item 2826@item
2779Philip Rooke created the Org-mode reference card. He also helped with 2827Philip Rooke created the Org-mode reference card. He also helped with
2780beta testing and contributed a number of very useful ideas. 2828beta 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
2791Scheduling TODO items was inspired by John Wiegley's @file{planner.el}. 2839Scheduling TODO items was inspired by John Wiegley's @file{planner.el}.
2792@item 2840@item
2793Sacha Chua, the current maintainer of Planner, offered linking code 2841Sacha Chua, the current maintainer of Planner, suggested to copy
2794from Planner. I made use of the offer for links to RMAIL and Wanderlust. 2842linking code from Planner (I took code for RMAIL and Wanderlust).
2795@item 2843@item
2796Oliver Oppitz sent several useful suggestions. 2844Oliver Oppitz made useful suggestions.
2797@item 2845@item
2798Carsten Wimmer suggested some changes and helped fix a bug in linking 2846Carsten Wimmer suggested some changes and helped fix a bug in linking
2799to GNUS. 2847to GNUS.
@@ -2807,8 +2855,8 @@ Emacs-Lisp compiler happy.
2807Kai Grossjohann pointed out that a number of key bindings in Org-mode 2855Kai Grossjohann pointed out that a number of key bindings in Org-mode
2808conflict with other packages. 2856conflict with other packages.
2809@item 2857@item
2810Roland Winkler pointed out that additional keybindings are need to use 2858Roland Winkler pointed out that additional keybindings are needed to
2811Org-mode on a tty. 2859use 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