Show
Ignore:
Timestamp:
08/18/06 08:35:31 (2 years ago)
Author:
miyoshi
Message:

Sync up with Emacs CVS HEAD.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/man/org.texi

    r4131 r4148  
    44@settitle Org Mode Manual 
    55 
    6 @set VERSION 4.43 
    7 @set DATE July 2006 
     6@set VERSION 4.44 
     7@set DATE August 2006 
    88 
    99@dircategory Emacs 
    …… 
    9999 
    100100* Summary::                     Brief summary of what Org-mode does 
    101 * Installation::                How to install Org-mode 
     101* Installation::                How to install a downloaded version of Org-mode 
     102* Activation::                  How to activate Org-mode for certain buffers. 
    102103* Feedback::                    Bug reports, ideas, patches etc. 
    103104 
    …… 
    271272@menu 
    272273* Summary::                     Brief summary of what Org-mode does 
    273 * Installation::                How to install Org-mode 
     274* Installation::                How to install a downloaded version of Org-mode 
     275* Activation::                  How to activate Org-mode for certain buffers. 
    274276* Feedback::                    Bug reports, ideas, patches etc. 
    275277@end menu 
    …… 
    324326@page 
    325327 
    326 @node Installation, Feedback, Summary, Introduction 
    327 @section Installation and Activation 
     328@node Installation, Activation, Summary, Introduction 
     329@section Installation 
    328330@cindex installation 
     331@cindex XEmacs 
     332 
     333@b{Important:} If Org-mode is part of the Emacs distribution or an 
     334XEmacs package, please skip this section and go directly to 
     335@ref{Activation}. 
     336 
     337If you have downloaded Org-mode from the Web, you must take the 
     338following steps to install it: Go into the Org-mode distribution 
     339directory and edit the top section of the file @file{Makefile}.  You 
     340must set the name of the Emacs binary (likely either @file{emacs} or 
     341@file{xemacs}), and the paths to the directories where local Lisp and 
     342Info files are kept.  If you don't have access to the system-wide 
     343directories, create your own two directories for these files, enter them 
     344into the Makefile, and make sure Emacs finds the Lisp files by adding 
     345the following line to @file{.emacs}: 
     346 
     347@example 
     348(setq load-path (cons "~/path/to/lispdir" load-path)) 
     349@end example 
     350 
     351@b{XEmacs users now need to install the file @file{noutline.el} from 
     352the @file{xemacs} subdirectory of the Org-mode distribution.  Use the 
     353command:} 
     354 
     355@example 
     356@b{make install-noutline} 
     357@end example 
     358 
     359@noindent Now byte-compile and install the Lisp files with the shell 
     360commands: 
     361 
     362@example 
     363make 
     364make install 
     365@end example 
     366 
     367@noindent If you want to install the info documentation, use this command: 
     368 
     369@example 
     370make install-info 
     371@end example 
     372 
     373@noindent Then add to @file{.emacs}: 
     374 
     375@lisp 
     376;; This line only if org-mode is not part of the X/Emacs distribution. 
     377(require 'org-install) 
     378@end lisp 
     379 
     380@node Activation, Feedback, Installation, Introduction 
     381@section Activation 
     382@cindex activation 
    329383@cindex autoload 
    330384@cindex global keybindings 
    331385@cindex keybindings, global 
    332386 
    333 If Org-mode is part of the Emacs distribution or an XEmacs package, 
    334 you only need to copy the following lines to your @file{.emacs} file. 
    335 The last two lines define @emph{global} keys for the commands 
    336 @command{org-store-link} and @command{org-agenda} - please 
    337 choose suitable keys yourself. 
     387Add the following lines to your @file{.emacs} file.  The last two lines 
     388define @emph{global} keys for the commands @command{org-store-link} and 
     389@command{org-agenda} - please choose suitable keys yourself. 
    338390 
    339391@lisp 
    …… 
    346398Furthermore, you must activate @code{font-lock-mode} in org-mode 
    347399buffers, because significant functionality depends on font-locking being 
    348 active.  You can do this with either one of the following two lines: 
     400active.  You can do this with either one of the following two lines 
     401(XEmacs user must use the second option): 
    349402@lisp 
    350403(global-font-lock-mode 1)                     ; for all buffers 
    …… 
    352405@end lisp 
    353406 
    354 If you have downloaded Org-mode from the Web, you must take additional 
    355 action:  Byte-compile @file{org.el} and @file{org-publish.el} and put 
    356 them together with @file{org-install.el} on your load path.  Then add to 
    357 @file{.emacs}: 
    358  
    359 @lisp 
    360 ;; This line only if org-mode is not part of the X/Emacs distribution. 
    361 (require 'org-install) 
    362 @end lisp 
    363  
    364 If you use Org-mode with XEmacs, you also need to install the file 
    365 @file{noutline.el} from the @file{xemacs} subdirectory of the Org-mode 
    366 distribution. 
    367  
    368407@cindex org-mode, turning on 
    369 With this setup, all files with extension @samp{.org} will be put into 
    370 Org-mode.  As an alternative, make the first line of a file look like 
    371 this: 
     408With this setup, all files with extension @samp{.org} will be put 
     409into Org-mode.  As an alternative, make the first line of a file look 
     410like this: 
    372411 
    373412@example 
    …… 
    379418@code{org-insert-mode-line-in-empty-file}. 
    380419 
    381 @node Feedback,  , Installation, Introduction 
     420@node Feedback,  , Activation, Introduction 
    382421@section Feedback 
    383422@cindex feedback 
    …… 
    827866@end example 
    828867 
    829 Org-mode supports these lists by tuning filling and wrapping commands 
    830 to deal with them correctly.   
     868Org-mode supports these lists by tuning filling and wrapping commands to 
     869deal with them correctly@footnote{Org-mode only changes the filling 
     870settings for Emacs.  For XEmacs, you should use Kyle E. Jones' 
     871@file{filladapt.el}.  To turn is on,  put into @file{.emacs}: 
     872@example 
     873(require 'filladapt) 
     874@end example 
     875}. 
    831876 
    832877The following commands act on items when the cursor is in the first line 
    …… 
    21612206The second possibility is to use TODO keywords to indicate different 
    21622207types of action items.  For example, you might want to indicate that 
    2163 items are for ``work'' or ``home.''  If you are into David Allen's 
     2208items are for ``work'' or ``home''.  If you are into David Allen's 
    21642209@emph{Getting Things DONE}, you might want to use todo types 
    21652210@samp{NEXTACTION}, @samp{WAITING}, @samp{MAYBE}.  Or, when you work 
    …… 
    25482593location where the clock was last started.  It also directly computes 
    25492594the resulting time in inserts it after the time range as @samp{=> 
    2550 HH:MM}. 
     2595HH:MM}.   
     2596@kindex C-c C-y 
     2597@item C-c C-y 
     2598Recompute the time interval after changing one of the time stamps.  This 
     2599is only necessary if you edit the time stamps directly.  If you change 
     2600them with @kbd{S-@key{cursor}} keys, the update is automatic. 
    25512601@kindex C-c C-t 
    25522602@item C-c C-t 
    …… 
    25662616@kindex C-c C-x C-r 
    25672617@item C-c C-x C-r 
    2568 Insert a dynamic block containing a clock report as an org-mode table 
    2569 into the current file. 
     2618Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock 
     2619report as an org-mode table into the current file. 
    25702620@example 
    25712621#+BEGIN: clocktable :maxlevel 2 :emphasize nil 
    …… 
    25792629:maxlevels   @r{Maximum level depth to which times are listed in the table.} 
    25802630:emphasize   @r{When @code{t}, emphasize level one and level two items} 
    2581 @end example 
     2631:block       @r{The time block to consider.  This block is specified relative} 
     2632             @r{to the current time and may be any of these keywords:} 
     2633             @r{@code{today}, @code{yesterday}, @code{thisweek}, @code{lastweek},} 
     2634             @r{@code{thismonth}, @code{lastmonth}, @code{thisyear}, or @code{lastyear}}. 
     2635:tstart      @r{A time string specifying when to start considering times} 
     2636:tend        @r{A time string specifying when to stop considering times} 
     2637@end example 
     2638So to get a clock summary for the current day, you could write 
     2639@example 
     2640#+BEGIN: clocktable :maxlevel 2 :block today 
     2641 
     2642#+END: clocktable 
     2643@end example 
     2644and to use a specific time range you could write@footnote{Note that all 
     2645parameters must be specified in a single line - the line is broken here 
     2646only to fit it onto the manual.} 
     2647@example 
     2648#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"  
     2649                    :tend "<2006-08-10 Thu 12:00>" 
     2650 
     2651#+END: clocktable 
     2652@end example 
     2653@kindex C-u C-c C-x C-u 
     2654@item C-u C-c C-x C-u 
     2655Update all dynamic blocks (@pxref{Dynamic blocks}).  This is useful if 
     2656you have several clocktable blocks in a buffer. 
    25822657@end table 
    25832658 
    …… 
    46544729@cindex @file{cdlatex.el} 
    46554730Org-mode can make use of the cdlatex package to efficiently enter 
    4656 La@TeX{} fragments into Org-mode files. 
    4657 @file{cdlatex.el} is not part of Emacs, find it on the web. 
     4731La@TeX{} fragments into Org-mode files. See @ref{CDLaTeX mode}. 
    46584732@item @file{remember.el} by John Wiegley 
    46594733@cindex @file{remember.el} 
    …… 
    47854859@cindex @file{org-blog.el} 
    47864860@item @file{org-blog.el} by David O'Toole 
    4787 A blogging plug-in for @file{org-publish.el}. 
     4861A blogging plug-in for @file{org-publish.el}.@* 
    47884862@url{http://dto.freeshell.org/notebook/OrgMode.html}. 
    47894863@cindex @file{org-blogging.el} 
    …… 
    48064880 
    48074881@example 
    4808 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ..... 
     4882#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... 
    48094883 
    48104884#+END: