* Re: Status of Org-mode in GNU Emacs
2006-03-20 4:27 ` Carsten Dominik
@ 2006-03-23 21:08 ` Philip Rooke
2006-03-24 7:07 ` Carsten Dominik
0 siblings, 1 reply; 5+ messages in thread
From: Philip Rooke @ 2006-03-23 21:08 UTC (permalink / raw)
To: Carsten Dominik; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 123 bytes --]
Carsten Dominik <dominik@science.uva.nl> writes:
> Absolutely.
>
> - Carsten
OK. Details of suggested changes attached.
[-- Attachment #2: Context diff of proposed changes to org.texi --]
[-- Type: text/plain, Size: 45703 bytes --]
*** org.texi 2006-03-22 06:15:48.000000000 +0000
--- org.texi.phil 2006-03-23 19:52:15.000000000 +0000
***************
*** 94,100 ****
Introduction
* Summary:: Brief summary of what Org-mode does
! * Installation and Activation:: How to install Org-mode
* Feedback:: Bug reports, ideas, patches etc.
Document Structure
--- 94,100 ----
Introduction
* Summary:: Brief summary of what Org-mode does
! * Installation and activation:: How to install Org-mode
* Feedback:: Bug reports, ideas, patches etc.
Document Structure
***************
*** 127,134 ****
Hyperlinks
! * Internal Links:: Links to other places in the current file
! * External Links:: URL-like links to the world
* Managing links:: Creating, inserting and following
* Search Options:: Linking to a specific location
* Remember:: Org-trees store quick notes
--- 127,134 ----
Hyperlinks
! * Internal links:: Links to other places in the current file
! * External links:: URL-like links to the world
* Managing links:: Creating, inserting and following
* Search Options:: Linking to a specific location
* Remember:: Org-trees store quick notes
***************
*** 141,147 ****
TODO items
* TODO basics:: Marking and displaying TODO entries
! * Progress Logging:: Document your productivity
* TODO extensions:: Workflow and assignments
* Priorities:: Some things are more important than others
--- 141,147 ----
TODO items
* TODO basics:: Marking and displaying TODO entries
! * Progress logging:: Document your productivity
* TODO extensions:: Workflow and assignments
* Priorities:: Some things are more important than others
***************
*** 205,211 ****
@menu
* Summary:: Brief summary of what Org-mode does
! * Installation and Activation:: How to install Org-mode
* Feedback:: Bug reports, ideas, patches etc.
@end menu
--- 205,211 ----
@menu
* Summary:: Brief summary of what Org-mode does
! * Installation and activation:: How to install Org-mode
* Feedback:: Bug reports, ideas, patches etc.
@end menu
***************
*** 234,240 ****
feel like a simple but easy to use outliner. Complexity is not
imposed, but a large amount of functionality is available when you
need it. Org-mode can be used on different levels and in different
! ways, for example
@example
@r{@bullet{} as an outline extension with visibility cycling and structure editing}
--- 234,240 ----
feel like a simple but easy to use outliner. Complexity is not
imposed, but a large amount of functionality is available when you
need it. Org-mode can be used on different levels and in different
! ways, for example:
@example
@r{@bullet{} as an outline extension with visibility cycling and structure editing}
***************
*** 301,307 ****
@noindent which will select Org-mode for this buffer no matter what
the file's name is. See also the variable
! @code{org-insert-mode-line-in-empty-file'}.
@node Feedback, , Installation and Activation, Introduction
@section Feedback
--- 301,307 ----
@noindent which will select Org-mode for this buffer no matter what
the file's name is. See also the variable
! @code{org-insert-mode-line-in-empty-file}.
@node Feedback, , Installation and Activation, Introduction
@section Feedback
***************
*** 367,375 ****
@cindex headlines
@cindex outline tree
! Headlines define the structure of an outline tree. The Headlines in
Org-mode start with one or more stars, on the left margin. For
! example
@example
* Top level headline
--- 367,375 ----
@cindex headlines
@cindex outline tree
! Headlines define the structure of an outline tree. The headlines in
Org-mode start with one or more stars, on the left margin. For
! example:
@example
* Top level headline
***************
*** 499,521 ****
Insert new TODO entry with same level as current heading.
@kindex M-@key{left}
@item M-@key{left}
! Promote current heading by one level
@kindex M-@key{right}
@item M-@key{right}
! Demote current heading by one level
@kindex M-S-@key{left}
@item M-S-@key{left}
! Promote the current subtree by one level
@kindex M-S-@key{right}
@item M-S-@key{right}
! Demote the current subtree by one level
@kindex M-S-@key{up}
@item M-S-@key{up}
Move subtree up (swap with previous subtree of same
! level)
@kindex M-S-@key{down}
@item M-S-@key{down}
! Move subtree down (swap with next subtree of same level)
@kindex C-c C-x C-w
@kindex C-c C-x C-k
@item C-c C-x C-w
--- 499,521 ----
Insert new TODO entry with same level as current heading.
@kindex M-@key{left}
@item M-@key{left}
! Promote current heading by one level.
@kindex M-@key{right}
@item M-@key{right}
! Demote current heading by one level.
@kindex M-S-@key{left}
@item M-S-@key{left}
! Promote the current subtree by one level.
@kindex M-S-@key{right}
@item M-S-@key{right}
! Demote the current subtree by one level.
@kindex M-S-@key{up}
@item M-S-@key{up}
Move subtree up (swap with previous subtree of same
! level).
@kindex M-S-@key{down}
@item M-S-@key{down}
! Move subtree down (swap with next subtree of same level).
@kindex C-c C-x C-w
@kindex C-c C-x C-k
@item C-c C-x C-w
***************
*** 602,608 ****
use the variable @code{org-agenda-custom-commands} to define fast
keyboard access to specific sparse trees. These commands will then be
accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
! For example
@lisp
(setq org-agenda-custom-commands
'(("f" occur-tree "FIXME")))
--- 602,608 ----
use the variable @code{org-agenda-custom-commands} to define fast
keyboard access to specific sparse trees. These commands will then be
accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
! For example:
@lisp
(setq org-agenda-custom-commands
'(("f" occur-tree "FIXME")))
***************
*** 621,627 ****
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 Tags, Plain Lists, Sparse trees, Document Structure
--- 621,627 ----
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 can then be
printed in any desired way.
@node Tags, Plain Lists, Sparse trees, Document Structure
***************
*** 692,698 ****
A tags search string can use Boolean operators @samp{&} for AND and
@samp{|} for OR. @samp{&} binds more strongly than
! @samp{|}. Parenthesis are currently no implemented. A tag may also be
preceded by @samp{-}, to select against it, and @samp{+} is syntactic
sugar for positive selection. The AND operator @samp{&} is optional
when @samp{+} or @samp{-} is present. For example, @samp{+WORK-BOSS}
--- 692,698 ----
A tags search string can use Boolean operators @samp{&} for AND and
@samp{|} for OR. @samp{&} binds more strongly than
! @samp{|}. Parenthesis are currently not implemented. A tag may also be
preceded by @samp{-}, to select against it, and @samp{+} is syntactic
sugar for positive selection. The AND operator @samp{&} is optional
when @samp{+} or @samp{-} is present. For example, @samp{+WORK-BOSS}
***************
*** 709,717 ****
@cindex lists, ordered
@cindex ordered lists
! Headlines define the structure of the Org-mode file, and also lists
! (for example TODO items (@pxref{TODO items}) should be created using
! headline levels. However, when taking notes, the plain text is
sometimes easier to read with hand-formatted lists. Org-mode supports
editing such lists, and the HTML exporter (@pxref{Exporting}) does
parse and format them.
--- 709,717 ----
@cindex lists, ordered
@cindex ordered lists
! Headlines define both the structure of the Org-mode file, and also lists
! (for example, TODO items (@pxref{TODO items}) should be created using
! headline levels). However, when taking notes, the plain text is
sometimes easier to read with hand-formatted lists. Org-mode supports
editing such lists, and the HTML exporter (@pxref{Exporting}) does
parse and format them.
***************
*** 721,731 ****
bullet, lines must be indented or they will be seen as top-level
headlines. Also, when you are hiding leading stars to get a clean
outline view, plain list items starting with a star are visually
! indistinguishable from true headlines. In short: Even though @samp{*}
is supported, it may be better to not use it for plain list items} as
bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items
belonging to the same list must have the same indentation on the first
! line. In particular, if an ordered list reaches number @samp{10.}, also
the 2--digit numbers must be written left-aligned with the other numbers
in the list. Indentation also determines the end of a list item. It
ends before the next line that is indented like the bullet/number, or
--- 721,731 ----
bullet, lines must be indented or they will be seen as top-level
headlines. Also, when you are hiding leading stars to get a clean
outline view, plain list items starting with a star are visually
! indistinguishable from true headlines. In short: even though @samp{*}
is supported, it may be better to not use it for plain list items} as
bullets. Ordered list items start with @samp{1.} or @samp{1)}. Items
belonging to the same list must have the same indentation on the first
! line. In particular, if an ordered list reaches number @samp{10.}, then
the 2--digit numbers must be written left-aligned with the other numbers
in the list. Indentation also determines the end of a list item. It
ends before the next line that is indented like the bullet/number, or
***************
*** 844,857 ****
Creates an empty Org-mode table. However, it is much easier to just
start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}
! @kindex C-c C-c
! @item C-c C-c
! Convert region to table. Works when the cursor is not in an existing
! table, and when there is a region defined. If every line contains at
! least one TAB character, the function assumes that the material is tab
! separated. If not, lines are split at whitespace into fields. You
! can use a prefix argument to indicate how many consecutive spaces are
! at least required to indicate a field separator (default: just one).
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
--- 844,856 ----
Creates an empty Org-mode table. However, it is much easier to just
start typing, like @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}
! @kindex C-c C-c @item C-c C-c Convert region to table. Works when the
! cursor is not in an existing table, and when there is a region
! defined. If every line contains at least one TAB character, the
! function assumes that the material is tab separated. If not, lines
! are split at whitespace into fields. You can use a prefix argument to
! indicate the minimum number of consecutive spaces required to identify
! a field separator (default: just one).
@tsubheading{Re-aligning and field motion}
@kindex C-c C-c
***************
*** 878,884 ****
@kindex M-@key{right}
@item M-@key{left}
@itemx M-@key{right}
! Move the current column left/right
@kindex M-S-@key{left}
@item M-S-@key{left}
--- 877,883 ----
@kindex M-@key{right}
@item M-@key{left}
@itemx M-@key{right}
! Move the current column left/right.
@kindex M-S-@key{left}
@item M-S-@key{left}
***************
*** 892,898 ****
@kindex M-@key{down}
@item M-@key{up}
@itemx M-@key{down}
! Move the current row up/down
@kindex M-S-@key{up}
@item M-S-@key{up}
--- 891,897 ----
@kindex M-@key{down}
@item M-@key{up}
@itemx M-@key{down}
! Move the current row up/down.
@kindex M-S-@key{up}
@item M-S-@key{up}
***************
*** 940,946 ****
is no region, the current field is split at the cursor position and the
text fragment to the right of the cursor is prepended to the field one
line down. If there is no region, but you specify a prefix ARG, the
! current field gets blank, and the content is appended to the field
above.
@tsubheading{Calculations}
--- 939,945 ----
is no region, the current field is split at the cursor position and the
text fragment to the right of the cursor is prepended to the field one
line down. If there is no region, but you specify a prefix ARG, the
! current field is made blank, and the content is appended to the field
above.
@tsubheading{Calculations}
***************
*** 1008,1027 ****
@item M-x org-table-import
Import a file as a table. The table should be TAB- or whitespace
! separated. Useful for example to import an Excel table or data from a
database, because these programs generally can write TAB-separated text
files. This command works by inserting the file into the buffer and
then converting the region to a table. Any prefix argument is passed on
to the converter, which uses it to determine the separator.
@item M-x org-table-export
! Export the table as a TAB-separated file. Useful for data exchange with
! for example Excel or database programs.
@end table
! If you don't like the automatic table editor because it gets into your
! way in lines which you would like to start with @samp{|}, you can turn
it off with
@lisp
(setq org-enable-table-editor nil)
--- 1007,1026 ----
@item M-x org-table-import
Import a file as a table. The table should be TAB- or whitespace
! separated. Useful, for example, to import an Excel table or data from a
database, because these programs generally can write TAB-separated text
files. This command works by inserting the file into the buffer and
then converting the region to a table. Any prefix argument is passed on
to the converter, which uses it to determine the separator.
@item M-x org-table-export
! Export the table as a TAB-separated file. Useful for data exchange with,
! for example, Excel or database programs.
@end table
! If you don't like the automatic table editor because it gets in your
! way on lines which you would like to start with @samp{|}, you can turn
it off with
@lisp
(setq org-enable-table-editor nil)
***************
*** 1062,1068 ****
A formula can be any algebraic expression understood by the Emacs
@file{calc} package. Note that @file{calc} has the slightly
! non-standard conversion that @samp{/} has lower precedence than
@samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}. Before
evaluation by @code{calc-eval} (@pxref{Calling Calc from Your Lisp
Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU Emacs
--- 1061,1067 ----
A formula can be any algebraic expression understood by the Emacs
@file{calc} package. Note that @file{calc} has the slightly
! non-standard convention that @samp{/} has lower precedence than
@samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}. Before
evaluation by @code{calc-eval} (@pxref{Calling Calc from Your Lisp
Programs,calc-eval,Calling calc from Your Lisp Programs,calc,GNU Emacs
***************
*** 1091,1097 ****
@code{org-table-formula-constants}. If you have the
@file{constants.el} package, it will also be used to resolve
constants, including natural constants like @samp{$h} for Planck's
! constant, units like @samp{$km} for kilometers. Column names and
parameters can be specified in special table lines. These are
described below, see @ref{Advanced features}.
--- 1090,1096 ----
@code{org-table-formula-constants}. If you have the
@file{constants.el} package, it will also be used to resolve
constants, including natural constants like @samp{$h} for Planck's
! constant, and units like @samp{$km} for kilometers. Column names and
parameters can be specified in special table lines. These are
described below, see @ref{Advanced features}.
***************
*** 1106,1112 ****
@code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to
switch the internal precision to 20 digits, @samp{n3}, @samp{s3},
@samp{e2} or @samp{f4} to switch to normal, scientific, engineering,
! or fix display format, respectively, and @samp{D}, @samp{R}, @samp{F},
and @samp{S} to turn on degrees, radians, fraction and symbolic modes,
respectively. In addition, you may provide a @code{printf} format
specifier to reformat the final result. A few examples:
--- 1105,1111 ----
@code{org-calc-default-modes}.} during execution, e.g. @samp{p20} to
switch the internal precision to 20 digits, @samp{n3}, @samp{s3},
@samp{e2} or @samp{f4} to switch to normal, scientific, engineering,
! or fixed display format, respectively, and @samp{D}, @samp{R}, @samp{F},
and @samp{S} to turn on degrees, radians, fraction and symbolic modes,
respectively. In addition, you may provide a @code{printf} format
specifier to reformat the final result. A few examples:
***************
*** 1120,1126 ****
tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
vmean($2..$7) @r{Compute column range mean, using vector function}
! vsum(&III) @r{Sum numbers from 3rd hline above to here}
taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
@end example
--- 1119,1125 ----
tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
vmean($2..$7) @r{Compute column range mean, using vector function}
! vsum(&III) @r{Sum numbers from 3rd hline above here}
taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
@end example
***************
*** 1164,1170 ****
@node Advanced features, Named-field formulas, Column formulas, Table calculations
@subsection Advanced features
! If you want want the recalculation of fields to happen automatically,
or if you want to be able to assign a formula to an individual field
(instead of an entire column) you need to reserve the first column of
the table for special marking characters. Here is an example of a
--- 1163,1169 ----
@node Advanced features, Named-field formulas, Column formulas, Table calculations
@subsection Advanced features
! If you want the recalculation of fields to happen automatically,
or if you want to be able to assign a formula to an individual field
(instead of an entire column) you need to reserve the first column of
the table for special marking characters. Here is an example of a
***************
*** 1192,1198 ****
@end example
@noindent @b{Important}: Please note that for these special tables,
! recalculating the table with @kbd{C-u C-c *} does only affect rows
which are marked @samp{#} or @samp{*}, and named fields. The column
formulas are not applied in rows with empty first field.
--- 1191,1197 ----
@end example
@noindent @b{Important}: Please note that for these special tables,
! recalculating the table with @kbd{C-u C-c *} will only affect rows
which are marked @samp{#} or @samp{*}, and named fields. The column
formulas are not applied in rows with empty first field.
***************
*** 1227,1233 ****
not for automatic recalculation. Use this when automatic
recalculation slows down editing too much.
@item
! Unmarked lines are exempted from recalculation with @kbd{C-u C-c *}.
All lines that should be recalculated should be marked with @samp{#}
or @samp{*}.
@end table
--- 1226,1232 ----
not for automatic recalculation. Use this when automatic
recalculation slows down editing too much.
@item
! Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
All lines that should be recalculated should be marked with @samp{#}
or @samp{*}.
@end table
***************
*** 1240,1246 ****
A named field can have its own formula associated with it. In the
example above, this is used for the @samp{at} field that contains
the average result of the students. To enter a formula for a named
! field, just type it onto the buffer, preceded by @samp{:=}. Or use
@kbd{C-u C-c =}. This equation will be stored below the table like
@samp{$name=...}. Any recalculation in the table (even if only
requested for the current line) will also update all named field
--- 1239,1245 ----
A named field can have its own formula associated with it. In the
example above, this is used for the @samp{at} field that contains
the average result of the students. To enter a formula for a named
! field, just type it into the buffer, preceded by @samp{:=}. Or use
@kbd{C-u C-c =}. This equation will be stored below the table like
@samp{$name=...}. Any recalculation in the table (even if only
requested for the current line) will also update all named field
***************
*** 1251,1259 ****
@cindex formula editing
@cindex editing, of table formulas
! To edit a column or field formula, you can use the commands @kbd{C-c
=} and @kbd{C-u C-c =}, respectively. The currently active expression
! is then presented as default in the minibuffer, were it may be edited.
Note that making a table field blank does not remove the formula
associated with the field - during the next recalculation the field
--- 1250,1258 ----
@cindex formula editing
@cindex editing, of table formulas
! To edit a column or field formula, you can the commands @kbd{C-c
=} and @kbd{C-u C-c =}, respectively. The currently active expression
! is then presented as default in the minibuffer, where it may be edited.
Note that making a table field blank does not remove the formula
associated with the field - during the next recalculation the field
***************
*** 1284,1290 ****
becomes the string @samp{#ERROR}. If you would like see what is going
on during variable substitution and calculation in order to find a
bug, turn on formula debugging in the menu and repeat the calculation
! by pressing, for example by pressing @kbd{C-c = @key{RET}} in a field.
Detailed information will be displayed.
@node Appetizer, , Editing/debugging formulas, Table calculations
--- 1283,1289 ----
becomes the string @samp{#ERROR}. If you would like see what is going
on during variable substitution and calculation in order to find a
bug, turn on formula debugging in the menu and repeat the calculation
! by pressing, for example, by pressing @kbd{C-c = @key{RET}} in a field.
Detailed information will be displayed.
@node Appetizer, , Editing/debugging formulas, Table calculations
***************
*** 1391,1397 ****
with a star like @samp{*My Target} restrict the search to headlines.
When searching, Org-mode will first try an exact match, but then move
on to more and more lenient searches. For example, the link
! @samp{[[*My Targets]]} will find any of the following
@example
** My targets
** TODO my targets are bright
--- 1390,1396 ----
with a star like @samp{*My Target} restrict the search to headlines.
When searching, Org-mode will first try an exact match, but then move
on to more and more lenient searches. For example, the link
! @samp{[[*My Targets]]} will find any of the following:
@example
** My targets
** TODO my targets are bright
***************
*** 1506,1512 ****
which can be used in any buffer to create a link. The link will be
stored for later insertion into an Org-mode buffer (see below). For
VM, RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to
! the current article/entry. For W3 and W3M buffer, the link goes to
the current URL. For Org-mode files, the current headline is
targeted. For any other files, the link will point to the file, with
a search string (@pxref{Search Options}) pointing to the
--- 1505,1511 ----
which can be used in any buffer to create a link. The link will be
stored for later insertion into an Org-mode buffer (see below). For
VM, RMAIL, WANDERLUST, GNUS and BBDB buffers, the link will point to
! the current article/entry. For W3 and W3M buffers, the link goes to
the current URL. For Org-mode files, the current headline is
targeted. For any other files, the link will point to the file, with
a search string (@pxref{Search Options}) pointing to the
***************
*** 1546,1552 ****
only. See option @code{org-file-apps}. If there is no link at point,
the current subtree will be searched for one. If you want to override
the default application and visit the file with Emacs, use a @kbd{C-u}
! prefix. If the cursor is on a time stamp, compiles the agenda for
that date.
@strong{IMPORTANT}: Be careful not to use any dangerous commands in a
--- 1545,1551 ----
only. See option @code{org-file-apps}. If there is no link at point,
the current subtree will be searched for one. If you want to override
the default application and visit the file with Emacs, use a @kbd{C-u}
! prefix. If the cursor is on a time stamp, it compiles the agenda for
that date.
@strong{IMPORTANT}: Be careful not to use any dangerous commands in a
***************
*** 1740,1746 ****
@section Basic TODO functionality
Any headline can become a TODO item by starting it with the word TODO,
! for example
@example
*** TODO Write letter to Sam Fortune
--- 1739,1745 ----
@section Basic TODO functionality
Any headline can become a TODO item by starting it with the word TODO,
! for example:
@example
*** TODO Write letter to Sam Fortune
***************
*** 1822,1828 ****
@cindex workflow states as TODO keywords
You can use TODO keywords to indicate different states in the process
! of working on an item, for example
@lisp
(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
--- 1821,1827 ----
@cindex workflow states as TODO keywords
You can use TODO keywords to indicate different states in the process
! of working on an item, for example:
@lisp
(setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
***************
*** 1870,1878 ****
You can also review the items of a specific TODO type in a sparse tree
by using a numeric prefix to @kbd{C-c C-v}. For example, to see all
things Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect
! collect Lucy's items from all agenda files into a single buffer, you
! would use the prefix arg as well when creating the global todo list:
! @kbd{C-3 C-c t}.
@node Per file keywords, , TODO types, TODO extensions
@subsection Setting up TODO keywords for individual files
--- 1869,1877 ----
You can also review the items of a specific TODO type in a sparse tree
by using a numeric prefix to @kbd{C-c C-v}. For example, to see all
things Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect
! Lucy's items from all agenda files into a single buffer, you would use
! the prefix arg as well when creating the global todo list: @kbd{C-3
! C-c t}.
@node Per file keywords, , TODO types, TODO extensions
@subsection Setting up TODO keywords for individual files
***************
*** 1979,1986 ****
A time stamp is a specification of a date (possibly with time) in a
special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16
Tue 09:39>}. A time stamp can appear anywhere in the headline or body
! of an org-tree entry. Its presence allows to show entries on specific
! dates in the agenda (@pxref{Weekly/Daily Agenda}). We distinguish:
@table @var
@cindex timestamp
--- 1978,1986 ----
A time stamp is a specification of a date (possibly with time) in a
special format, either @samp{<2003-09-16 Tue>} or @samp{<2003-09-16
Tue 09:39>}. A time stamp can appear anywhere in the headline or body
! of an org-tree entry. Its presence allows entries to be shown on
! specific dates in the agenda (@pxref{Weekly/Daily Agenda}). We
! distinguish:
@table @var
@cindex timestamp
***************
*** 2045,2051 ****
@kindex C-u C-c .
@item C-u C-c .
Like @kbd{C-c .}, but use the alternative format which contains date
! and time. The default time can be rounded to to multiples of 5 minutes,
see the option @code{org-time-stamp-rounding-minutes}.
@kindex C-c !
--- 2045,2051 ----
@kindex C-u C-c .
@item C-u C-c .
Like @kbd{C-c .}, but use the alternative format which contains date
! and time. The default time can be rounded to multiples of 5 minutes,
see the option @code{org-time-stamp-rounding-minutes}.
@kindex C-c !
***************
*** 2231,2237 ****
The views are created through a dispatcher that should be bound to a
global key, for example @kbd{C-c a} (@pxref{Installation and
Activation}). In the following we will assume that @kbd{C-c a} is
! indeed how the dispatcher is accessed and list keyboard access to
commands accordingly. After pressing @kbd{C-c a}, an additional
letter is required to execute a command. The dispatcher offers the
following default commands:
--- 2231,2237 ----
The views are created through a dispatcher that should be bound to a
global key, for example @kbd{C-c a} (@pxref{Installation and
Activation}). In the following we will assume that @kbd{C-c a} is
! indeed how the dispatcher is accessed and lists keyboard access to
commands accordingly. After pressing @kbd{C-c a}, an additional
letter is required to execute a command. The dispatcher offers the
following default commands:
***************
*** 2241,2247 ****
@item t / T
Create a list of all TODO items (@pxref{Global TODO list}).
@item m / M
! Create a list of headline matching a TAGS expression (@pxref{Matching
headline tags}).
@end table
--- 2241,2247 ----
@item t / T
Create a list of all TODO items (@pxref{Global TODO list}).
@item m / M
! Create a list of headlines matching a TAGS expression (@pxref{Matching
headline tags}).
@end table
***************
*** 2265,2271 ****
("f" occur-tree "\\<FIXME\\>")))
@end lisp
@noindent will define @kbd{C-c a w} as a global search for
! TODO entries with @samp{WAITING} as todo keyword, @kbd{C-c a u} as a
global tags search for headlines marked @samp{:BOSS:} but not
@samp{:URGENT:}, @kbd{C-c a U} to do the same search but only in the
current buffer and display the result as a sparse tree, and @kbd{C-c a
--- 2265,2271 ----
("f" occur-tree "\\<FIXME\\>")))
@end lisp
@noindent will define @kbd{C-c a w} as a global search for
! TODO entries with @samp{WAITING} as the TODO keyword, @kbd{C-c a u} as a
global tags search for headlines marked @samp{:BOSS:} but not
@samp{:URGENT:}, @kbd{C-c a U} to do the same search but only in the
current buffer and display the result as a sparse tree, and @kbd{C-c a
***************
*** 2287,2297 ****
Compile an agenda for the current week from a list of org files. The
agenda shows the entries for each day. With a @kbd{C-u} prefix (or
when the variable @code{org-agenda-include-all-todo} is @code{t}), all
! unfinished TODO items (also those without a date) are also listed at
the beginning of the buffer, before the first date.@*
@end table
! Remote editing from the agenda buffer means for example that you can
change the dates of deadlines and appointments from the agenda buffer.
The commands available in the Agenda buffer are listed in @ref{Agenda
commands}.
--- 2287,2297 ----
Compile an agenda for the current week from a list of org files. The
agenda shows the entries for each day. With a @kbd{C-u} prefix (or
when the variable @code{org-agenda-include-all-todo} is @code{t}), all
! unfinished TODO items (including those without a date) are also listed at
the beginning of the buffer, before the first date.@*
@end table
! Remote editing from the agenda buffer means, for example, that you can
change the dates of deadlines and appointments from the agenda buffer.
The commands available in the Agenda buffer are listed in @ref{Agenda
commands}.
***************
*** 2372,2378 ****
Emacs contains the calendar and diary by Edward M. Reingold. The
calendar displays a three-month calendar with holidays from different
! countries and cultures. The diary allows to keep track of
anniversaries, lunar phases, sunrise/set, recurrent appointments
(weekly, monthly) and more. In this way, it is quite complementary to
Org-mode. It can be very useful to combine output from Org-mode with
--- 2372,2378 ----
Emacs contains the calendar and diary by Edward M. Reingold. The
calendar displays a three-month calendar with holidays from different
! countries and cultures. The diary allows you to keep track of
anniversaries, lunar phases, sunrise/set, recurrent appointments
(weekly, monthly) and more. In this way, it is quite complementary to
Org-mode. It can be very useful to combine output from Org-mode with
***************
*** 2390,2396 ****
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. 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
--- 2390,2396 ----
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. 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
***************
*** 2434,2440 ****
@xref{Global TODO list}, for more information.
@kindex C-c a T
@item C-c a T
! Like the above, but allow to select a specific TODO keyword. You can
also do this by specifying a prefix argument to @kbd{C-c a t}. With a
@kbd{C-u} prefix you are prompted for a keyword. With a numeric
prefix, the Nth keyword in @code{org-todo-keywords} is selected.
--- 2434,2440 ----
@xref{Global TODO list}, for more information.
@kindex C-c a T
@item C-c a T
! Like the above, but allows selection of a specific TODO keyword. You can
also do this by specifying a prefix argument to @kbd{C-c a t}. With a
@kbd{C-u} prefix you are prompted for a keyword. With a numeric
prefix, the Nth keyword in @code{org-todo-keywords} is selected.
***************
*** 2487,2494 ****
items from a single Org-mode file. But it also uses the agenda buffer
and provides similar commands, so we discuss it here. The timeline
shows all time-stamped items in a single Org-mode file (or the
! selected part of it), in @emph{time-sorted view}. The main purpose of
! this command is to give an overview over events in a project.
@table @kbd
@kindex C-c C-r
--- 2487,2494 ----
items from a single Org-mode file. But it also uses the agenda buffer
and provides similar commands, so we discuss it here. The timeline
shows all time-stamped items in a single Org-mode file (or the
! selected part of it), in a @emph{time-sorted view}. The main purpose of
! this command is to give an overview of events in a project.
@table @kbd
@kindex C-c C-r
***************
*** 2511,2517 ****
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.
--- 2511,2517 ----
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,
! removing the risk that your agenda and note files may 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.
***************
*** 2542,2548 ****
@itemx mouse-1
@itemx @key{TAB}
Go to the original location of the item in another window. Under Emacs
! 22, also @kbd{mouse-1} will works for this.
@kindex @key{RET}
@itemx @key{RET}
--- 2542,2548 ----
@itemx mouse-1
@itemx @key{TAB}
Go to the original location of the item in another window. Under Emacs
! 22, @kbd{mouse-1} will also work for this.
@kindex @key{RET}
@itemx @key{RET}
***************
*** 2566,2576 ****
@kindex w
@item w
! Switch to weekly view (7 days displayed together)
@kindex d
@item d
! Switch to daily view (just one day displayed)
@kindex D
@item D
--- 2566,2576 ----
@kindex w
@item w
! Switch to weekly view (7 days displayed together).
@kindex d
@item d
! Switch to daily view (just one day displayed).
@kindex D
@item D
***************
*** 2685,2691 ****
@kindex M
@item M
! Show the phases of the moon for three month around current date.
@kindex S
@item S
--- 2685,2691 ----
@kindex M
@item M
! Show the phases of the moon for the three months around current date.
@kindex S
@item S
***************
*** 2708,2714 ****
@tsubheading{Quit and Exit}
@kindex q
@item q
! Quit Agenda, remove the agenda buffer.
@kindex x
@cindex agenda files, removing buffers
--- 2708,2714 ----
@tsubheading{Quit and Exit}
@kindex q
@item q
! Quit agenda, remove the agenda buffer.
@kindex x
@cindex agenda files, removing buffers
***************
*** 2753,2759 ****
@cindex headline levels, for exporting
In the exported version, the first 3 outline levels will become
headlines, defining a general document structure. Additional levels
! will be exported as itemize lists. If you want that transition to occur
at a different level, specify it with a prefix argument. For example,
@example
@kbd{C-1 C-c C-x a org-export-as-ascii}
--- 2753,2759 ----
@cindex headline levels, for exporting
In the exported version, the first 3 outline levels will become
headlines, defining a general document structure. Additional levels
! will be exported as itemized lists. If you want that transition to occur
at a different level, specify it with a prefix argument. For example,
@example
@kbd{C-1 C-c C-x a org-export-as-ascii}
***************
*** 2792,2798 ****
@cindex headline levels, for exporting
In the exported version, the first 3 outline levels will become
headlines, defining a general document structure. Additional levels
! will be exported as itemize lists. If you want that transition to occur
at a different level, specify it with a prefix argument. For example,
@example
@kbd{C-2 C-c C-x b}
--- 2792,2798 ----
@cindex headline levels, for exporting
In the exported version, the first 3 outline levels will become
headlines, defining a general document structure. Additional levels
! will be exported as itemized lists. If you want that transition to occur
at a different level, specify it with a prefix argument. For example,
@example
@kbd{C-2 C-c C-x b}
***************
*** 2888,2894 ****
@end example
@noindent
The OPTIONS line is a compact form to specify export settings. Here
! you can
@cindex headline levels
@cindex section-numbers
@cindex table of contents
--- 2888,2894 ----
@end example
@noindent
The OPTIONS line is a compact form to specify export settings. Here
! you can:
@cindex headline levels
@cindex section-numbers
@cindex table of contents
***************
*** 3164,3171 ****
@end example
You can convert an Org-mode file from single-star-per-level to
! double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
! RET} in that file. There is no command for the back conversion because
such a command might merge levels and in this way destroy the
structure of the tree.
@c FIXME: Maybe we should have such a command...
--- 3164,3171 ----
@end example
You can convert an Org-mode file from single-star-per-level to
! the double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
! RET} in that file. There is no command for converting the other way because
such a command might merge levels and in this way destroy the
structure of the tree.
@c FIXME: Maybe we should have such a command...
***************
*** 3243,3249 ****
itemized list?}@*
If you plan to use ASCII or HTML export, make sure things you want to
be exported as item lists are level 4 at least, even if that does mean
! there is a level jump. For example
@example
* Todays top priorities
--- 3243,3249 ----
itemized list?}@*
If you plan to use ASCII or HTML export, make sure things you want to
be exported as item lists are level 4 at least, even if that does mean
! there is a level jump. For example:
@example
* Todays top priorities
***************
*** 3267,3273 ****
@item @b{Org-mode takes over the S-cursor keys. I also want to use
CUA-mode, is there a way to fix this conflict?}@*
! Yes, see @ref{Interaction}
@item @b{Is there an easy way to insert an empty table template with a
default number of rows and columns?}@*
--- 3267,3273 ----
@item @b{Org-mode takes over the S-cursor keys. I also want to use
CUA-mode, is there a way to fix this conflict?}@*
! Yes, see @ref{Interaction}.
@item @b{Is there an easy way to insert an empty table template with a
default number of rows and columns?}@*
***************
*** 3301,3307 ****
emacs diary?}@*
Since the org-mode agenda is much more powerful and can contain the
diary (@pxref{Calendar/Diary integration}), you should think twice
! before deciding to do this. Inegrating org-mode information into the
diary is, however, possible. The following steps are necessary:
Autoload the function @command{org-diary} as shown above under
@ref{Installation and Activation}. You also need to use @emph{fancy
--- 3301,3307 ----
emacs diary?}@*
Since the org-mode agenda is much more powerful and can contain the
diary (@pxref{Calendar/Diary integration}), you should think twice
! before deciding to do this. Integrating org-mode information into the
diary is, however, possible. The following steps are necessary:
Autoload the function @command{org-diary} as shown above under
@ref{Installation and Activation}. You also need to use @emph{fancy
***************
*** 3345,3351 ****
@cindex @file{org-mouse.el}
@item @file{org-mouse.el} by Piotr Zielinski
This package implements extended mouse functionality for Org-mode. It
! allows to cycle visibility and to edit the document structure with the
mouse. It also provides a context-sensitive menu that changes depending
on the context of a mouse-click. Use a search engine to find this
package on the web.
--- 3345,3351 ----
@cindex @file{org-mouse.el}
@item @file{org-mouse.el} by Piotr Zielinski
This package implements extended mouse functionality for Org-mode. It
! allows you to cycle visibility and to edit the document structure with the
mouse. It also provides a context-sensitive menu that changes depending
on the context of a mouse-click. Use a search engine to find this
package on the web.
***************
*** 3399,3409 ****
@cindex @file{planner.el}
@item @file{planner.el} by John Wiegley
Planner is another tool to plan work and keep track of tasks. Planner
! uses a multi-file approach with project pages and day pages. Is based
on Emacs-Wiki. If Planner is your primary tool, it can be useful to
display the agenda entries resulting from org files in day-pages of
the planner. This can be done through the diary of the calendar:
! Integrate org files into the diary as described above, and then turn
on the diary support of planner. Planner is not part of Emacs, find it
on the web.
@end table
--- 3399,3409 ----
@cindex @file{planner.el}
@item @file{planner.el} by John Wiegley
Planner is another tool to plan work and keep track of tasks. Planner
! uses a multi-file approach with project pages and day pages. It is based
on Emacs-Wiki. If Planner is your primary tool, it can be useful to
display the agenda entries resulting from org files in day-pages of
the planner. This can be done through the diary of the calendar:
! integrate org files into the diary as described above, and then turn
on the diary support of planner. Planner is not part of Emacs, find it
on the web.
@end table
[-- Attachment #3: Type: text/plain, Size: 29 bytes --]
I said they were trivial...
[-- Attachment #4: Type: text/plain, Size: 149 bytes --]
_______________________________________________
Emacs-orgmode mailing list
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
^ permalink raw reply [flat|nested] 5+ messages in thread