diff options
| author | Carsten Dominik | 2008-11-12 08:09:03 +0000 |
|---|---|---|
| committer | Carsten Dominik | 2008-11-12 08:09:03 +0000 |
| commit | e45e35955ca072df5409a01c964c5f54a38f6333 (patch) | |
| tree | 451f5b5c735564b34d24daf3a4c7354e50e3cac9 | |
| parent | 564c900ef273170e1fc1666965753ccb8da44f84 (diff) | |
| download | emacs-e45e35955ca072df5409a01c964c5f54a38f6333.tar.gz emacs-e45e35955ca072df5409a01c964c5f54a38f6333.zip | |
2008-11-12 Carsten Dominik <dominik@science.uva.nl>
* org.texi (Clocking work time): Document the :formula property of
clock tables.
(Structure editing, Refiling notes): Document refiling regions.
(Agenda commands): Document the double-prefix version
of the `l' command in the agenda.
(Handling links): Explain the effect of a double prefix
arg to `C-c C-o'.
(TODO basics): Add documentation for tag triggers.
| -rw-r--r-- | doc/misc/org.texi | 124 | ||||
| -rw-r--r-- | etc/ChangeLog | 4 |
2 files changed, 90 insertions, 38 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index 5e1246ba5c9..9d5d43a7df7 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -3,8 +3,8 @@ | |||
| 3 | @setfilename ../../info/org | 3 | @setfilename ../../info/org |
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | 5 | ||
| 6 | @set VERSION 6.10c | 6 | @set VERSION 6.12a |
| 7 | @set DATE October 2008 | 7 | @set DATE November 2008 |
| 8 | 8 | ||
| 9 | @dircategory Emacs | 9 | @dircategory Emacs |
| 10 | @direntry | 10 | @direntry |
| @@ -944,9 +944,19 @@ Yank subtree from kill ring. This does modify the level of the subtree to | |||
| 944 | make sure the tree fits in nicely at the yank position. The yank level can | 944 | make sure the tree fits in nicely at the yank position. The yank level can |
| 945 | also be specified with a numeric prefix argument, or by yanking after a | 945 | also be specified with a numeric prefix argument, or by yanking after a |
| 946 | headline marker like @samp{****}. | 946 | headline marker like @samp{****}. |
| 947 | @kindex C-y | ||
| 948 | @item C-y | ||
| 949 | Depending on the variables @code{org-yank-adjusted-subtrees} and | ||
| 950 | @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will | ||
| 951 | paste subtrees folded and in a clever way, using the same command as @kbd{C-c | ||
| 952 | C-x C-y}. With the default settings, level adjustment will take place and | ||
| 953 | yanked trees will be folded unless doing so would swallow text previously | ||
| 954 | visible. Any prefix argument to this command will force a normal @code{yank} | ||
| 955 | to be executed, with the prefix passed along. A good way to force a normal | ||
| 956 | yank is @kbd{C-u C-y}. | ||
| 947 | @kindex C-c C-w | 957 | @kindex C-c C-w |
| 948 | @item C-c C-w | 958 | @item C-c C-w |
| 949 | Refile entry to a different location. @xref{Refiling notes}. | 959 | Refile entry or region to a different location. @xref{Refiling notes}. |
| 950 | @kindex C-c ^ | 960 | @kindex C-c ^ |
| 951 | @item C-c ^ | 961 | @item C-c ^ |
| 952 | Sort same-level entries. When there is an active region, all entries in the | 962 | Sort same-level entries. When there is an active region, all entries in the |
| @@ -2339,6 +2349,10 @@ Specify an entire line to be inserted in the gnuplot script. | |||
| 2339 | When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a | 2349 | When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a |
| 2340 | flat mapping rather than a @code{3d} slope. | 2350 | flat mapping rather than a @code{3d} slope. |
| 2341 | 2351 | ||
| 2352 | @item timefmt | ||
| 2353 | Specify format of org-mode timestamps as they will be parsed by gnuplot. | ||
| 2354 | Defaults to '%Y-%m-%d-%H:%M:%S'. | ||
| 2355 | |||
| 2342 | @item script | 2356 | @item script |
| 2343 | If you want total control you can specify a script file (place the file name | 2357 | If you want total control you can specify a script file (place the file name |
| 2344 | between double quotes) which will be used to plot. Before plotting, every | 2358 | between double quotes) which will be used to plot. Before plotting, every |
| @@ -2627,7 +2641,8 @@ date. Furthermore, it will visit text and remote files in @samp{file:} links | |||
| 2627 | with Emacs and select a suitable application for local non-text files. | 2641 | with Emacs and select a suitable application for local non-text files. |
| 2628 | Classification of files is based on file extension only. See option | 2642 | Classification of files is based on file extension only. See option |
| 2629 | @code{org-file-apps}. If you want to override the default application and | 2643 | @code{org-file-apps}. If you want to override the default application and |
| 2630 | visit the file with Emacs, use a @kbd{C-u} prefix. | 2644 | visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid |
| 2645 | opening in Emacs, use a @kbd{C-u C-u} prefix. | ||
| 2631 | @c | 2646 | @c |
| 2632 | @kindex mouse-2 | 2647 | @kindex mouse-2 |
| 2633 | @kindex mouse-1 | 2648 | @kindex mouse-1 |
| @@ -3661,25 +3676,34 @@ Like before, but require the @samp{:laptop:} lines to be tagged also | |||
| 3661 | @end table | 3676 | @end table |
| 3662 | 3677 | ||
| 3663 | @cindex TODO keyword matching, with tags search | 3678 | @cindex TODO keyword matching, with tags search |
| 3664 | If you are using multi-state TODO keywords (@pxref{TODO extensions}), it | 3679 | You may also test for TODO keywords (@pxref{TODO extensions}) and properties |
| 3665 | can be useful to also match on the TODO keyword. This can be done by | 3680 | (@pxref{Properties and Columns}) at the same time as matching tags. For a |
| 3666 | adding a condition after a slash to a tags match. The syntax is similar | 3681 | guide on how to match properties, see @ref{Property searches}. To match a |
| 3667 | to the tag matches, but should be applied with consideration: For | 3682 | specific TODO keyword, include an expression like @samp{+TODO="NEXT"} as one |
| 3668 | example, a positive selection on several TODO keywords can not | 3683 | of the terms in a tags search. |
| 3669 | meaningfully be combined with boolean AND. However, @emph{negative | 3684 | |
| 3670 | selection} combined with AND can be meaningful. To make sure that only | 3685 | There is also the possibility to end the tags part of the match (which may |
| 3671 | lines are checked that actually have any TODO keyword, use @kbd{C-c a | 3686 | include several terms connected with @samp{|}) with a @samp{/} and then |
| 3672 | M}, or equivalently start the TODO part after the slash with @samp{!}. | 3687 | specify a Boolean expression just for TODO keywords. The syntax is then |
| 3673 | Examples: | 3688 | similar to the tag matches, but should be applied with consideration: For |
| 3689 | example, a positive selection on several TODO keywords can not meaningfully | ||
| 3690 | be combined with boolean AND. However, @emph{negative selection} combined | ||
| 3691 | with AND can be meaningful. To make sure that only lines are checked that | ||
| 3692 | actually have any TODO keyword (resulting in a speed-up), use @kbd{C-c a M}, | ||
| 3693 | or equivalently start the TODO part after the slash with @samp{!}. Examples: | ||
| 3674 | 3694 | ||
| 3675 | @table @samp | 3695 | @table @samp |
| 3676 | @item work/WAITING | 3696 | @item work+TODO="WAITING" |
| 3677 | Select @samp{:work:}-tagged TODO lines with the specific TODO | 3697 | Select @samp{:work:}-tagged TODO lines with the specific TODO |
| 3678 | keyword @samp{WAITING}. | 3698 | keyword @samp{WAITING}. |
| 3699 | @item work+TODO="WAITING"|home+TODO="WAITING" | ||
| 3700 | Waiting tasks both at work and at home. | ||
| 3701 | @item work/WAITING | ||
| 3702 | Same as the first example. | ||
| 3679 | @item work/!-WAITING-NEXT | 3703 | @item work/!-WAITING-NEXT |
| 3680 | Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} | 3704 | Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING} |
| 3681 | nor @samp{NEXT} | 3705 | nor @samp{NEXT} |
| 3682 | @item work/+WAITING|+NEXT | 3706 | @item work/!+WAITING|+NEXT |
| 3683 | Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or | 3707 | Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or |
| 3684 | @samp{NEXT}. | 3708 | @samp{NEXT}. |
| 3685 | @end table | 3709 | @end table |
| @@ -3688,7 +3712,9 @@ Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or | |||
| 3688 | Any element of the tag/todo match can be a regular expression - in this | 3712 | Any element of the tag/todo match can be a regular expression - in this |
| 3689 | case it must be enclosed in curly braces. For example, | 3713 | case it must be enclosed in curly braces. For example, |
| 3690 | @samp{work+@{^boss.*@}} matches headlines that contain the tag | 3714 | @samp{work+@{^boss.*@}} matches headlines that contain the tag |
| 3691 | @samp{:work:} and any tag @i{starting} with @samp{boss}. | 3715 | @samp{:work:} and any tag @i{starting} with @samp{boss}. You may also use a |
| 3716 | regular expression in @samp{TODO=@{^W@}} which would match TODO keywords | ||
| 3717 | starting with the letter @samp{W}. | ||
| 3692 | 3718 | ||
| 3693 | @cindex level, require for tags/property match | 3719 | @cindex level, require for tags/property match |
| 3694 | @cindex category, require for tags/property match | 3720 | @cindex category, require for tags/property match |
| @@ -3698,6 +3724,9 @@ writing instead of any TAG an expression like @samp{LEVEL=3} or | |||
| 3698 | @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the | 3724 | @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the |
| 3699 | tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE. | 3725 | tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE. |
| 3700 | 3726 | ||
| 3727 | Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any | ||
| 3728 | other properties will slow down the search. | ||
| 3729 | |||
| 3701 | @node Properties and Columns, Dates and Times, Tags, Top | 3730 | @node Properties and Columns, Dates and Times, Tags, Top |
| 3702 | @chapter Properties and Columns | 3731 | @chapter Properties and Columns |
| 3703 | @cindex properties | 3732 | @cindex properties |
| @@ -4805,6 +4834,10 @@ new table. The @samp{BEGIN} line can specify options: | |||
| 4805 | :step @r{@code{week} or @code{day}, to split the table into chunks.} | 4834 | :step @r{@code{week} or @code{day}, to split the table into chunks.} |
| 4806 | @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} | 4835 | @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.} |
| 4807 | :link @r{Link the item headlines in the table to their origins} | 4836 | :link @r{Link the item headlines in the table to their origins} |
| 4837 | :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.} | ||
| 4838 | @r{As a special case, @samp{:formula %} adds column with % time.} | ||
| 4839 | @r{If you do not specify a formula here, any existing formula} | ||
| 4840 | @r{below the clock table will survive updates and be evaluated.} | ||
| 4808 | @end example | 4841 | @end example |
| 4809 | So to get a clock summary of the current level 1 tree, for the current | 4842 | So to get a clock summary of the current level 1 tree, for the current |
| 4810 | day, you could write | 4843 | day, you could write |
| @@ -4820,6 +4853,11 @@ only to fit it onto the manual.} | |||
| 4820 | :tend "<2006-08-10 Thu 12:00>" | 4853 | :tend "<2006-08-10 Thu 12:00>" |
| 4821 | #+END: clocktable | 4854 | #+END: clocktable |
| 4822 | @end example | 4855 | @end example |
| 4856 | A summary of the current subtree with % times would be | ||
| 4857 | @example | ||
| 4858 | #+BEGIN: clocktable :scope subtree :link t :formula % | ||
| 4859 | #+END: clocktable | ||
| 4860 | @end example | ||
| 4823 | @kindex C-c C-c | 4861 | @kindex C-c C-c |
| 4824 | @item C-c C-c | 4862 | @item C-c C-c |
| 4825 | @kindex C-c C-x C-u | 4863 | @kindex C-c C-x C-u |
| @@ -5151,16 +5189,16 @@ special command: | |||
| 5151 | @table @kbd | 5189 | @table @kbd |
| 5152 | @kindex C-c C-w | 5190 | @kindex C-c C-w |
| 5153 | @item C-c C-w | 5191 | @item C-c C-w |
| 5154 | Refile the entry at point. This command offers possible locations for | 5192 | Refile the entry or region at point. This command offers possible locations |
| 5155 | refiling the entry and lets you select one with completion. The item is | 5193 | for refiling the entry and lets you select one with completion. The item (or |
| 5156 | filed below the target heading as a subitem. Depending on | 5194 | all items in the region) is filed below the target heading as a subitem. |
| 5157 | @code{org-reverse-note-order}, it will be either the first of last | 5195 | Depending on @code{org-reverse-note-order}, it will be either the first of |
| 5158 | subitem.@* By default, all level 1 headlines in the current buffer are | 5196 | last subitem.@* |
| 5159 | considered to be targets, but you can have more complex definitions | 5197 | By default, all level 1 headlines in the current buffer are considered to be |
| 5160 | across a number of files. See the variable @code{org-refile-targets} | 5198 | targets, but you can have more complex definitions across a number of files. |
| 5161 | for details. If you would like to select a location via a file-pathlike | 5199 | See the variable @code{org-refile-targets} for details. If you would like to |
| 5162 | completion along the outline path, see the variable | 5200 | select a location via a file-pathlike completion along the outline path, see |
| 5163 | @code{org-refile-use-outline-path}. | 5201 | the variable @code{org-refile-use-outline-path}. |
| 5164 | @kindex C-u C-c C-w | 5202 | @kindex C-u C-c C-w |
| 5165 | @item C-u C-c C-w | 5203 | @item C-u C-c C-w |
| 5166 | Use the refile interface to jump to a heading. | 5204 | Use the refile interface to jump to a heading. |
| @@ -5908,8 +5946,12 @@ previously used indirect buffer. | |||
| 5908 | @kindex l | 5946 | @kindex l |
| 5909 | @item l | 5947 | @item l |
| 5910 | Toggle Logbook mode. In Logbook mode, entries that where marked DONE while | 5948 | Toggle Logbook mode. In Logbook mode, entries that where marked DONE while |
| 5911 | logging was on (variable @code{org-log-done}) are shown in the agenda, | 5949 | logging was on (variable @code{org-log-done}) are shown in the agenda, as are |
| 5912 | as are entries that have been clocked on that day. | 5950 | entries that have been clocked on that day. You can configure the entry |
| 5951 | types that should be included in log mode using the variable | ||
| 5952 | @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show | ||
| 5953 | all possible logbook entries, including state changes. When called with two | ||
| 5954 | prefix args @kbd{C-u C-u}, show only logging information, nothing else. | ||
| 5913 | @c | 5955 | @c |
| 5914 | @kindex v | 5956 | @kindex v |
| 5915 | @item v | 5957 | @item v |
| @@ -7661,18 +7703,23 @@ document - your style specifications may change these: | |||
| 7661 | @end example | 7703 | @end example |
| 7662 | 7704 | ||
| 7663 | Each exported files contains a compact default style that defines these | 7705 | Each exported files contains a compact default style that defines these |
| 7664 | classes in a basic way. You may overwrite these settings, or add to them by | 7706 | classes in a basic way@footnote{This style is defined in the constant |
| 7665 | using the variables @code{org-export-html-style} (for Org-wide settings) and | 7707 | @code{org-export-html-style-default}, which you should not modify. To turn |
| 7666 | @code{org-export-html-style-extra} (for more granular settings, like | 7708 | inclusion of these defaults off, customize |
| 7667 | file-local settings). To set the latter variable individually for each | 7709 | @code{org-export-html-style-include-default}}. You may overwrite these |
| 7668 | file, you can use | 7710 | settings, or add to them by using the variables @code{org-export-html-style} |
| 7711 | (for Org-wide settings) and @code{org-export-html-style-extra} (for more | ||
| 7712 | granular settings, like file-local settings). To set the latter variable | ||
| 7713 | individually for each file, you can use | ||
| 7669 | 7714 | ||
| 7670 | @example | 7715 | @example |
| 7671 | #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" /> | 7716 | #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" /> |
| 7672 | @end example | 7717 | @end example |
| 7673 | 7718 | ||
| 7674 | @noindent | 7719 | @noindent |
| 7675 | For longer style definitions, you can use several such lines. | 7720 | For longer style definitions, you can use several such lines. You could also |
| 7721 | directly write a @code{<style>} @code{</style>} section in this way, without | ||
| 7722 | referring to an external file. | ||
| 7676 | 7723 | ||
| 7677 | @c FIXME: More about header and footer styles | 7724 | @c FIXME: More about header and footer styles |
| 7678 | @c FIXME: Talk about links and targets. | 7725 | @c FIXME: Talk about links and targets. |
| @@ -8087,6 +8134,7 @@ respective variable for details. | |||
| 8087 | @item @code{:tags} @tab @code{org-export-with-tags} | 8134 | @item @code{:tags} @tab @code{org-export-with-tags} |
| 8088 | @item @code{:tables} @tab @code{org-export-with-tables} | 8135 | @item @code{:tables} @tab @code{org-export-with-tables} |
| 8089 | @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} | 8136 | @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line} |
| 8137 | @item @code{:style-include-default} @tab @code{org-export-html-style-include-default} | ||
| 8090 | @item @code{:style} @tab @code{org-export-html-style} | 8138 | @item @code{:style} @tab @code{org-export-html-style} |
| 8091 | @item @code{:style-extra} @tab @code{org-export-html-style-extra} | 8139 | @item @code{:style-extra} @tab @code{org-export-html-style-extra} |
| 8092 | @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} | 8140 | @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html} |
| @@ -8200,7 +8248,7 @@ directory on the local machine. | |||
| 8200 | :publishing-directory "~/public_html" | 8248 | :publishing-directory "~/public_html" |
| 8201 | :section-numbers nil | 8249 | :section-numbers nil |
| 8202 | :table-of-contents nil | 8250 | :table-of-contents nil |
| 8203 | :style "<link rel=stylesheet | 8251 | :style "<link rel=\"stylesheet\" |
| 8204 | href=\"../other/mystyle.css\" | 8252 | href=\"../other/mystyle.css\" |
| 8205 | type=\"text/css\">"))) | 8253 | type=\"text/css\">"))) |
| 8206 | @end lisp | 8254 | @end lisp |
| @@ -8237,7 +8285,7 @@ right place on the web server, and publishing images to it. | |||
| 8237 | :headline-levels 3 | 8285 | :headline-levels 3 |
| 8238 | :section-numbers nil | 8286 | :section-numbers nil |
| 8239 | :table-of-contents nil | 8287 | :table-of-contents nil |
| 8240 | :style "<link rel=stylesheet | 8288 | :style "<link rel=\"stylesheet\" |
| 8241 | href=\"../other/mystyle.css\" type=\"text/css\">" | 8289 | href=\"../other/mystyle.css\" type=\"text/css\">" |
| 8242 | :auto-preamble t | 8290 | :auto-preamble t |
| 8243 | :auto-postamble nil) | 8291 | :auto-postamble nil) |
| @@ -9509,7 +9557,7 @@ like this: | |||
| 9509 | @lisp | 9557 | @lisp |
| 9510 | (org-add-agenda-custom-command | 9558 | (org-add-agenda-custom-command |
| 9511 | '("b" todo "PROJECT" | 9559 | '("b" todo "PROJECT" |
| 9512 | ((org-agenda-skip-function 'my-org-waiting-projects) | 9560 | ((org-agenda-skip-function 'my-skip-unless-waiting) |
| 9513 | (org-agenda-overriding-header "Projects waiting for something: ")))) | 9561 | (org-agenda-overriding-header "Projects waiting for something: ")))) |
| 9514 | @end lisp | 9562 | @end lisp |
| 9515 | 9563 | ||
diff --git a/etc/ChangeLog b/etc/ChangeLog index bf0e7cfec00..2d26c2b243b 100644 --- a/etc/ChangeLog +++ b/etc/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2008-11-12 Carsten Dominik <dominik@science.uva.nl> | ||
| 2 | |||
| 3 | * refcards/orgcard.tex: Document the extra yanking key. | ||
| 4 | |||
| 1 | 2008-11-08 Mark A. Hershberger <mah@everybody.org> | 5 | 2008-11-08 Mark A. Hershberger <mah@everybody.org> |
| 2 | 6 | ||
| 3 | * compilation.txt (php): Add regexp for php error messages. | 7 | * compilation.txt (php): Add regexp for php error messages. |