Release 4.37

This commit is contained in:
Carsten Dominik 2008-01-31 11:32:03 +01:00
parent 9cf9c9f451
commit 2ff8fc1133
7 changed files with 997 additions and 450 deletions

426
org
View File

@ -5,7 +5,7 @@ START-INFO-DIR-ENTRY
* Org Mode: (org). outline-based notes management and organizer
END-INFO-DIR-ENTRY
This manual is for Org-mode (version 4.36).
This manual is for Org-mode (version 4.37).
Copyright (C) 2004, 2005, 2006 Free Software Foundation
@ -27,7 +27,7 @@ File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
Org Mode Manual
***************
This manual is for Org-mode (version 4.36).
This manual is for Org-mode (version 4.37).
Copyright (C) 2004, 2005, 2006 Free Software Foundation
@ -114,7 +114,6 @@ Internal links
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
@ -128,6 +127,12 @@ Timestamps
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
* Progress logging:: Documenting when what work was done.
Progress Logging
* Closing items:: When was this entry makred DONE?
* Clocking work time:: When exactly did you work on this item?
Tags
@ -1731,12 +1736,11 @@ overview over all things you have to do.
* Menu:
* 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

File: org, Node: TODO basics, Next: Progress logging, Prev: TODO items, Up: TODO items
File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
5.1 Basic TODO functionality
============================
@ -1779,29 +1783,9 @@ The most important commands to work with TODO entries are:
information.

File: org, Node: Progress logging, Next: TODO extensions, Prev: TODO basics, Up: TODO items
File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
5.2 Progress Logging
====================
If you want to keep track of _when_ a certain TODO item was finished,
turn on logging with
(setq org-log-done t)
Then each time you turn a TODO entry into DONE using either `C-c C-t'
in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
[timestamp]' will be inserted just after the headline. If you turn the
entry back into a TODO item again through further state cycling, that
line will be removed again. In the timeline (*note Timeline::) and in
the agenda (*note Weekly/Daily agenda::), you can then use the `L' key
to display the TODO items closed on each day, giving you an overview of
what has been done on a day.

File: org, Node: TODO extensions, Next: Priorities, Prev: Progress logging, Up: TODO items
5.3 Extended use of TODO keywords
5.2 Extended use of TODO keywords
=================================
The default implementation of TODO entries is just two states: TODO and
@ -1822,7 +1806,7 @@ TODO items in particular (*note Tags::).

File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
5.3.1 TODO keywords as workflow states
5.2.1 TODO keywords as workflow states
--------------------------------------
You can use TODO keywords to indicate different states in the process
@ -1842,7 +1826,7 @@ Completion::) to insert these words into the buffer.

File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
5.3.2 TODO keywords as types
5.2.2 TODO keywords as types
----------------------------
The second possibility is to use TODO keywords to indicate different
@ -1878,7 +1862,7 @@ buffers.

File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
5.3.3 Setting up TODO keywords for individual files
5.2.3 Setting up TODO keywords for individual files
---------------------------------------------------
It can be very useful to use different aspects of the TODO mechanism in
@ -1919,7 +1903,7 @@ will be respected.

File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
5.4 Priorities
5.3 Priorities
==============
If you use Org-mode extensively to organize your work, you may end up
@ -1961,6 +1945,7 @@ planning.
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
* Progress logging:: Documenting when what work was done.

File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
@ -2022,8 +2007,15 @@ TIME STAMP WITH CLOSED KEYWORD
Progress logging::). This time stamp is enclosed in square
brackets instead of angular brackets.
TIME RANGE WITH CLOCK KEYWORD
When using the clock to time the work that is being done on
specific items, time ranges preceeded by the CLOCK keyword are
inserted automatically into the file. The time stamps are
enclosed in square brackets instead of angular brackets. *Note
Clocking work time::.

File: org, Node: Creating timestamps, Prev: Time stamps, Up: Timestamps
File: org, Node: Creating timestamps, Next: Progress logging, Prev: Time stamps, Up: Timestamps
6.2 Creating timestamps
=======================
@ -2130,6 +2122,83 @@ date can be selected with the following commands:
`<RET>'
Choose date in calendar (only if nothing typed into minibuffer).

File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
6.3 Progress Logging
====================
Org-mode can automatically record a time stamp when you mark a TODO item
as DONE. You can also measure precisely the time you spent on specific
items in a project by starting and stopping a clock when you start and
stop working on an aspect of a project.
* Menu:
* Closing items:: When was this entry makred DONE?
* Clocking work time:: When exactly did you work on this item?

File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
6.3.1 Closing items
-------------------
If you want to keep track of _when_ a certain TODO item was finished,
turn on logging with
(setq org-log-done t)
Then each time you turn a TODO entry into DONE using either `C-c C-t'
in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
[timestamp]' will be inserted just after the headline. If you turn the
entry back into a TODO item again through further state cycling, that
line will be removed again. In the timeline (*note Timeline::) and in
the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
to display the TODO items closed on each day, giving you an overview of
what has been done on a day.

File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
6.3.2 Clocking work time
------------------------
Org-mode allows you to clock the time you spent on specific tasks in a
project. When you start working on an item, you can start the clock.
When you stop working on that tast, or when you makr the task done, the
clock is stoppend and the corresponding time interval is recorded. It
also computes the total time spent on each subtree of a project.
`C-c C-x C-i'
Start the clock on the current item (clock-in). This inserts the
CLOCK keyword together with a timestamp.
`C-c C-x C-o'
Stop the clock (clock-out). The inserts another timestamp at the
same location where the clock was last started. It also directly
computes the resulting time in inserts it after the time range as
`=> HH:MM'.
`C-c C-t'
Changing the TODO state of an item to DONE automatically stops the
clock if it is running in this same item.
`C-c C-x C-x'
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
`C-c C-x C-d'
Display time summaries for each subtree in the current buffer.
This puts overlays at the end of each headline, showing the total
time recorded under that heading, including the time of any
subheadings. You can use visibility cycling to study the tree, but
the overlays disappear automatically when the buffer is changed.
The `l' key may be used in the timeline (*note Timeline::) and in
the agenda (*note Weekly/Daily agenda::) to show which tasks have been
worked on or closed during a day.

File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
@ -2677,7 +2746,7 @@ View/GoTo org file
`l'
Toggle Logbook mode. In Logbook mode, entries that where marked
DONE while logging was on (variable `org-log-done') are shown in
the agenda.
the agenda, as are entries that have been clocked on that day.
Change display
..............
@ -2776,11 +2845,15 @@ Remote editing
The key `>' has been chosen, because it is the same as `S-.' on my
keyboard.
`i'
Insert a new entry into the diary. Prompts for the type of entry
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a
new entry in the diary, just as `i d' etc. would do in the
calendar. The date is taken from the cursor position.
`I'
Start the clock on the current item. If a clock is running
already, it is stopped first.
`O'
Stop the previously started clock.
`X'
Cancel the currently running clock.
Calendar commands
.................
@ -2792,6 +2865,12 @@ Calendar commands
When in the calendar, compute and show the Org-mode agenda for the
date at the cursor.
`i'
Insert a new entry into the diary. Prompts for the type of entry
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a
new entry in the diary, just as `i d' etc. would do in the
calendar. The date is taken from the cursor position.
`M'
Show the phases of the moon for the three months around current
date.
@ -4184,7 +4263,7 @@ File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
* agenda: Weekly/Daily agenda. (line 6)
* agenda commands, custom: Agenda dispatcher. (line 6)
* agenda dispatcher: Agenda dispatcher. (line 6)
* agenda files, removing buffers: Agenda commands. (line 195)
* agenda files, removing buffers: Agenda commands. (line 205)
* agenda views: Agenda views. (line 6)
* agenda, for single file: Timeline. (line 6)
* allout.el: Conflicts. (line 6)
@ -4216,6 +4295,7 @@ File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
* checkboxes: Plain lists. (line 36)
* children, subtree visibility state: Visibility cycling. (line 10)
* clean outline view: Clean view. (line 6)
* CLOCK keyword: Time stamps. (line 61)
* CLOSED keyword: Time stamps. (line 55)
* column formula: Column formulas. (line 6)
* commands, in agenda buffer: Agenda commands. (line 6)
@ -4252,7 +4332,7 @@ File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
* DEADLINE keyword: Time stamps. (line 43)
* deadlines: Time stamps. (line 6)
* demotion, of subtrees: Structure editing. (line 6)
* diary entries, creating from agenda: Agenda commands. (line 153)
* diary entries, creating from agenda: Agenda commands. (line 173)
* diary integration: Calendar/Diary integration.
(line 6)
* dictionary word completion: Completion. (line 6)
@ -4511,8 +4591,8 @@ File: org, Node: Key Index, Prev: Index, Up: Top
* <TAB>: Visibility cycling. (line 10)
* > <1>: Agenda commands. (line 148)
* >: Creating timestamps. (line 79)
* C: Agenda commands. (line 178)
* c: Agenda commands. (line 162)
* C: Agenda commands. (line 188)
* c: Agenda commands. (line 166)
* C-#: Built-in table editor.
(line 155)
* C-,: Agenda files. (line 18)
@ -4590,6 +4670,7 @@ File: org, Node: Key Index, Prev: Index, Up: Top
* C-c C-r: Timeline. (line 13)
* C-c C-s <1>: Agenda commands. (line 130)
* C-c C-s: Creating timestamps. (line 48)
* C-c C-t <1>: Clocking work time. (line 20)
* C-c C-t: TODO basics. (line 13)
* C-c C-u: Motion. (line 18)
* C-c C-v: TODO basics. (line 26)
@ -4597,13 +4678,17 @@ File: org, Node: Key Index, Prev: Index, Up: Top
* C-c C-x a: ASCII export. (line 9)
* C-c C-x b: HTML export. (line 11)
* C-c C-x c: iCalendar export. (line 20)
* C-c C-x C-c: Agenda commands. (line 185)
* C-c C-x C-i: iCalendar export. (line 15)
* C-c C-x C-c: Agenda commands. (line 195)
* C-c C-x C-d: Clocking work time. (line 28)
* C-c C-x C-i <1>: iCalendar export. (line 15)
* C-c C-x C-i: Clocking work time. (line 12)
* C-c C-x C-k: Structure editing. (line 36)
* C-c C-x C-o: Clocking work time. (line 14)
* C-c C-x C-w <1>: Built-in table editor.
(line 108)
* C-c C-x C-w: Structure editing. (line 36)
* C-c C-x C-x: XOXO export. (line 10)
* C-c C-x C-x <1>: XOXO export. (line 10)
* C-c C-x C-x: Clocking work time. (line 24)
* C-c C-x C-y <1>: Built-in table editor.
(line 112)
* C-c C-x C-y: Structure editing. (line 43)
@ -4631,11 +4716,12 @@ File: org, Node: Key Index, Prev: Index, Up: Top
* d: Agenda commands. (line 65)
* f: Agenda commands. (line 44)
* g: Agenda commands. (line 72)
* H: Agenda commands. (line 182)
* i: Agenda commands. (line 153)
* H: Agenda commands. (line 192)
* i: Agenda commands. (line 173)
* I: Agenda commands. (line 153)
* l: Agenda commands. (line 51)
* L: Agenda commands. (line 32)
* M: Agenda commands. (line 169)
* M: Agenda commands. (line 179)
* M-<down>: Built-in table editor.
(line 82)
* M-<left> <1>: Built-in table editor.
@ -4679,13 +4765,14 @@ File: org, Node: Key Index, Prev: Index, Up: Top
* mouse-3 <1>: Agenda commands. (line 28)
* mouse-3: Handling links. (line 78)
* n: Agenda commands. (line 19)
* O: Agenda commands. (line 155)
* o: Agenda commands. (line 59)
* P: Agenda commands. (line 117)
* p: Agenda commands. (line 20)
* q: Agenda commands. (line 192)
* q: Agenda commands. (line 202)
* r <1>: Agenda commands. (line 76)
* r: Global TODO list. (line 20)
* S: Agenda commands. (line 173)
* S: Agenda commands. (line 183)
* S-<down> <1>: Agenda commands. (line 126)
* S-<down> <2>: Creating timestamps. (line 58)
* S-<down> <3>: Priorities. (line 25)
@ -4708,128 +4795,131 @@ File: org, Node: Key Index, Prev: Index, Up: Top
* T: Agenda commands. (line 104)
* t: Agenda commands. (line 100)
* w: Agenda commands. (line 62)
* x: Agenda commands. (line 195)
* x: Agenda commands. (line 205)
* X: Agenda commands. (line 158)

Tag Table:
Node: Top959
Node: Introduction8679
Node: Summary8993
Node: Installation and activation11249
Node: Feedback12907
Node: Document structure13693
Node: Outlines14459
Node: Headlines15119
Node: Visibility cycling15742
Ref: Visibility cycling-Footnote-117217
Ref: Visibility cycling-Footnote-217275
Node: Motion17325
Node: Structure editing18109
Node: Archiving20218
Node: Sparse trees21078
Ref: Sparse trees-Footnote-123057
Ref: Sparse trees-Footnote-223149
Node: Plain lists23264
Ref: Plain lists-Footnote-127162
Node: Tables27519
Node: Built-in table editor28067
Node: Narrow columns35674
Ref: Narrow columns-Footnote-137613
Node: Table calculations37659
Node: Formula syntax38979
Ref: Formula syntax-Footnote-141884
Node: Lisp formulas42184
Node: Column formulas42973
Node: Advanced features44735
Node: Named-field formulas47989
Node: Editing/debugging formulas48629
Node: Appetizer50387
Node: orgtbl-mode51490
Node: table.el51981
Node: Hyperlinks52958
Node: Link format53663
Node: Internal links54956
Ref: Internal links-Footnote-156945
Node: Radio targets57077
Node: CamelCase links57792
Node: External links58290
Node: Handling links60421
Node: Search options64971
Ref: Search options-Footnote-166745
Node: Custom searches66826
Node: Remember67874
Node: TODO items71564
Node: TODO basics72487
Node: Progress logging74015
Node: TODO extensions74801
Node: Workflow states75601
Node: TODO types76469
Ref: TODO types-Footnote-178127
Node: Per file keywords78209
Ref: Per file keywords-Footnote-179663
Node: Priorities79891
Node: Timestamps81107
Node: Time stamps81428
Node: Creating timestamps84202
Node: Tags87523
Node: Tag inheritance88285
Node: Setting tags89222
Ref: Setting tags-Footnote-192352
Ref: Setting tags-Footnote-292464
Node: Tag searches92544
Node: Agenda views93753
Node: Agenda files95292
Ref: Agenda files-Footnote-196252
Ref: Agenda files-Footnote-296401
Node: Agenda dispatcher96593
Node: Weekly/Daily agenda98723
Node: Categories99858
Node: Time-of-day specifications100506
Node: Calendar/Diary integration102482
Node: Sorting of agenda items103859
Node: Global TODO list104691
Node: Matching headline tags106052
Node: Timeline106995
Node: Agenda commands107868
Node: Exporting113336
Node: ASCII export114469
Node: HTML export115755
Node: XOXO export118589
Node: iCalendar export119028
Node: Text interpretation120851
Node: Comment lines121328
Node: Enhancing text121797
Node: Export options123721
Node: Publishing125323
Ref: Publishing-Footnote-1126119
Node: Configuration126315
Node: Project alist127036
Node: File sources and destinations128107
Node: Selecting files128659
Node: Publishing action129412
Node: Publishing options130527
Node: Publishing links132566
Node: Project page index133369
Node: Sample configuration134147
Node: Simple example134639
Node: Complex example135312
Node: Triggering publication137388
Node: Miscellaneous138044
Node: Completion138803
Node: Customization139799
Node: Summary of in-buffer settings140406
Node: The very busy C-c C-c key143648
Node: Clean view145163
Node: TTY keys147740
Node: FAQ149341
Node: Interaction157139
Node: Extensions157599
Node: Cooperation158851
Node: Conflicts160545
Node: Bugs162137
Node: Acknowledgments164035
Node: Index167473
Node: Key Index189792
Node: Introduction8845
Node: Summary9159
Node: Installation and activation11415
Node: Feedback13073
Node: Document structure13859
Node: Outlines14625
Node: Headlines15285
Node: Visibility cycling15908
Ref: Visibility cycling-Footnote-117383
Ref: Visibility cycling-Footnote-217441
Node: Motion17491
Node: Structure editing18275
Node: Archiving20384
Node: Sparse trees21244
Ref: Sparse trees-Footnote-123223
Ref: Sparse trees-Footnote-223315
Node: Plain lists23430
Ref: Plain lists-Footnote-127328
Node: Tables27685
Node: Built-in table editor28233
Node: Narrow columns35840
Ref: Narrow columns-Footnote-137779
Node: Table calculations37825
Node: Formula syntax39145
Ref: Formula syntax-Footnote-142050
Node: Lisp formulas42350
Node: Column formulas43139
Node: Advanced features44901
Node: Named-field formulas48155
Node: Editing/debugging formulas48795
Node: Appetizer50553
Node: orgtbl-mode51656
Node: table.el52147
Node: Hyperlinks53124
Node: Link format53829
Node: Internal links55122
Ref: Internal links-Footnote-157111
Node: Radio targets57243
Node: CamelCase links57958
Node: External links58456
Node: Handling links60587
Node: Search options65137
Ref: Search options-Footnote-166911
Node: Custom searches66992
Node: Remember68040
Node: TODO items71730
Node: TODO basics72594
Node: TODO extensions74121
Node: Workflow states74916
Node: TODO types75784
Ref: TODO types-Footnote-177442
Node: Per file keywords77524
Ref: Per file keywords-Footnote-178978
Node: Priorities79206
Node: Timestamps80422
Node: Time stamps80812
Node: Creating timestamps83910
Node: Progress logging87256
Node: Closing items87786
Node: Clocking work time88581
Node: Tags90266
Node: Tag inheritance91028
Node: Setting tags91965
Ref: Setting tags-Footnote-195095
Ref: Setting tags-Footnote-295207
Node: Tag searches95287
Node: Agenda views96496
Node: Agenda files98035
Ref: Agenda files-Footnote-198995
Ref: Agenda files-Footnote-299144
Node: Agenda dispatcher99336
Node: Weekly/Daily agenda101466
Node: Categories102601
Node: Time-of-day specifications103249
Node: Calendar/Diary integration105225
Node: Sorting of agenda items106602
Node: Global TODO list107434
Node: Matching headline tags108795
Node: Timeline109738
Node: Agenda commands110611
Node: Exporting116330
Node: ASCII export117463
Node: HTML export118749
Node: XOXO export121583
Node: iCalendar export122022
Node: Text interpretation123845
Node: Comment lines124322
Node: Enhancing text124791
Node: Export options126715
Node: Publishing128317
Ref: Publishing-Footnote-1129113
Node: Configuration129309
Node: Project alist130030
Node: File sources and destinations131101
Node: Selecting files131653
Node: Publishing action132406
Node: Publishing options133521
Node: Publishing links135560
Node: Project page index136363
Node: Sample configuration137141
Node: Simple example137633
Node: Complex example138306
Node: Triggering publication140382
Node: Miscellaneous141038
Node: Completion141797
Node: Customization142793
Node: Summary of in-buffer settings143400
Node: The very busy C-c C-c key146642
Node: Clean view148157
Node: TTY keys150734
Node: FAQ152335
Node: Interaction160133
Node: Extensions160593
Node: Cooperation161845
Node: Conflicts163539
Node: Bugs165131
Node: Acknowledgments167029
Node: Index170467
Node: Key Index192859

End Tag Table

View File

@ -1,12 +1,12 @@
;;; org-publish.el --- publish related org-mode files as a website
;; Copyright (C) 2006 Free Software Foundation, Inc.
;; Copyright (C) 2006 David O'Toole
;; Author: David O'Toole <dto@gnu.org>
;; Keywords: hypermedia, outlines
;; Version:
;; $Id: org-publish.el,v 1.69 2006/06/03 17:17:53 dto Exp dto $
;; $Id: org-publish.el,v 1.67 2006/05/30 10:44:31 dto Exp dto $
;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
@ -23,6 +23,8 @@
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;; This file is NOT part of GNU Emacs.
;;; Commentary:
;; Requires at least version 4.27 of org.el
@ -448,6 +450,7 @@ FILENAME is the filename of the file to be published."
If :auto-index is set, publish the index too."
(let* ((exclude-regexp (plist-get plist :exclude))
(publishing-function (or (plist-get plist :publishing-function) 'org-publish-org-to-html))
(buf (current-buffer))
(index-p (plist-get plist :auto-index))
(index-filename (or (plist-get plist :index-filename) "index.org"))
(index-function (or (plist-get plist :index-function) 'org-publish-org-index))
@ -460,7 +463,9 @@ FILENAME is the filename of the file to be published."
;; check timestamps
(when (org-publish-needed-p f)
(funcall publishing-function plist f)
(org-publish-update-timestamp f))))))
(org-publish-update-timestamp f))))
;; back to original buffer
(switch-to-buffer buf)))
(defun org-publish-org-index (plist &optional index-filename)

664
org.el

File diff suppressed because it is too large Load Diff

BIN
org.pdf

Binary file not shown.

150
org.texi
View File

@ -1,10 +1,9 @@
\input texinfo
@c %**start of header
@setfilename ../info/org
@settitle Org Mode Manual
@set VERSION 4.36
@set VERSION 4.37
@set DATE June 2006
@dircategory Emacs
@ -146,7 +145,6 @@ Internal links
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
@ -160,6 +158,12 @@ Timestamps
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
* Progress logging:: Documenting when what work was done.
Progress Logging
* Closing items:: When was this entry makred DONE?
* Clocking work time:: When exactly did you work on this item?
Tags
@ -1921,12 +1925,11 @@ things you have to do.
@menu
* 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
@end menu
@node TODO basics, Progress logging, TODO items, TODO items
@node TODO basics, TODO extensions, TODO items, TODO items
@section Basic TODO functionality
Any headline can become a TODO item by starting it with the word TODO,
@ -1978,28 +1981,8 @@ the TODO entries directly from that buffer (@pxref{Agenda commands}).
@c agenda, customize the variable @code{org-agenda-include-all-todo}.
@end table
@node Progress logging, TODO extensions, TODO basics, TODO items
@section Progress Logging
@cindex progress logging
@cindex logging, of progress
If you want to keep track of @emph{when} a certain TODO item was
finished, turn on logging with
@lisp
(setq org-log-done t)
@end lisp
@noindent
Then each time you turn a TODO entry into DONE using either @kbd{C-c
C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line
@samp{CLOSED: [timestamp]} will be inserted just after the headline.
If you turn the entry back into a TODO item again through further
state cycling, that line will be removed again. In the timeline
(@pxref{Timeline}) and in the agenda (@pxref{Weekly/Daily agenda}),
you can then use the @kbd{L} key to display the TODO items closed on
each day, giving you an overview of what has been done on a day.
@node TODO extensions, Priorities, Progress logging, TODO items
@node TODO extensions, Priorities, TODO basics, TODO items
@section Extended use of TODO keywords
@cindex extended TODO keywords
@ -2166,6 +2149,7 @@ planning.
@menu
* Time stamps:: Assigning a time to a tree entry
* Creating timestamps:: Commands which insert timestamps
* Progress logging:: Documenting when what work was done.
@end menu
@ -2239,9 +2223,17 @@ When @code{org-log-done} is non-nil, Org-mode will automatically insert
a special time stamp each time a TODO entry is marked done
(@pxref{Progress logging}). This time stamp is enclosed in square
brackets instead of angular brackets.
@item Time range with CLOCK keyword
@cindex CLOCK keyword
When using the clock to time the work that is being done on specific
items, time ranges preceeded by the CLOCK keyword are inserted
automatically into the file. The time stamps are enclosed in square
brackets instead of angular brackets. @xref{Clocking work time}.
@c FIXME: Reference needed
@end table
@node Creating timestamps, , Time stamps, Timestamps
@node Creating timestamps, Progress logging, Time stamps, Timestamps
@section Creating timestamps
@cindex creating timestamps
@cindex timestamps, creating
@ -2373,6 +2365,82 @@ One month back.
Choose date in calendar (only if nothing typed into minibuffer).
@end table
@node Progress logging, , Creating timestamps, Timestamps
@section Progress Logging
@cindex progress logging
@cindex logging, of progress
Org-mode can automatically record a time stamp when you mark a TODO item
as DONE. You can also measure precisely the time you spent on specific
items in a project by starting and stopping a clock when you start and
stop working on an aspect of a project.
@menu
* Closing items:: When was this entry makred DONE?
* Clocking work time:: When exactly did you work on this item?
@end menu
@node Closing items, Clocking work time, Progress logging, Progress logging
@subsection Closing items
If you want to keep track of @emph{when} a certain TODO item was
finished, turn on logging with
@lisp
(setq org-log-done t)
@end lisp
@noindent
Then each time you turn a TODO entry into DONE using either @kbd{C-c
C-t} in the Org-mode buffer or @kbd{t} in the agenda buffer, a line
@samp{CLOSED: [timestamp]} will be inserted just after the headline.
If you turn the entry back into a TODO item again through further
state cycling, that line will be removed again. In the timeline
(@pxref{Timeline}) and in the agenda (@pxref{Weekly/Daily agenda}),
you can then use the @kbd{l} key to display the TODO items closed on
each day, giving you an overview of what has been done on a day.
@node Clocking work time, , Closing items, Progress logging
@subsection Clocking work time
Org-mode allows you to clock the time you spent on specific tasks in a
project. When you start working on an item, you can start the clock.
When you stop working on that tast, or when you makr the task done, the
clock is stoppend and the corresponding time interval is recorded. It
also computes the total time spent on each subtree of a project.
@table @kbd
@kindex C-c C-x C-i
@item C-c C-x C-i
Start the clock on the current item (clock-in). This inserts the CLOCK
keyword together with a timestamp.
@kindex C-c C-x C-o
@item C-c C-x C-o
Stop the clock (clock-out). The inserts another timestamp at the same
location where the clock was last started. It also directly computes
the resulting time in inserts it after the time range as @samp{=>
HH:MM}.
@kindex C-c C-t
@item C-c C-t
Changing the TODO state of an item to DONE automatically stops the clock
if it is running in this same item.
@kindex C-c C-x C-x
@item C-c C-x C-x
Cancel the current clock. This is useful if a clock was started by
mistake, or if you ended up working on something else.
@kindex C-c C-x C-d
@item C-c C-x C-d
Display time summaries for each subtree in the current buffer. This
puts overlays at the end of each headline, showing the total time
recorded under that heading, including the time of any subheadings. You
can use visibility cycling to study the tree, but the overlays disappear
automatically when the buffer is changed.
@end table
The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
the agenda (@pxref{Weekly/Daily agenda}) to show which tasks have been
worked on or closed during a day.
@node Tags, Agenda views, Timestamps, Top
@chapter Tags
@cindex tags
@ -2958,7 +3026,8 @@ agenda buffers can be set with the variable
@kindex l
@item l
Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
logging was on (variable @code{org-log-done}) are shown in the agenda.
logging was on (variable @code{org-log-done}) are shown in the agenda,
as are entries that have been clocked on that day.
@tsubheading{Change display}
@kindex o
@ -3075,13 +3144,16 @@ Change the time stamp associated with the current line to today.
The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
on my keyboard.
@cindex diary entries, creating from agenda
@kindex i
@item i
Insert a new entry into the diary. Prompts for the type of entry
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
entry in the diary, just as @kbd{i d} etc. would do in the calendar.
The date is taken from the cursor position.
@kindex I
@item I
Start the clock on the current item. If a clock is running already, it
is stopped first.
@kindex O
@item O
Stop the previously started clock.
@kindex X
@item X
Cancel the currently running clock.
@tsubheading{Calendar commands}
@kindex c
@ -3092,6 +3164,14 @@ Open the Emacs calendar and move to the date at the agenda cursor.
When in the calendar, compute and show the Org-mode agenda for the
date at the cursor.
@cindex diary entries, creating from agenda
@kindex i
@item i
Insert a new entry into the diary. Prompts for the type of entry
(day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
entry in the diary, just as @kbd{i d} etc. would do in the calendar.
The date is taken from the cursor position.
@kindex M
@item M
Show the phases of the moon for the three months around current date.

Binary file not shown.

View File

@ -1,5 +1,5 @@
% Reference Card for Org Mode
\def\orgversionnumber{4.36}
\def\orgversionnumber{4.37}
\def\year{2006}
%
%**start of header
@ -336,83 +336,6 @@ To set archive location for current file, add a line like$^2$:
\key{create sparse tree with matching tags}{C-c \\}
\key{globally (agenda) match tags at cursor}{C-c C-o}
\section{TODO Items}
\key{rotate the state of the current item}{C-c C-t}
\key{view TODO items in a sparse tree}{C-c C-v}
\key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
\key{set the priority of the current item}{C-c , [ABC]}
\key{remove priority cookie from current item}{C-c , SPC}
\key{raise priority of current item}{S-UP$^3$}
\key{lower priority of current item}{S-DOWN$^3$}
\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
\section{Timestamps}
\key{prompt for date and insert timestamp}{C-c .}
\key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
\key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
\key{insert DEADLINE timestamp}{C-c C-d}
\key{insert SCHEDULED timestamp}{C-c C-s}
\key{create sparse tree with all deadlines due}{C-c C-w}
\key{the time between 2 dates in a time range}{C-c C-y}
\key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$}
\key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$}
\key{access the calendar for the current date}{C-c >}
\key{insert timestamp matching date in calendar}{C-c <}
\key{access agenda for current date}{C-c C-o}
\key{Select date while prompted}{mouse-1/RET}
%\key{... select date in calendar}{mouse-1/RET}
%\key{... scroll calendar back/forward one month}{< / >}
%\key{... forward/backward one day}{S-LEFT/RIGHT}
%\key{... forward/backward one week}{S-UP/DOWN}
%\key{... forward/backward one month}{M-S-LEFT/RIGT}
\section{Links}
\key{globally store link to the current location}{C-c l$^1$}
\key{insert a link (TAB completes stored links)}{C-c C-l}
\key{insert file link with file name completion}{C-u C-c C-l}
\key{edit (also hidden part of) link at point}{C-c C-l}
\key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o}
\key{open link at point (3: in emacs)}{mouse-2/3}
%\key{open file links in emacs}{mouse-3}
%\key{record a position in mark ring}{C-c \%}
\key{jump back to last followed link(s)}{C-c \&}
{\bf Internal Links}
\key{\kbd{<<My Target>>}}{\rm target}
\key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
\key{\kbd{[[*this text]]}}{\rm find headline}
\metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
\metax{\kbd{[[this text][description]]}}{\rm optional link text}
{\bf External Links}
\key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
\key{\kbd{file:papers/last.pdf}}{\rm file, relative}
\key{\kbd{file:projects.org::*that text}}{\rm find headline}
\key{\kbd{file:projects.org::find me}}{\rm find tgt/string}
%\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
\key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
\key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address}
\key{\kbd{news:comp.emacs}}{\rm Usenet group}
\key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
\key{\kbd{gnus:group}}{\rm GNUS group}
\key{\kbd{gnus:group\#id}}{\rm GNUS message}
\key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
\key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
\key{\kbd{info:emacs:Regexps}}{\rm Info file:node}
\key{\kbd{shell:ls *.org}}{\rm shell command}
\key{\kbd{elisp:(calendar)}}{\rm elisp form}
\metax{\kbd{[[external link][description]]}}{\rm optional link text}
%\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
\section{Tables}
%Org-mode has its own built-in intuitive table editor with unique
@ -500,11 +423,98 @@ formula, \kbd{:=} a named-field formula.
\key{recognize existing table.el table}{C-c C-c}
\key{convert table (Org-mode $\leftrightarrow$ table.el)}{C-c ~}
\section{Links}
\key{globally store link to the current location}{C-c l$^1$}
\key{insert a link (TAB completes stored links)}{C-c C-l}
\key{insert file link with file name completion}{C-u C-c C-l}
\key{edit (also hidden part of) link at point}{C-c C-l}
\key{open file links in emacs (\kbd{C-u} : in emacs)}{C-c C-o}
\key{open link at point (3: in emacs)}{mouse-2/3}
%\key{open file links in emacs}{mouse-3}
%\key{record a position in mark ring}{C-c \%}
\key{jump back to last followed link(s)}{C-c \&}
{\bf Internal Links}
\key{\kbd{<<My Target>>}}{\rm target}
\key{\kbd{<<<My Target>>>}}{\rm radio target$^2$}
\key{\kbd{[[*this text]]}}{\rm find headline}
\metax{\kbd{[[this text]]}}{\rm find target or text in buffer}
\metax{\kbd{[[this text][description]]}}{\rm optional link text}
{\bf External Links}
\key{\kbd{file:/home/dominik/img/mars.jpg}}{\rm file, absolute}
\key{\kbd{file:papers/last.pdf}}{\rm file, relative}
\key{\kbd{file:projects.org::*that text}}{\rm find headline}
\key{\kbd{file:projects.org::find me}}{\rm find tgt/string}
%\key{\kbd{file:projects.org::/regexp/}}{\rm regexp search}
\key{\kbd{http://www.astro.uva.nl/~dominik}}{\rm on the web}
\key{\kbd{mailto:adent@galaxy.net}}{\rm EMail address}
\key{\kbd{news:comp.emacs}}{\rm Usenet group}
\key{\kbd{bbdb:Richard Stallman}}{\rm BBDB person}
\key{\kbd{gnus:group}}{\rm GNUS group}
\key{\kbd{gnus:group\#id}}{\rm GNUS message}
\key{\kbd{vm|wl|mhe|rmail:folder}}{\rm Mail folder}
\key{\kbd{vm|wl|mhe|rmail:folder\#id}}{\rm Mail message}
\key{\kbd{info:emacs:Regexps}}{\rm Info file:node}
\key{\kbd{shell:ls *.org}}{\rm shell command}
\key{\kbd{elisp:(calendar)}}{\rm elisp form}
\metax{\kbd{[[external link][description]]}}{\rm optional link text}
%\key{\kbd{vm://myself@some.where.org/folder\#id}}{\rm VM remote}
\section{TODO Items}
\key{rotate the state of the current item}{C-c C-t}
\key{view TODO items in a sparse tree}{C-c C-v}
\key{view 3rd TODO keyword's sparse tree}{C-3 C-c C-v}
\key{set the priority of the current item}{C-c , [ABC]}
\key{remove priority cookie from current item}{C-c , SPC}
\key{raise priority of current item}{S-UP$^3$}
\key{lower priority of current item}{S-DOWN$^3$}
\key{\kbd{\#+SEQ_TODO: TODO TRY BLUFF DONE}}{\rm todo workflow}
\key{\kbd{\#+TYP_TODO: Phil home work DONE}}{\rm todo types}
\section{Timestamps}
\key{prompt for date and insert timestamp}{C-c .}
\key{like \kbd{C-c} . but insert date and time format}{C-u C-c .}
\key{Like \kbd{C-c .} but make stamp inactive}{C-c !} % FIXME
\key{insert DEADLINE timestamp}{C-c C-d}
\key{insert SCHEDULED timestamp}{C-c C-s}
\key{create sparse tree with all deadlines due}{C-c C-w}
\key{the time between 2 dates in a time range}{C-c C-y}
\key{change timestamp at cursor by $\pm 1$ day}{S-RIGHT/LEFT$^3$}
\key{change year/month/day at cursor by $\pm 1$}{S-UP/DOWN$^3$}
\key{access the calendar for the current date}{C-c >}
\key{insert timestamp matching date in calendar}{C-c <}
\key{access agenda for current date}{C-c C-o}
\key{Select date while prompted}{mouse-1/RET}
%\key{... select date in calendar}{mouse-1/RET}
%\key{... scroll calendar back/forward one month}{< / >}
%\key{... forward/backward one day}{S-LEFT/RIGHT}
%\key{... forward/backward one week}{S-UP/DOWN}
%\key{... forward/backward one month}{M-S-LEFT/RIGT}
\newcolumn
\title{Org-Mode Reference Card (2/2)}
\centerline{(for version \orgversionnumber)}
\section{Clocking Time}
\key{start clock on current item}{C-c C-x C-i}
\key{stop clock on current item}{C-c C-x C-o}
\key{cancel current clock}{C-c C-x C-x}
\key{display total subtree times}{C-c C-x C-d}
\key{remove displayed times}{C-c C-c}
\section{Agenda Views}
\key{add/move current file to front of agenda}{C-c [}
@ -563,6 +573,12 @@ To set categories, add lines like$^2$:
\key{change timestamp to today}{>}
\key{insert new entry into diary}{i}
\key{Start the clock on current item (clock-in)}{I}
\key{Stop the clock (clock-out)}{O}
\key{Cancel current clock}{X}
\newcolumn
{\bf Calendar commands}
\key{find agenda cursor date in calendar}{c}
@ -577,23 +593,16 @@ To set categories, add lines like$^2$:
\key{quit agenda, remove agenda buffer}{q}
\key{exit agenda, remove all agenda buffers}{x}
\section{Exporting}
\section{Exporting and Publishing}
Exporting creates files with extensions {\it .txt\/} and {\it .html\/}
in the current directory.
in the current directory. Publishing puts the resulting file into
some other place.
\key{export as ASCII file}{C-c C-x a}
\key{export visible text only (e.g. for printing)}{C-c C-x v}
\key{export as HTML file}{C-c C-x h}
\key{export as HTML and open in browser}{C-c C-x b}
\key{prefix arg sets nb. of headline levels, e.g.}{C-3 C-c C-x h}
\key{export as iCalendar file}{C-c C-x i}
\key{export all agenda files as iCalendar files}{C-c C-x C-i}
\key{combine all agenda files to single iCal file}{C-c C-x C-c}
\key{export/publish dispatcher}{C-c C-e}
\key{export visible part only}{C-c C-e v}
\key{insert template of export options}{C-c C-x t}
\key{toggle fixed width for entry or region}{C-c :}
{\bf HTML formatting}
@ -642,13 +651,6 @@ Subtrees whose header starts with COMMENT are never exported.
\key{toggle COMMENT keyword on entry}{C-c ;}
\section{Publishing (requires org-publish.el)}
\key{publishcurrent file}{C-c C-e C-f}
\key{publish current project}{C-c C-e C-p}
\key{publish project (prompted for)}{C-c C-e C-c}
\key{publish all projects}{C-c C-e C-a}
\section{Completion}
In-buffer completion completes TODO keywords at headline start, TeX