Mercurial > emacs

--- a/man/org.texi	Wed Mar 30 12:37:36 2005 +0000
+++ b/man/org.texi	Wed Mar 30 12:42:09 2005 +0000
@@ -3,8 +3,8 @@
 @setfilename ../info/org
 @settitle Org Mode Manual

-@set VERSION 3.04
-@set DATE December 2004
+@set VERSION 3.05
+@set DATE April 2005

 @dircategory Emacs
 @direntry
@@ -34,7 +34,7 @@
 @copying
 This manual is for Org-mode (version @value{VERSION}).

-Copyright @copyright{} 2004 Free Software Foundation
+Copyright @copyright{} 2004, 2005 Free Software Foundation

 @quotation
 Permission is granted to copy, distribute and/or modify this document
@@ -184,7 +184,8 @@
 large files well structured.  Visibility cycling and structure editing
 help to work with the tree.  Tables are easily created with a built-in
 table editor.  Org-mode supports ToDo items, deadlines, time stamps,
-and scheduling.  It dynamically compiles entries into an agenda.
+and scheduling.  It dynamically compiles entries into an agenda that
+utilizes and smoothly integrates much of the Emacs calendar and diary.
 Plain text URL-like links connect to websites, emails, usenet
 messages, BBDB entries, and any files related to the projects.  For
 printing and sharing of notes, an Org-mode file can be exported as a
@@ -203,15 +204,14 @@
 @r{@bullet{} as a full agenda and planner with deadlines and work scheduling}
 @end example

-The Org-mode table editor can be used integrated into any major mode
-by activating the minor Ortbl-mode.
+The Org-mode table editor can be integrated into any major mode by
+activating the minor Orgtbl-mode.

 There is a website for Org-mode which provides links to the newest
 version of Org-mode, as well as additional information, screen shots
 and example files.  This page is located at
 @uref{http://www.astro.uva.nl/~dominik/Tools/org/}.

-
 @page

 @node Installation,  , Summary, Introduction
@@ -352,6 +352,18 @@
 Show all.
 @end table

+When Emacs firsts visits a Org-mode file, the global state is set to
+OVERVIEW, i.e. only the top level headlines are visible.  This can be
+configured through the variable @code{org-startup-folded}, or on a
+per-file basis by adding one of the following lines anywhere in the
+buffer:
+
+@example
+#+STARTUP: fold
+#+STARTUP: nofold
+@end example
+
+
 @node Motion, Structure editing, Visibility cycling, Document Structure
 @section Motion
 @cindex motion, between headlines
@@ -473,6 +485,17 @@
 Other commands are using this feature as well.  For example @kbd{C-c
 C-v} creates a sparse TODO tree (@pxref{TODO basics}).

+@kindex C-c C-x v
+@cindex printing sparse trees
+@cindex visible text, printing
+To print a sparse tree, you can use the Emacs command
+@code{ps-print-buffer-with-faces} which does not print invisible parts
+of the document @footnote{this does not work under XEmacs, because
+XEmacs uses selective display for outlining, not text properties}.
+Or you can use the command @kbd{C-c C-x v} to copy the visible part of
+the document to another file (extension @file{.txt}) which then can be
+printed in any desired way.
+
 @node TODO items, Tables, Document Structure, Top
 @chapter TODO items
 @cindex TODO items
@@ -611,7 +634,7 @@
 @end lisp

 In this case, different keywords do not indicate a sequence, but
-rather different levels.  This changes the behavior of the command
+rather different types.  This changes the behavior of the command
 @kbd{C-c C-t} slightly.  When used several times in succession, it
 will still cycle through all names.  But when when you return to the
 item after some time and execute @kbd{C-c C-t} again, it will switch
@@ -745,11 +768,6 @@
 necessary.  At the beginning or end of a line, @key{RET} still does
 NEWLINE, so it can be used to split a table.

-@kindex S-@key{RET}
-@item S-@key{RET}
-Copy from first non-empty
- field above current field.
-
 @tsubheading{Column and row editing}
 @kindex M-@key{left}
 @kindex M-@key{right}
@@ -796,7 +814,7 @@
 blank all fields in the rectangle.
 @kindex C-c C-h C-y
 @item C-c C-h C-y
-Paste a rectangluar region into a table.
+Paste a rectangular region into a table.
 The upper right corner ends up in the current field.  All involved fields
 will be overwritten.  If the rectangle does not fit into the present table,
 the table is enlarged as needed.  The process ignores horizontal separator
@@ -828,6 +846,14 @@
 the active region.  The result is displayed in the echo area and can
 be inserted with @kbd{C-y}.

+@kindex S-@key{RET}
+@item S-@key{RET}
+When current field is empty, copy from first non-empty field above.
+When not empty, copy current field down to next row and move cursor
+along with it.  Depending on the variable
+@code{org-table-copy-increment}, integer field values will be
+incremented during copy.
+
 @cindex formula, in tables
 @cindex calculations, in tables
 @kindex C-c =
@@ -1063,7 +1089,7 @@
 If not, a headline is constructed from the current date and some
 additional data.  If the variable @code{org-adapt-indentation} is
 non-nil, the entire text is also indented so that it starts in the
-same column as the headline (after the asterixes).
+same column as the headline (after the asterisks).

 @node Timestamps, Timeline and Agenda, Hyperlinks, Top
 @chapter Timestamps
@@ -1404,11 +1430,12 @@
 @node Agenda commands, Calendar/Diary integration, Agenda (multiple files), Timeline and Agenda
 @section Commands in the agenda buffer

-Entries in the agenda buffer are linked back to the org file.  You are
-not allowed to edit the agenda buffer itself, but commands are provided
-to edit the org-files ``remotely'' from the agenda buffer.  In this
-way, all information is stored only once, and you don't risk that your
-agenda and note files diverge.
+Entries in the agenda buffer are linked back to the org file or diary
+file where they originate.  You are not allowed to edit the agenda
+buffer itself, but commands are provided to show and jump to the
+original entry location, and to edit the org-files ``remotely'' from
+the agenda buffer.  In this way, all information is stored only once,
+and you don't risk that your agenda and note files diverge.

 Some commands can be executed with mouse clicks on agenda lines.  For
 the other commands, the cursor needs to be in the desired line.  Most
@@ -1468,7 +1495,7 @@
 Display the following @code{org-agenda-ndays} days.  For example, if
 the display covers a week, switch to the following week.  With prefix
 arg, go forward that many times @code{org-agenda-ndays} days.  Not
-available in timlines.
+available in timelines.

 @kindex @key{left}
 @item @key{left}
@@ -1536,6 +1563,29 @@
 entry in the diary, just like @kbd{i d} etc. would do in the calendar.
 The date is taken from the cursor position.

+@tsubheading{Calendar commands}
+@kindex c
+@item c
+Open the Emacs calendar and move to the date at the agenda cursor.
+
+@kindex C
+@item C
+Convert the date at cursor into many other cultural and historic
+calendars.
+
+@kindex M
+@item M
+Show the phases of the moon for three month around current date.
+
+@kindex S
+@item S
+Show sunrise and sunset times.  The location must be set with calendar
+variables, see documentation of the Emacs calendar.
+
+@kindex H
+@item H
+Show holidays for three month around the cursor date.
+
 @tsubheading{Quit and Exit}
 @kindex q
 @item q
@@ -1564,8 +1614,9 @@
 the diary.

 The interaction between Org-mode and diary works both ways: You can
-list entries from the diary in the Org-mode agenda, or you can display
-entries from the org agenda in the Emacs diary.
+list entries from the diary in the Org-mode agenda, from which many
+calendar and diary commands are directly accessible.  Or you can
+display entries from the org agenda in the Emacs diary.

 @menu
 * Diary to agenda::             Agenda incorporates the diary
@@ -1584,7 +1635,15 @@
 @end lisp
 @noindent

-@noindent After that, everything will happen automatically.
+@noindent After that, everything will happen automatically.  All diary
+entries including holidays, anniversaries etc will be included in the
+agenda buffer created by Org-mode.  @key{SPC}, @key{TAB}, and
+@key{RET} can be used from the agenda buffer to jump to the diary
+file, in order to edit existing diary entries.  Also the @kbd{i}
+command to insert new entries for the current date works in the agenda
+buffer, as well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to
+display Sunrise/Sunset times, show lunar phases and to convert to
+other calendars, respectively.

 @node Agenda to diary,  , Diary to agenda, Calendar/Diary integration
 @subsection Including the agenda into the diary