From 09ce05493102645948c2faacb2e6748b00dd9eed Mon Sep 17 00:00:00 2001 From: Carsten Dominik Date: Thu, 31 Jan 2008 11:33:32 +0100 Subject: [PATCH] Release 4.60 --- org | 574 +++++++++++++++++++++++--------------- org.el | 665 +++++++++++++++++++++++++++++---------------- org.pdf | Bin 638748 -> 651080 bytes org.texi | 201 ++++++++++++-- orgcard.pdf | Bin 59989 -> 58067 bytes orgcard.tex | 2 +- xemacs/noutline.el | 35 ++- 7 files changed, 986 insertions(+), 491 deletions(-) diff --git a/org b/org index 76a1f0d66..d1331b876 100644 --- a/org +++ b/org @@ -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.59). + This manual is for Org-mode (version 4.60). 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.59). +This manual is for Org-mode (version 4.60). Copyright (C) 2004, 2005, 2006 Free Software Foundation @@ -149,6 +149,7 @@ Creating timestamps Progress Logging * Closing items:: When was this entry marked DONE? +* Tracking TODO state changes:: When did the status change? * Clocking work time:: When exactly did you work on this item? Tags @@ -203,6 +204,14 @@ Exporting * iCalendar export:: Exporting in iCalendar format * Text interpretation:: How the exporter looks at the file +HTML export + +* Export commands:: How to invode HTML export +* Quoting HTML tags:: Using direct HTML in Org-mode +* Links:: How hyperlinks get transferred to HTML +* Images:: To inline or not to inline? +* CSS support:: Style specifications + Text interpretation by the exporter * Comment lines:: Some lines will not be exported @@ -537,7 +546,8 @@ the visibility in the buffer. Reveal context around point, showing the current entry, the following heading and the hierarchy above. Useful for working near a location exposed by a sparse tree command (*note Sparse - trees::) or an agenda command (*note Agenda commands::). + trees::) or an agenda command (*note Agenda commands::). With + prefix arg show, on each level, all sibling headings. `C-c C-x b' Show the current subtree in an indirect buffer(3). With numerical @@ -802,8 +812,9 @@ only the visible part of the document and print the resulting file. ---------- Footnotes ---------- - (1) See also the variables `org-show-hierarchy-above' and -`org-show-following-heading'. + (1) See also the variables `org-show-hierarchy-above', +`org-show-following-heading', and `org-show-siblings' for detailed +control on how much context is shown around each match. (2) This does not work under XEmacs, because XEmacs uses selective display for outlining, not text properties. @@ -1679,10 +1690,15 @@ format::), for example: [[http://www.gnu.org/software/emacs/][GNU Emacs]] +If the description is a file name or URL that points to an image, HTML +export (*note HTML export::) will inline the image as a clickable +button. If there is no description at all and the link points to an +image, that image will be inlined into the exported HTML file. + Org-mode also finds external links in the normal text and activates them as links. If spaces must be part of the link (for example in -`bbdb:Richard Stallman'), or you need to remove ambiguities about the -end of the link, enclose them in angular brackets. +`bbdb:Richard Stallman'), or if you need to remove ambiguities about +the end of the link, enclose them in angular brackets.  File: org, Node: Handling links, Next: Link abbreviations, Prev: External links, Up: Hyperlinks @@ -2085,7 +2101,9 @@ from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may also use a prefix argument to quickly select a specific state. For example `C-3 C-c C-t' will change the state immediately to VERIFY. If you define many keywords, you can use in-buffer completion (see *Note -Completion::) to insert these words into the buffer. +Completion::) to insert these words into the buffer. Changing a todo +state can be logged with a timestamp, see *Note Tracking TODO state +changes:: for more information.  File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions @@ -2564,40 +2582,72 @@ File: org, Node: Progress logging, Prev: Custom time format, Up: Timestamps ==================== 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. +as DONE, or even each time when you change the state of a TODO item. +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 marked DONE? +* Tracking TODO state changes:: When did the status change? * 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 +File: org, Node: Closing items, Next: Tracking TODO state changes, Prev: Progress logging, Up: Progress logging 6.4.1 Closing items ------------------- If you want to keep track of _when_ a certain TODO item was finished, -turn on logging with +turn on logging with(1) (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. See the variable `org-log-done' for the -possibility to record an additional note together with a timestamp. +entry back into a TODO item 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. If you want to record a note along with +the timestamp, use(2) + + (setq org-log-done '(done)) + + ---------- Footnotes ---------- + + (1) The corresponding in-buffer setting is: `#+STARTUP: logdone' + + (2) The corresponding in-buffer setting is: `#+STARTUP: lognotedone'  -File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging +File: org, Node: Tracking TODO state changes, Next: Clocking work time, Prev: Closing items, Up: Progress logging -6.4.2 Clocking work time +6.4.2 Tracking TODO state changes +--------------------------------- + +When TODO keywords are used as workflow states (*note Workflow +states::), you might want to keep track of when a state change occurred, +and you may even want to attach notes to that state change. With the +setting + + (setq org-log-done '(state)) + +each state change will prompt you for a note that will be attached to +the current headline. Very likely you do not want this verbose tracking +all the time, so it is probably better to configure this behavior with +in-buffer options. For example, if you are tracking purchases, put +these into a separate file that starts with: + + #+SEQ_TODO: TODO ORDERED INVOICE PAYED RECEIVED SENT + #+STARTUP: lognotestate + + +File: org, Node: Clocking work time, Prev: Tracking TODO state changes, Up: Progress logging + +6.4.3 Clocking work time ------------------------ Org-mode allows you to clock the time you spent on specific tasks in a @@ -2615,7 +2665,8 @@ also computes the total time spent on each subtree of a project. 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'. See the variable `org-log-done' for the possibility to - record an additional note together with the clock-out time stamp. + record an additional note together with the clock-out time + stamp(1). `C-c C-y' Recompute the time interval after changing one of the time stamps. @@ -2658,7 +2709,7 @@ also computes the total time spent on each subtree of a project. #+BEGIN: clocktable :maxlevel 2 :block today #+END: clocktable - and to use a specific time range you could write(1) + and to use a specific time range you could write(2) #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>" :tend "<2006-08-10 Thu 12:00>" @@ -2674,7 +2725,10 @@ worked on or closed during a day. ---------- Footnotes ---------- - (1) Note that all parameters must be specified in a single line - + (1) The corresponding in-buffer setting is: `#+STARTUP: +lognoteclock-out' + + (2) Note that all parameters must be specified in a single line - the line is broken here only to fit it onto the manual.  @@ -4043,6 +4097,20 @@ Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive HTML formatting, in ways similar to John Grubers _markdown_ language, but with additional support for tables. +* Menu: + +* Export commands:: How to invode HTML export +* Quoting HTML tags:: Using direct HTML in Org-mode +* Links:: How hyperlinks get transferred to HTML +* Images:: To inline or not to inline? +* CSS support:: Style specifications + + +File: org, Node: Export commands, Next: Quoting HTML tags, Prev: HTML export, Up: HTML export + +10.2.1 HTML export commands +--------------------------- + `C-c C-e h' Export as HTML file `myfile.html'. @@ -4064,11 +4132,23 @@ example, creates two levels of headings and does the rest as items. - If you want to include HTML tags which should be interpreted as such, + +File: org, Node: Quoting HTML tags, Next: Links, Prev: Export commands, Up: HTML export + +10.2.2 Quoting HTML tags +------------------------ + +If you want to include HTML tags which should be interpreted as such, mark them with `@' as in `@bold text@'. Plain `<' and `>' are always transformed to `<' and `>' in HTML export. - Internal links (*note Internal links::) will continue to work in HTML + +File: org, Node: Links, Next: Images, Prev: Quoting HTML tags, Up: HTML export + +10.2.3 Links +------------ + +Internal links (*note Internal links::) will continue to work in HTML files only if they match a dedicated `<>'. Automatic links created by radio targets (*note Radio targets::) will also work in the HTML file. Links to external files will still work if the HTML file is @@ -4078,7 +4158,38 @@ HTML version also exists of the linked file. For information related to linking files while publishing them to a publishing directory see *Note Publishing links::. - You can also give style information for the exported file. The HTML + +File: org, Node: Images, Next: CSS support, Prev: Links, Up: HTML export + +10.2.4 Images +------------- + +HTML export can inline images given as links in the Org-mode file, and +it can make an image the clickable part of a link. By default(1), +images are inlined if a link does not have a description. So +`[[file:myimg.jpg]]' will be inlined, while `[[file:myimg.jpg][the +image]]' will just produce a link `the image' that points to the image. +If the description part itself is a `file:' link or a `http:' URL +pointing to an image, this image will be inlined and activated so that +clicking on the image will activate the link. For example, to include +a thumbnail that will link to a high resolution version of the image, +you could use: + + [[file:highres.jpg][file:thumb.jpg]] + +and you could use `http' addresses just as well. + + ---------- Footnotes ---------- + + (1) but see the variable `org-export-html-inline-images' + + +File: org, Node: CSS support, Prev: Images, Up: HTML export + +10.2.5 CSS support +------------------ + +You can also give style information for the exported file. The HTML exporter assigns the following CSS classes to appropriate parts of the document - your style specifications may change these: .todo TODO keywords @@ -4091,9 +4202,9 @@ document - your style specifications may change these: The default style specification can be configured through the option `org-export-html-style'. If you want to use a file-local style, you may use file variables, best wrapped into a COMMENT section at the end -of the outline tree. For example: +of the outline tree. For example(1): - * COMMENT HTML style specifications + * COMMENT html style specifications # Local Variables: # org-export-html-style: "