/[emacs]/emacs/man/org.texi
ViewVC logotype

Diff of /emacs/man/org.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.26 by cdominik, Fri Nov 18 16:09:49 2005 UTC revision 1.27 by cdominik, Thu Nov 24 14:47:17 2005 UTC
# Line 4  Line 4 
4  @setfilename ../info/org  @setfilename ../info/org
5  @settitle Org Mode Manual  @settitle Org Mode Manual
6    
7  @set VERSION 3.20  @set VERSION 3.21
8  @set DATE October 2005  @set DATE December 2005
9    
10  @dircategory Emacs  @dircategory Emacs
11  @direntry  @direntry
# Line 105  Document Structure Line 105  Document Structure
105  * Structure editing::           Changing sequence and level of headlines  * Structure editing::           Changing sequence and level of headlines
106  * Archiving::                   Move done task trees to a different place  * Archiving::                   Move done task trees to a different place
107  * Sparse trees::                Matches embedded in context  * Sparse trees::                Matches embedded in context
108    * Plain Lists::                 Editing hand-formatted lists
109    
110  Tables  Tables
111    
# Line 212  printing and sharing of notes, an Org-mo Line 213  printing and sharing of notes, an Org-mo
213  structured ASCII file, as HTML, or (todo and agenda items only) as an  structured ASCII file, as HTML, or (todo and agenda items only) as an
214  iCalendar file.  iCalendar file.
215    
216  Org-mode keeps simple things simple.  Not every outline branch needs  Org-mode keeps simple things simple.  When first fired up, it should
217  to be an action item, not every action item needs to have priority or  feel like a simple but easy to use outliner.  Complexity is not
218  scheduling information associated with it.  Org-mode can be used on  imposed, but a large amount of functionality is available when you
219  different levels and in different ways, for example  need it.  Org-mode can be used on different levels and in different
220    ways, for example
221    
222  @example  @example
223  @r{@bullet{} as an outline extension with visibility cycling and structure editing}  @r{@bullet{} as an outline extension with visibility cycling and structure editing}
224  @r{@bullet{} as an ASCII system and table editor to take structured notes}  @r{@bullet{} as an ASCII system and table editor to take structured notes}
225  @r{@bullet{} as an ASCII table editor with some spreadsheet-like capabilities}  @r{@bullet{} as an ASCII table editor with spreadsheet-like capabilities}
226  @r{@bullet{} as a simple hypertext system, with HTML export}  @r{@bullet{} as a simple hypertext system, with HTML export}
227  @r{@bullet{} as a TODO list editor}  @r{@bullet{} as a TODO list editor}
228  @r{@bullet{} as a full agenda and planner with deadlines and work scheduling}  @r{@bullet{} as a full agenda and planner with deadlines and work scheduling}
# Line 324  edit the structure of the document. Line 326  edit the structure of the document.
326  * Structure editing::           Changing sequence and level of headlines  * Structure editing::           Changing sequence and level of headlines
327  * Archiving::                   Move done task trees to a different place  * Archiving::                   Move done task trees to a different place
328  * Sparse trees::                Matches embedded in context  * Sparse trees::                Matches embedded in context
329    * Plain Lists::                 Editing hand-formatted lists
330  @end menu  @end menu
331    
332  @node Outlines, Headlines, Document Structure, Document Structure  @node Outlines, Headlines, Document Structure, Document Structure
# Line 347  key. Line 350  key.
350  @cindex outline tree  @cindex outline tree
351    
352  Headlines define the structure of an outline tree.  The Headlines in  Headlines define the structure of an outline tree.  The Headlines in
353  Org-mode start with one or more stars, for example  Org-mode start with one or more stars, on the left margin.  For
354    example
355    
356  @example  @example
357  * Top level headline  * Top level headline
# Line 478  Promote the current subtree by one level Line 482  Promote the current subtree by one level
482  Demote the current subtree by one level  Demote the current subtree by one level
483  @kindex M-S-@key{up}  @kindex M-S-@key{up}
484  @item M-S-@key{up}  @item M-S-@key{up}
485  Move subtree up (swap with previous subtree of same level)  Move subtree up (swap with previous subtree of same
486    level)
487  @kindex M-S-@key{down}  @kindex M-S-@key{down}
488  @item M-S-@key{down}  @item M-S-@key{down}
489  Move subtree down (swap with next subtree of same level)  Move subtree down (swap with next subtree of same level)
# Line 530  this, see the documentation string of th Line 535  this, see the documentation string of th
535  agenda, archiving to a different file is a good way to keep archived  agenda, archiving to a different file is a good way to keep archived
536  trees from contributing agenda items.  trees from contributing agenda items.
537    
538  @node Sparse trees,  , Archiving, Document Structure  @node Sparse trees, Plain Lists, Archiving, Document Structure
539  @section Sparse trees  @section Sparse trees
540  @cindex sparse trees  @cindex sparse trees
541  @cindex trees, sparse  @cindex trees, sparse
# Line 573  Or you can use the command @kbd{C-c C-x Line 578  Or you can use the command @kbd{C-c C-x
578  the document to another file (extension @file{.txt}) which then can be  the document to another file (extension @file{.txt}) which then can be
579  printed in any desired way.  printed in any desired way.
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    
644  @node Tables, Hyperlinks, Document Structure, Top  @node Tables, Hyperlinks, Document Structure, Top
645  @chapter Tables  @chapter Tables
646  @cindex tables  @cindex tables
# Line 2265  exporter implements the following interp Line 2333  exporter implements the following interp
2333  @cindex lists, hand-formatted  @cindex lists, hand-formatted
2334  @item  @item
2335  Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as  Hand-formatted lists with @samp{-}, @samp{*} or @samp{+} as
2336  bullet@footnote{When using @samp{*} as a bullet, lines must be  bullet, or with @samp{1.} or @samp{2)} as enumerator will be recognized and
2337  indented or they will be seen as top-level headlines.}, or  transformed into HTML lists.  See @xref{Plain Lists}.
2338  with @samp{1.}, @samp{2.} as enumerator will be recognized and  
 transformed into HTML lists.  The  
 lists is terminated by the next headline, or by a line that is  
 indented like the bullet/enumerator in the first line, or less.  For  
 example:  
 @example  
 ** Lord of the Rings  
 Some of my favorite scenes are  
 - Eowyns fight  
 - The attack of the Roherim  
   (this may be favorite one)  
 - Peter Jackson being shot by Legolas,  
   in the extended DVD edition only    
 My favorite characters are (in this sequence):  
   1. Sam  
   2. Eowyn  
   3. Aragorn  
 Among the others I don't really have a preference.  
 @end example  
 By default, only no nesting of lists is allowed, but see the variable  
 @code{org-export-local-list-max-depth}.  
2339  @cindex underlined text  @cindex underlined text
2340  @cindex bold text  @cindex bold text
2341  @cindex italic text  @cindex italic text
# Line 2772  Kevin Rogers contributed code to access Line 2820  Kevin Rogers contributed code to access
2820  Juergen Vollmer contributed code generating the table of contents  Juergen Vollmer contributed code generating the table of contents
2821  in HTML output, and other export improvements.  in HTML output, and other export improvements.
2822  @item  @item
2823  Christian Egli converted the documentation into TeXInfo format.  He  Christian Egli converted the documentation into TeXInfo format and
2824  also showed me his plans for a multifile summary for Org-mode. Some of  patched basic CSS formatting support into the HTML exporter.  He also
2825  his ideas have found their way into the agenda.  inspired the agenda by showing me his plans for a multifile summary.
2826  @item  @item
2827  Philip Rooke created the Org-mode reference card.  He also helped with  Philip Rooke created the Org-mode reference card.  He also helped with
2828  beta testing and contributed a number of very useful ideas.  beta testing and contributed a number of very useful ideas.
# Line 2790  Linking to VM/BBDB/GNUS was inspired by Line 2838  Linking to VM/BBDB/GNUS was inspired by
2838  @item  @item
2839  Scheduling TODO items was inspired by John Wiegley's @file{planner.el}.  Scheduling TODO items was inspired by John Wiegley's @file{planner.el}.
2840  @item  @item
2841  Sacha Chua, the current maintainer of Planner, offered linking code  Sacha Chua, the current maintainer of Planner, suggested to copy
2842  from Planner. I made use of the offer for links to RMAIL and Wanderlust.  linking code from Planner (I took code for RMAIL and Wanderlust).
2843  @item  @item
2844  Oliver Oppitz sent several useful suggestions.  Oliver Oppitz made useful suggestions.
2845  @item  @item
2846  Carsten Wimmer suggested some changes and helped fix a bug in linking  Carsten Wimmer suggested some changes and helped fix a bug in linking
2847  to GNUS.  to GNUS.
# Line 2807  Emacs-Lisp compiler happy. Line 2855  Emacs-Lisp compiler happy.
2855  Kai Grossjohann pointed out that a number of key bindings in Org-mode  Kai Grossjohann pointed out that a number of key bindings in Org-mode
2856  conflict with other packages.  conflict with other packages.
2857  @item  @item
2858  Roland Winkler pointed out that additional keybindings are need to use  Roland Winkler pointed out that additional keybindings are needed to
2859  Org-mode on a tty.  use Org-mode on a tty.
2860  @end itemize  @end itemize
2861    
2862  @node Index, Key Index, Miscellaneous, Top  @node Index, Key Index, Miscellaneous, Top

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.27

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26