Org-mode list of user-visible changes

Table of Contents

Version 6.03

Overview

  • Description lists are now supported natively
  • Block quotes for export
  • Fontified code examples in HTML export
  • Include files for export
  • Text before the first headline is now exported by default
  • In-buffer options may now be collected in an external file
  • The in-buffer settings keywords may now be lower case
  • Completion of structure elements
  • Startup visibility can now be influenced by properties
  • Clock task history, moving entries with the running clock
  • BBDB anniversaries much faster
  • New contrib files: org-eval.el and org-mtags.el

Incompatible changes

  • The text before the first headline is now exported by default

    Previously, the default was to not include text in an org-mode buffer before the first headline. From now on, the default it to include it. If you like the old default better, customize the variable org-export-skip-text-before-1st-heading or set the value on a per-file basis with

    #+OPTIONS: skip:t
    

Details

Description lists are now supported natively

A plain list will be exported as a description list if the first item in the list has a term and the description, separated by " :: ". For example

 Emacs software by Carsten Dominik
 - RefTeX    :: Support for LaTeX Labels, References, Citations
 - CDLaTeX   :: more LaTeX functionality for Emacs
 - TeXmathp  :: checking LaTeX buffers for Math mode.
 - ORG       :: An Emacs mode for notes and projet planning.
 - CONSTANTS :: An Emacs package for inserting the definition of
                natural constants and units into a buffer.
 - IDLWAVE   :: The Emacs modes for editing and
                running IDL and WAVE CL files.

will be rendered as

Emacs software by Carsten Dominik

RefTeX
Support for LaTeX Labels, References, Citations
CDLaTeX
more LaTeX functionality for Emacs
TeXmathp
checking LaTeX buffers for Math mode.
ORG
An Emacs mode for notes and projet planning.
CONSTANTS
An Emacs package for inserting the definition of natural constants and units into a buffer.
IDLWAVE
The Emacs modes for editing and running IDL and WAVE CL files.

This works now in the HTML exporter, we still need to supoort it with the LaTeX and ASCII exporters.

Block quotes for export

For quoting an entire paragraph as a citation, use

#+BEGIN_QUOTE
Everything should be made as simple as possible,
but not any simpler -- Albert Einstein
#+BEGIN_QUOTE

which will render as

Everything should be made as simple as possible, but not any simpler – Albert Einstein

Fontified code examples in HTML export

You can now get code examples fontified like they would be fontified in an Emacs Buffer, and export the result to HTML. To do so, wrap the code examples into the following structure:

#+BEGIN_SRC emacs-lisp
(defun org-xor (a b)
  "Exclusive or."
  (if a (not b) b))
#+END_SRC

In the export, this will then look like this (if you are now looking at the ASCII export and do not see anything interesting, go and check out the HTML version at http://orgmode.org/Changes.html).

(defun org-xor (a b)
  "Exclusive or."
  (if a (not b) b))

The string after the BEGIN_SRC is the name of the major emacs mode that should be used to fontify the code example, without the "-mode" at the end of the mode name. For example, if you are writing an Org tutorial with Org examples included, you would use "org" as the language identifier - in fact, I have used just that in the example above.

Currently this works only for HTML export, and requires the htmlize.el package, version 1.34 or later. For other backends, such structures are simply exported as EXAMPLE.

Include files for export

A line like

 #+INCLUDE "file" markup lang

will lead to the inclusion of the contents of FILE at the moment of publishing. FILE should be surrounded by double quotes, this is obligatory if it contains space characters. The parameters MARKUP and LANG are optional. MARKUP can be "example", "quote", or "src". If it is "src", LANG should be the name of the Emacs mode to be used for fontifying the code. For example:

 Here is my /.emacs/ file:
 #+INCLUDE "~/.emacs" src emacs-lisp

The text before the first headline is now exported by default

Previously, the default was to not include text in an org-mode buffer before the first headline. From now on, the default it to include it. If you like the old default better, customize the variable org-export-skip-text-before-1st-heading or set the value on a per-file basis with

 #+OPTIONS: skip:t

In-buffer options may now be collected in an external file

If you would like to share the Org setup between a number of files, you can now store in-buffer setup in a file and simply point to that file from each file that should read it. If you write in a buffer

 #+SETUPFILE: "path/to/setup.org"

then this file will be scanned for in-buffer options like #+STARTUP, #+TITLE, or #+OPTIONS.

The in-buffer settings keywords may now be upper or lower case

From now on, it makes no difference is you write #+STARTUP or #+startup, to make these lines less imposing. Similarly for all other in-buffer keywords.

Completion of structure elements

As a new experimental feature, Org now supports completion of structural elements like #+BEGIN_EXAMPLE in a special way. It work by typing, for example "<e" and then pressing TAB, on an otherwise empty line. "<e" will expand into a complete EXAMPLE template, with the cursor positioned in the middle. Currently supported templates are:

 <s   #+begin_src
 <e   #+begin_example
 <q   #+begin_quote
 <v   #+begin_verse
 <l   #+begin_latex
 <L   #+latex:
 <h   #+begin_html
 <H   #+html:
 <a   #+begin_ascii
 <i   #+include

This is an experimental feature, please comment! See also below under org-mtags.el.

Startup visibility can now be influenced by properties

When Emacs opens an Org mode buffer, the outline visibility is set to a startup value that is taken from the variable org-startup-folded, or from a #+STARTUP setting in the buffer. After this has happened, the buffer will now also be scanned for entries with a VISIBILITY property. Wherever such a property is found, the corresponding subtree will get its visibility adjusted. Allowed values for the property are:

folded
Fold the subtree
children
Show the text after the headline, and the headlines of all direct children
content
Show all headlines in the tree, but no text below any headline
all
Show the entire subtree

For example, I am using this for the huge Changes.org file that is the source for the list of visible changes you are reading right now. The top-most entry in this file always describes the changes in my current working version. The start of this section currently looks like this:

* Version 6.03
  :PROPERTIES:
    :VISIBILITY: content
  :END:
** Overview

This was a proposal by Ben Alexander.

The command C-u C-u TAB will switch back to the startup visibility of the buffer.

Clock task history, and moving entries with the running clock

Org now remembers the last 5 tasks that you clocked into, to make it easier to clock back into a task after interrupting it for another task.

  • C-u C-u C-c C-x C-i (or C-u C-u I from the agenda) will clock into that task and mark it as current default task.
  • C-u C-c C-x C-i (or C-u I from the agenda) will offer a list of recently clocked tasks, including the default task, for selection. d selects the default task, i selects the task that was interrupted by the task that is currently being clocked. 1,… selects a recent task. When you select a task, you will be clocked into it.
  • You can use C-u C-c C-x C-j to jump to any of these tasks.

When moving an entry using structure editing commands, archiving commands, or the special subtree cut-and-paste commands C-c C-x C-w and C-c C-x C-y, the running clock marker and all clock history markers will be moved with the subtree. Now you can start a clock in a remember buffer and keep the clock running while filing the note away. See also the variable `org-remember-clock-out-on-exit'.

BBDB anniversaries much faster

bbdb-anniversaries is now much faster, thanks to a new approach using a hash for birthdays. Thanks to Thomas Baumann for a patch to this effect.

New files in the contrib directory

Do people think any of these should become core?

org-eval.el
This new module allows to include the result of the evaluation of Lisp code (and other scripting languages) into the buffer, similar to the <lisp> tag of Emacs Wiki and Muse.
org-mtags.el
This new modules allows you to use Muse-like tags for some structure definitions in Org. For example, instead of
#+BEGIN_EXAMPLE
...
#+END_EXAMPLE
you can write
<example>
...
</example>
In fact, I myself find these easier to type and to look at. Also, it will allow you to more easily move text and files back and forth between Org and Muse. For a list of supported structure elements, see the commentary in the file commentary in the file org-mtags.el.

If you load this module and use the "<i" etc completion described above, the Muse form will automatically be inserted.

Bug fixes

Many bug fixes again. Will this ever stop?

Version 6.02

Overview

  • Column view (mostly) works now in XEmacs
  • Summaries for columns in the agenda
  • The special property Effort can be used for effort estimates
  • New operators for property searches
  • Search commands can now include archive files.
  • Clock tables can include the archive files
  • Orgtbl radio tables generalized.

Details

Column view works now in XEmacs

I had already given up on this, but Greg Chernev (who implemented noutline.el for XEmacs and in this way kept Org alive on XEmacs) has done it again and provided the patches to make column view work under XEmacs. There are still some problems, but the basics work and we will iron out the remaining issues, hopefully soon.

Summaries for columns in the agenda

If any of the columns has a summary type defined, turning on column view in the agenda will show summaries for these columns. Org will first visit all relevant agenda files and make sure that the computations of this property are up to date. This is also true for the special CLOCKSUM property. Org will then sum the values displayed in the agenda. In the daily/weekly agenda, the sums will cover a single day, in all other views they cover the entire block. It is vital to realize that the agenda may show the same entry multiple times (for example as scheduled and as a deadline), and it may show two entries from the same hierarchy (for example a parent and it's child). In these cases, the summation in the agenda will lead to incorrect results because some values will count double.

The special property Effort can be used for effort estimates

If you want to plan your work in a very detailed way, or if you need to produce offers with quotations of the estimated work effort, you may want to assign effort estimates to entries. If you are also clocking your work, you may later want to compare the planned effort with the actual working time. Effort estimates can now be stored in a special property Effort, displayed side-to-side with clock sums, and also be summed over a day, in order to show the planned work load of a day. See the manual for more details.

New operators for property searches

Property searches can now choose a number of different operators for comparing values. These operators are `=', `<>', `<', `<=', `>', and `>='.

When the search term uses the operator with plain number like +Effort>=2.7, then the property value is converted to a number and a numerical comparison takes place.

When the search term uses a string on the right hand side of the operator, a string comparison is done: +PRIORITY<"C".

Finally, if the right hand side is enclosed in curly braces, a regexp match is done: aaa={regexp}. In this case you should use only the `=' or `<>' operators, meaning "does match" or "does not match", respectively.

This was a triggered with a request by Dan Davison.

Search commands can now include archive files.

If the value of the customization variable org-agenda-text-search-extra-files contains the symbol agenda-archives as the first element in the list, all archive files of all agenda files will be added to the list of files to search. This is relevant for the search view C-c a s, as well as for the agenda files multi-occur command C-c a /.

Clock tables can include the archive files

There are new values for the :scope parameter of a clock table. This can now be file-with-archives and agenda-with-archives, in order to collect information not only from the current file or all agenda files, but also from all archive files that are currently used by these files.

Orgtbl radio tables generalized.

The options available for radio tables using orgtbl-mode have been expanded. You may use several reception points and formats for the same table, you may have special formatting in the last line of the table, and many table parameters may be functions, so that more general transformations are possible. Jason Riedy provided a patch for this, and he will hopefully come up with some examples. Thanks!

Version 6.01

This is a new major release, mostly because of structural changes in Org. However, since this took a while, there is also a long list of small improvements and some new significant features.

Overview

  • The Org distribution has a new structure
  • New system for selecting modules to load
  • New archiving mechanism: The Archive Sibling
  • Support for Sebastian Rose's JavaScript org-info.js.
  • Internal links work now better in HTML export
  • Export commands can be done in the background
  • Flexible setting of the time block shown by the clock table
  • Clock table can be included in the agenda
  • Support for ISO week dates (ISO 6801)
  • Tag inheritance can be limited to a subset of all tags
  • Entries can be sorted by TODO keyword
  • And some more small fixes and improvements

Incompatible changes

The Org distribution has a new structure

In the distribution files as well as in the GIT repository, the lisp files are now located in a subdirectory "lisp", and the documentation files are located in a subdirectory "doc". If you are running Org directly from the unpacked distribution archive (zip or tar file, or GIT repository), you need to modify your settings for load-path accordingly.

Details

The Org distribution has a new structure

In the distribution files as well as in the GIT repository, the lisp files are now located in a subdirectory "lisp", and the documentation files are located in a subdirectory "doc". If you are running Org directly from the unpacked distribution archive (zip or tar file, or GIT repository), you need to modify your settings for load-path accordingly.

Loading modules

Org-mode has now a system for loading modules by simply configuring an option that lists all the modules you want to use. Customize the variable `org-modules'. That variable lists both modules that are part of the Org-mode core (and in this way part of Emacs), and modules that are contributed packages. Contributed modules will only be available when you have installed them properly (most likely by downloading the distribution and adding /path/to/orgdir/contrib/lisp to your load path).

New archiving mechanism: The Archive Sibling

There is a new method to archive entries in the current file: By moving it to a sibling called the Archive Sibling. That sibling has the heading "Archive" and also carries the ARCHIVE tag. This can be a great way to do archiving inside a project, to get parts of the project out of the way and to wait with true archiving (moving to another file) until the entire project is done. Archiving to a sibling keeps much of the context, for example inherited tags and approximate tree position in tact.

The key binding for the is "C-c C-x A", and from the agenda buffer you can simply use "A".

Thanks to Ilya Shlyakhter for this rather clever idea.

Support for Sebastian Rose's JavaScript org-info.js.

This fascinating program allows a completely new viewing experience for web pages created from Org files. The same document can be viewed in different ways, and switching between the views as well as navigation uses single-key commands.

One of the view types is an Info-like interface where you can jump through the sections of the document with the `n' and `p' keys (and others). There is also a folding interface where you can fold the document much like you can fold it in org-mode in Emacs, and cycle through the visibility both locally and globally.

To set this up, all you need to do is to make sure that org-infojs.el gets loaded (customize the variable org-modules to check). Then add this line to the buffer:

 #+INFOJS_OPT: view:info

In that line, you can configure the initial view and other settings. Available views are info for the info-like interface, and overview, content, and showall for the folding interface. See the manual for more details. The JavaScript program is served from http://orgmode.org/org-info.js, and your exported HTML files will automatically get it from there. However, you may want to be independent of the existence and stability of orgmode.org and install a copy locally. Then you need to change the path from which the script is loaded, either by using something like

 #+INFOJS_OPT: view:info path:../scripts/org-info.js

or by configuring the variable org-infojs-options.

For details see the documentation provided by Sebastian Rose together with org-info.js.

Export improvements

  • The export of internal links to HTML now works a lot better. Most internal links that work while editing an Org file inside Emacs will now also work the the corresponding HTML file.
  • You can run many of the export commands in the background by using `C-c C-u C-c C-e' in order to start the process. RIght now this will only work if "emacs" is the right command to get to your Emacs executable - I hope to make this less system dependent in the future.

Both these are based on requests by Ilya Shlyakhter.

Improvements to clocktable

  • The clocktable is now much more flexible and user friendly when trying to specify the time block that should be considered when constructing the table.

    The :block parameter to the table can now look like any of these:

    :blockmeaning
    2008The entire year 2008
    2008-04The month April 2008
    2008-04-02The day April 2, 2008
    2008-W14ISO-Week 14 in 2008
    todayToday
    today-5The day five days ago
    thisweekThe current week
    thisweek-2Two weeks ago
    thismonthThe current month
    thismonth-12Same month, last year
    lastmonthSame as thismonth-1

    What is more, you can now use the S-left and S-right keys to shift the time block around. The cursor needs to be in the #+BEGIN: clocktable line for this to work. If the current block is today, S-left with switch to yesterday. If the current block is 2008-W14, S-right will switch to the following week.

  • When the clocktable is collecting from several files, the total time for each file will now also be listed. This was a request from Bernt Hansen.
  • If you turn on the new clock report mode with the "R" key in the agenda, a clock table will be attached to the agenda, showing the clock report for the file scope and time interval of the agenda view. To turn this on permanently, configure the variable org-agenda-start-with-clock report-mode. To modify the properties of the table, in particular the :maxlevel depth, configure org-agenda-clockreport-parameter-plist.

Support for ISO week dates (ISO 6801)

The agenda now shows the ISO week for the displayed dates, in the form W08 for week 8.

The keys d, w, m, and y in the agenda view now accept prefix arguments. Remember that in the agenda, you can directly type a prefix argument by typing a number, no need to press C-u first. The prefix argument may be used to jump directly to a specific day of the year, ISO week, month, or year, respectively. For example, 32 d jumps to February 1st, 9 w to ISO week number 9. When setting day, week, or month view, a year may be encoded in the prefix argument as well. For example, 200712 w will jump to week 12 in the year 2007. If such a year specification has only one or two digits, it will be mapped to the interval 1938-2037.

When entering a date at the date prompt, you may now also specify an ISO week. For example

 w4              Monday of week 4
 fri w4          Friday of week 4
 w4-5            Same as above
 2012 w4 fri     Friday of week 4 in 2012.
 2012-W04-5      Same as above

So far I have not implemented the effect of `org-read-date-prefer-future' on this functionality, because it seemed too magic for me. I'd appreciate comments on this issue: Should `org-read-date-prefer-future' also push dates into the next year if the week you are entering has already passed in the current year? For consistency I guess this should be the case, but I cannot quite wrap my head around it.

I hope but am not entirely convinced that this will behave sanely also during the first/last week of a year. Please test extensively and report back.

This was a request by Thomas Baumann.

Improvements in Search View

  • Calling search view with a C-u prefix will make it match only in TODO entries.
  • The single quote is no longer considered a word character during search, so that searching for the word "Nasim" will also match in "Nasim's".

Misc

  • Inheritance of tags can now be limited to a subset of all tags, using the variable org-use-tag-inheritance. This variable may now be a regular expression or a list to select the inherited tags. Thanks to Michael Ekstrand for this excellent proposal.

    The regexp option is also implemented for org-use-property-inheritance, so that you can now select properties for inheritance my name.

  • The INHERIT flag to the function org-entry-get can be set to the symbol selective. If this is the case, then the value of the property will be retrieved using inheritance if and only if the setting in org-use-property-inheritance selects the property for inheritance.
  • There are now special faces for the date lines in the agenda/timeline buffers, and another special face for days that fall on a weekend: org-agenda-date and org-agenda-date-weekend. Both these faces are initially similar to the org-agenda-structure face, but you can customize them freely.
  • When an entry already has a scheduling or deadline time stamp, calling `C-c C-s' or `C-c C-d', respectively, will now use that old date as the default, and you can can use the "++4d" syntax to invoke shifts relative to that default date. Simply pressing RET at the prompt will keep the default date, not switch to today.

    This was an omission in the earlier implementation, spotted by Wanrong Lin. Thanks!

  • File names in remember templates can be relative, if they are, they will be interpreted relative to org-directory.
  • The handling of the clipboard when inserting into remember templates is now much better, and gives more control on what should be inserted with new %-escapes:
    • %c - Now always insert the head of the kill ring, never the X clipboard.
    • %x - Insert the content of the X clipboard. This is the first non-empty value from the PRIMARY, SECONDARY and CLIPBOARD X clipboards.
    • %^C - This allows the user to choose between any of the clipboard values available, the kill ring head, and the initial region if set.
    • %^L - Like %^C, but this inserts an org link using the selected value.

    Thanks to James TD Smith for this patch.

  • Table export to an internal file can now use a format specification, similar to the formats that are used by orgtbl radio tables. The default format is in the variable org-table-export-default-format. You can use properties TABLE_EXPORT_FILE and TABLE_EXPORT_FORMAT to specify the file name to which the export should go, and a local format. For example:

     :PROPERTIES:
     :TABLE_EXPORT_FILE: ~/xx.txt
     :TABLE_EXPORT_FORMAT: orgtbl-to-generic :splice t :sep "\t"
     :END:
    

    Thanks to James TD Smith for this patch.

  • Entries can be sorted by TODO keyword, and the order is given by the definition sequence of the TODO keywords in the variable org-todo-keywords, or in the #+TODO line. Use the "o" key when sorting with C-c ^.

    Thanks to James TD Smith for this patch.

Version 5.23

Overview

  • New keyword search agenda view
  • Many new extensions available in the CONTRIB directory
  • New remember template option: pre-selection contexts
  • Modifying list/headline status of a line
  • Granularity while editing time stamps
  • New repeaters mechanisms
  • New parameters for dynamic blocks ad the clock table
  • Limiting iCalendar export to fewer entries
  • M-RET splits lines again
  • New hooks

Incompatible changes

  • The variable `org-time-stamp-rounding-minutes' is now a list of two values - if you have configured this variable before, please do it again.

Details

New keyword search agenda view

`C-c a s' now invokes a special agenda view that can be used to search notes by keyword and regular expressions. In particular, it does not require a single regular expression or string to search for, but it can search for a number keywords or regexps that can occur in arbitrary sequence in the entry. The search knows the boundaries of an entry, can use simple Boolean logic and is reasonably fast. For example, the search string

 +computer +wifi -ethernet -{8\.11[bg]}

will search for note entries that contain the keywords computer and wifi, but not the keyword ethernet, and which are also not matched by the regular expression "8\.11[bg]", meaning to exclude both 8.11b and 8.11g. If the first character of the search string is an asterisk, the search will only look at headlines - otherwise it will look at the headine and the text below it, up to the next (possibly sub-) heading.

The command searches all agenda files, and in addition the files listed in org-agenda-text-search-extra-files.

I find it very useful to define a custom command to do such a search only in a limited number of files (my notes files), like this:

 ("N" "Search notes" search ""
   ((org-agenda-files '("~/org/notes.org" "~/org/computer.org"))
    (org-agenda-text-search-extra-files nil)))

Many new extensions available in the CONTRIB directory

  • Phil Jackson's org-irc.el is now part of the Org-mode core, which means it will become part of Emacs soon.
  • The new development model already starts to pay off, a number of interesting extensions are now part of the distribution. Check the file CONTRIB/README for a list.
  • There is a new variable `org-default-extensions'. Configuring this variable makes it very easy to load these default extensions - eventually this will be expanded to cover contributed extensions as well.

New remember template option: pre-selection contexts

  • Remember template definitions now allow six elements. The last element defines the contexts in which the template should be offered. It can be a list of major modes, a function, t or nil. If it is a list of major-mode, the template will be available only when org-remember is called from a buffer in one of these modes. If it is a function, the template will be offered only if the function returns `t' when called in the current buffer. A value of t or nil for this element means select this template in any context.

    One possible application for this would be to have several templates all using the same selection letter, and choosing the right one based on context. For example, think of tasks describing a bug in a source code file. With the following configuration we make sure that the bug reports are filed into the appropriate sections of the target file.

     (setq org-remember-templates
      '(("Elisp" ?b "* %a\n\n%i%?" "~/bugs.org" "Elisp bugs" (emacs-lisp-mode))
        ("C Bugs" ?b "* %a\n\n%i%?" "~/bugs.org" "C bugs" (cc-mode))))
    

    See (info "(org)Remember templates") for details.

Modifying list/headline status of a line

  • `C-c -' has now more functions:
    • In a table, add a hline as before
    • In an item list, cycle bullet type as before
    • In a normal line, turn it into an item
    • In a headline, turn it into an item
    • If there is an active region, turn each line into an item. But if the first region line is already an item, remove item markers from all lines.

    Based on proposals by Bastien.

  • `C-c *' has now more functions
    • in a table, recompute, as before
    • in a normal line, convert it to a sub heading.
    • at an item, convert it into a subheading
    • if there is an active region, convert all lines in the region to headlines. However, if the first lie already is a heading, remove the stars from all lines int he region.

    Based on proposals by Bastien.

Changes related to time stamps

  • The value variable org-time-stamp-rounding-minutes is now a list of two values. The first applies when creating a new time stamp. The second applies when modifying a timestamp with S-up/down. The default for this new task is 5 minutes, but 15 may also be a very good value for many people. If S-up/down is used on a time stamp where the minute part is not compatible with this granularity it will be made so. You can bypass this by using a prefix argument to exactly specify the number of minutes to shift.

    This was a proposal by Adam Spiers.

  • New repeaters that shift a date relative to today, or that make sure that the next date is in the future. For example:

    ** TODO Call Father
       DEADLINE: <2008-02-10 Sun ++1w>
       Marking this DONE will shift the date by at least one week,
       but also by as many weeks as it takes to get this date into
       the future.  However, it stays on a Sunday, even if you called
       and marked it done on Saturday.
    ** TODO Check the batteries in the smoke detectors
       DEADLINE: <2005-11-01 Tue .+1m>
       Marking this DONE will shift the date to one month after
       today.
    

    Proposed by Wanrong Lin and Rainer Stengle.

New parameters for dynamic blocks ad the clock table

  • There is a new :link parameter for the clocktable. When set, the headlines listed in the table will be links to the original headlines.
  • There is a new :content parameter that is passed to the writer function of the dynamic block. Use this parameter to pass the previous content of the block to the writer function, in case you want to make the outcome dependent on the previous content.

Limiting iCalendar export to fewer entries

  • New way to limit iCalendar export to the entries captured in an agenda view. This is done by "writing" the agenda view using `C-x C-w' to a file with extension .ics.

    This was a request by Kyle Sexton.

Misc

  • Due to a popular revolt shortly after the 5.22 release, M-RET can again be used to split a line so that the rest of the line becomes the new heading. However, if you do this in a heading containing tags, the tags will stay in the old line.

    Customize the variable org-M-RET-may-split-line if you don't want this command to split a line in the middle. The same variable also influences line splitting in items and in tables.

  • There are three new hooks:

    org-follow-link-hook: runs after following a link org-publish-before-export-hook: runs before export org-publish-after-export-hook: runs after export

Version 5.22

Incompatible changes

  • The variable `org-log-done' is now less complex.
  • The in-buffer settings for logging have changed. Some options no longer exists, some new ones have been added.

Details

Changes to logging progress

There is now more control over which state changes are being logged in what way. Please read carefully the corresponding sections in the manual. Basically:

  • The variable `org-log-done' has been simplified, it no longer influences logging state changes and clocking out.
  • There is a new variable for triggering note-taking when clocking out an item: `org-log-note-clock-out'.
  • Logging of state changes now has to be configured on a pre-keyword basis, either in `org-todo-keywords' or in the #+TODO in-buffer setting.
  • These per-keyword settings allow more control. For example

     WAIT(w@)    Record a note when entering this state.
     WAIT(w!)    Record a timestamp when entering this state.
     WAIT(w@/!)  Recore a note when entering and timestamp
                 when leaving this state.  This is great for
                 getting a record when switching *back* from
                  WAIT to TODO.
     WAIT(/!)    Record a timestamp when leaving this state.
                 Here we not even define a fast access
                 character, but just the logging stuff.
    

This was triggered by requests from Wanrong Lin and Bernt Hansen.

Other

  • M-RET no longer brakes a line in the middle, it will make a new line after the current or (if cursor is at the beginning of the line) before the current line.
  • RET, when executed in a headline after the main text and before the tags will leave the tags in the current line and create a new line below the current one.

Version 5.21

Bug fixes, in particular the long-hunted bug about wrong window positions after pressing SPACE in the agenda. Hopefully this is really fixed.

Version 5.20

Overview

Remember/Refile/Goto

  • The use of prefix arguments for the commands `org-remember' and `org-refile' has been normalized.
  • The clock can now safely be used in a remember buffer.
  • The variable `org-remember-use-refile-when-interactive' introduced only in 5.19 is already obsolete. Please use `org-remember-interactive-interface' instead.
  • It is no longer necessary to update the refiling targets.
  • Automatic isearch in `org-goto'.
  • Outline-path-completion as alternative org-goto interface.

Misc

  • Checkboxes now work hierarchically.
  • `C-k' can now behave specially in headlines.
  • Repeater for tasks in plain timestamps.
  • All clock intervals of an item show in agenda/timeline.
  • New parameter :step for clocktable, to get daily reports.
  • Never loose a repeaded scheduled item from the agenda.
  • Archiving a subtree now stores the outline path in a property.
  • Links to messages in Apple Mail.
  • Bug fixes.

Incompatible Changes

  • The variable `org-remember-use-refile-when-interactive' introduced only in 5.19 is already obsolete. Please use `org-remember-interactive-interface' instead.

Details

Remember/Refile/Goto

  • The use of prefix arguments for the commands `org-remember' and `org-refile' has been normalized:
    • when called without prefix argument, the command does its normal job, starting a remember note or refiling a tree.
    • when called with a single C-u prefix, these commands can be used to select a target location and to jump there. In the case of `org-remember', you will be prompted for a template and then Emacs jumps to the default target location or this template. In the case of `org-refile', you select a location from the refile target list and jump there.
    • when called with two prefixes (`C-u C-u'), the command jumps to the location last used for storing a note or a moved tree.
  • When the clock is running inside an remember buffer, storing the remember buffer with `C-c C-c' will automatically clock out. This was inspired by a request by Rainer Stengle.
  • The variable `org-remember-use-refile-when-interactive' introduced only in 5.19 is already obsolete. Please use `org-remember-interactive-interface' instead. This new variable does select the interface that is used to select the target for a remember note in an interactive way. Possible values are:
    • `outline': Use an outline of the document to select a location.
    • `outline-path-completion': Use completion of an outline path to select a location.
    • `refile': Offer the `org-refile-targets' as possible targets.
  • It is no longer necessary to update the refiling targets - they are always current.
  • In `org-goto', typing characters now automatically starts isearch from the beginning of the buffer. The isearch is special also because it only matches in headline. This goes some way toward saving org-goto from being removed from Org-mode. Thanks to Piotr Zielinski for the code, and sorry that it took me so long to put it in. If you prefer to use single letters n,p,f,b,u,q for navigation as before, configure the variable `org-goto-auto-isearch'.
  • Outline-path-completion is now available as an alternative interface in the command `org-goto'. Please select the default interface you'd like to use with the new variable `org-goto-interface'. You can then select the alternative interface with a prefix argument to `C-c C-j' (org-goto). I am considering to make outline-path-completion the default interface. Comments?

Misc

  • Checkboxes now work hierarchically. When a plain-list item with a checkbox has children with checkboxes, the status of the item's checkbox is calculated from the children, each time a checkbox is toggled with C-c C-c. Thanks to Miguel A. Figueroa-Villanueva for a patch to this effect.
  • There is a new variable `org-special-ctrl-k'. When set, `C-k' will behave specially in headlines:
    • When the cursor is at the beginning of a headline, kill the entire line and possible the folded subtree below the line.
    • When in the middle of the headline text, kill the headline up to the tags.
    • When after the headline text, kill the tags.

    This is following a proposal by Piotr Zielinski.

  • You can now also have a plain (as opposed to deadline or scheduled) repeater timestamp in a task. Switching the task to DONE will now also shift a plain time stamp. This was a request by Austin Frank.
  • If an entry is clocked multiple times, it will now show up several times in the agenda and timeline buffers, when log-mode is on. This was a proposal by Jurgen Defurne.
  • The clock table accepts a new parameter :step. This parameter can be `day' or `week' and will result in separate tables for each day or week in the requested time interval. This was triggered by a proposal by Sacha Chua in her blog.
  • A time-stamp with a repeater now no longer refers to the date closest to the current day. Instead, it means either today or the most recent match. This change makes sure that overdue scheduled or deadline items never disappear from the agenda. With the previous convention, an overdue scheduled item would disappear. For example, a weekly item scheduled for Sunday would appear as overdue until Wednesday, and the suddenly disappear until next Sunday. Now the item will show up as "Sched 7x" on Saturday. From Sunday on it will be in the list as "Scheduled", i.e. old sins will be forgiven. This follows a request by Warong, Dennis and Bernt.
  • Archiving a subtree now creates an additional property, ARCHIVE_OLPATH. This property contains the "path" in the outline tree to the archived entry, as it was in the original file. For example, archiving Fix the door in the following hierarchy

     * Tasks
     ** HOME
     *** Garage
     **** Fix the door
    

    will file is with the following property

     :ARCHIVE_PATH: Task/HOME/Garage
    

    Note that you can configure (i.e. limit) the information that gets stored upon archiving with the variable `org-archive-save-context-info'.

  • New file `org-mac-message.el' by John Wiegley to create links for messages in Apple Mail, and to follow these links.
  • Bug fixes.

Version 5.19

Overview

  • Column view can list the clocked times of a subtree.
  • Storing remember notes can use the `org-refile' interface.
  • Storing remember notes no longer produced empty lines.
  • Moving subtrees now folds all siblings of the subtree.
  • New variable `org-agenda-todo-keyword-format'.
  • Hack to allow brackets in link descriptions.
  • Clocking into an entry can enforce a specific TODO state.
  • EXPORT_FILE_NAME may be an absolute file name with "~".
  • Bug fixes, lots of them.

Details

  • A new special column definition lists the sum of all CLOCK entries in a subtree. For example

     #+COLUMNS: %20ITEM %10Time_Estimate{:} %CLOCKSUM
    

    will allow you to compare estimated times (as given in the Time_Estimate property) with the clocked times. This was a request by Bernt Hansen.

  • Storing remember notes can now use the `org-refile' interface instead of the `org-goto' interface (see the variable `org-remember-use-refile-when-interactive'). Nothing will change if the note is stored immediately after pressing `C-c C-c' in the *Remember* buffer. But if you have chosen (e.g. by pressing `C-u C-c C-c') to interactively select the filing location (file and headline), the refile interface will be used instead. I am excited about this change, because the `org-goto' interface is basically a failure, at least for this application. Note that in any case the refile interface has to be configured first by customizing `org-refile-targets'.
  • Notes inserted with remember now remove any whitespace before and after the note before being pasted, so that there will be no empty lines inserted together with the note. We could invent special syntax in remember templates to allow creating empty lines before a note - is there anyone who'd want this?
  • Moving subtrees now folds all siblings of the subtree. This is the only reasonably simple way I could find to avoid the reported inconsistencies in the folding state of the outline tree after moving entries. There are reasons to like this new behavior, because it easily visualizes where the tree is located after the move. Still, not everyone might be happy with this. Massive complaining would be needed to make me fix this.
  • New variable `org-agenda-todo-keyword-format' to specify the width of the TODO keyword field in the agenda display. Use it to get things to line up better. This was a proposal by Rainer Stengele.
  • If a link description inserted with `C-c C-l' contains brackets, the brackets will now be converted into curly braces. This looks similar enough. Supporting brackets in link descriptions is, for technical reasons too long to explain here, complex.
  • The new option `org-clock-in-switch-to-state' can be set to a TODO state that will be enforced when the clock is started on an entry. This follows an idea by Sacha Chua.
  • The EXPORT_FILE_NAME property may now also be an absolute file name, and it may contain abbreviations like "~" for the users home directory. This was requested by Adam Spiers.
  • Bug fixes, lots of them.

Version 5.18

Minor fixes.

Version 5.17

Details

Whitespace

  • When cutting, pasting, or moving subtrees and items, the empty lines before the subtree/item now belong to the part and will be moved with it. There is one exception to this rule: If the first child is moved down (or, equivalently, the second is moved up), the amount of empty lines above the first child to be moved along with it is limited by the number of empty lines below it. This sounds complicated, but it allows to have extra empty space before the first child and still have good behavior of the subtree motion commands.
  • Plain lists items work the same.

I believe we have finally nailed this one. Thanks to Daniel Pittman for bring this up again and to Eric Schulte for pointing out that it is the empty lines before an entry that really count.

This change was non-trivial, please give it a good test and let me know about any problems.

Remember

  • The new command `org-remember-goto-last-stored' will jump to the location of the remember note stored most recently. If you have `org-remember' on a key like `C-c r', then you can go to the location with a double prefix arg: `C-u C-u C-c r'. This was a proposal by Rainer Stengele.
  • Template items that are being prompted for can now specify a default value and a completion table. Furthermore, previous inputs at a specific prompt are captured in a history variable. For example:

     %^{Author|Roald Dahl|Thomas Mann|Larry Niven}
    

    will prompt for an author name. Pressing RET without typing anything will select "Roald Dahl". Completion will give you any of the three names. And a history will be kept, so you can use the arrow keys to get to previous input. The history is tied to the prompt. By using the same prompt in different templates, you can build a history across templates. The ideas for this came from proposals by Bastien and Adam.

  • When a remember template contains the string `%!', the note will be stored immediately after all template parts have been filled in, so you don't even have to press `C-c C-c'. The was a proposal by Adam Spiers.

Refile

  • `org-refile-targets' has a new parameter to specify a maximum level for target selection. Thanks to Wanrong Lin for this proposal.
  • When the new option `org-refile-use-outline-path' is set, refile targets will be presented like a file path to the completion interface: "level 1/level 2/level 3". This may be the fastest interface yet to get to a certain outline entry. Do we need to use this interface in other places? Thanks to Jose Ruiz for this proposal.

Version 5.16

Details

Restriction lock on agenda scope

You can now permanently lock the agenda construction to a certain scope, like a file or a subtree. So instead of pressing "<" for each command in the agenda dispatcher, you only once select a restriction scope. All subsequent agenda commands will than respect this restriction. For example, you can use this at work, to limit agendas to your work file or tree, and at home to limit to the home file or tree. Or you can use it during the day in order to focus in on certain projects.

You select a scope with the command `C-c C-x <', which restricts to the current subtree. When called with a `C-u' prefix, the restriction is to the current file. You can also make restrictions from the speedbar frame, see below.

When making a new restriction and an agenda window is currently visible, it will immediately be updated to reflect the new scope. If you like you can display an agenda view and then watch it change in various scopes.

To get rid of the restriction, use the command "C-c C-x >". Or press ">" in the agenda dispatcher. Also, and use of "<" in the dispatcher will disable the restriction lock and select a new restriction.

Thanks to Rick Moynihan for triggering this development.

Imenu and Speedbar support

  • Org-mode now supports Imenu. For example, with the setting

     (add-hook 'org-mode-hook 
        (lambda () 'imenu-add-to-menubar "Imenu"))
    

    a menu will be created in each Org-mode buffer that provides access to all level 1 and level 2 headings. The depth of the menu can be set with the variable `org-imenu-depth'.

  • org-mode now supports Speedbar. This means that you can drill into the first and second level headlines of an Org-mode file right from the speedbar frame.
  • You can set a restriction lock for the Org-mode agenda to a file or a subtree directly from the speedbar frame. Just press "<" with the cursor on an Org-mode file or subtree to set the lock and immediately update the agenda if it is visible. Use ">" to get rid of the lock again.

Version 5.15

Details

  • There are new special properties TIMESTAMP and TIMESTAMP_IA. These can be used to access the first keyword-less active and inactive timestamp in an entry, respectively.
  • New variable `org-clock-heading-function'. It can be set to a function that creates the string shown in the mode line when a clock is running. Thanks to Tom Weissmann for this idea.
  • Bug fixes.

Version 5.14

Overview

  • Remember and related stuff
    • New command `org-refile' to quickly move a note.
    • Easy way to jump to the target location of remember template.
    • New %-escapes in remember templates: %c %(…) and %[…]
    • `org-remember-insinuate' simplifies remember setup
  • Emphasis and Font-lock stuff
    • Stacked emphasis is no longer allowed.
    • You may finally emphasize a single character like *a*.
    • Font-lock now can hide the emphasis markers
    • Text in the "=" emphasis is exported verbatim
    • There is a new emphasis marker "~" for verbatim text
    • Constructs treated specially by the exporters can be highlighted
  • Properties and Column view
    • More control over which properties use inheritance
    • CATEGORY="work" can now be used in a tags/property search
    • the {+} summary type can specify a printf-style output format
    • New currency summary type {$}
  • The date/time prompt
    • While entering data, watch live the current interpretation.
    • The date prompt now prefers to select the future
    • Easier modification of time in an existing time stamp.
  • Export
    • You can now export some special strings in HTML, like "…"
    • #+EMAIL: may contain several email addresses
  • Agenda
    • In the agenda, a few keys have changed: `g', `G', and `e'.
  • Miscellaneous
    • Class-dependent sectioning structures in LaTeX export.
    • Radio-lists modeled after the radio tables.
    • The default for `org-ellipsis' is back to nil
    • Support for pabbrev-mode
    • New variable `org-show-entry-below'.

Incompatible changes

  • If you have customized the variable `org-emphasis-alist' or org-export-emphasis-alist', you need to do it again by first canceling your customization and then adding it again.
  • I know that some people have defined their own private helper functions to select a specific remember template, without being prompted, like this:

     (defun my-remember-template-n ()
        (interactive)
        (org-remember ?n))
    

    You need to modify this. The character selecting the template must now be the second argument to `org-remember':

     (defun my-remember-template-n ()
        (interactive)
        (org-remember nil ?n))
    

  • `C-c C-w' now refiles an entry. To get a sparse tree of deadlines, use `C-c / d' instead.

Details

Remember and related stuff

  • New command `org-refile' to quickly move a note to a different place. It is bound to `C-c C-w'. The foremost application might be to put a note or task captured with `remember' into the proper list or project. The command offers a list of possible refiling targets for completion. These are headings under which the entry will be inserted as a subitem. By default, this will offer all top-level headings in the current buffer, but you can configure the variable `org-refile-targets' to get more complex definitions. For example:

     (setq org-refile-targets '((nil . (:level . 2))))
    

    selects all level 2 headlines in the current buffer as targets. And

     (setq org-refile-targets
          '((org-agenda-files . (:tag . "refile"))))
    

    searches all agenda files and selects headlines that are explicitly marked with the tag :refile: . Note that the list of targets is built upon first use only, to rebuilt it, call the command `C-c C-w' with a double prefix argument.

    This is based on an idea and example implementation by Max Mikhanosha. Many thanks Max.

  • You can now use a C-u prefix on `org-remember' to jump to the location where a specific templates stores its notes. For example, if you have `org-remember' bound to `C-c r', then `C-u C-c r n' will get you to the file and headline given in the template associated with the letter "n".

    This was proposed by someone, but I have lost track who. Sorry, and thanks anyway.

  • New %-escapes in remember templates:

     %c     insert the current clipboard, like C-y would do
     %(..)  evaluate Lisp expression and insert the result
     %[..]  include file
    

    Thanks to Adam Spiers and Tim O'Callaghan.

  • New function `org-remember-insinuate' that makes is easier to set Org-mode specific values for remember variables. Thanks to Michael Olson for this proposal. It is equivalent to:

     (require 'remember)
     (setq remember-annotation-functions '(org-remember-annotation))
     (setq remember-handler-functions '(org-remember-handler))
     (add-hook 'remember-mode-hook 'org-remember-apply-template))
    

    You might still want to set `org-default-notes-file' to provide a default for templates without a file, and `org-directory' to show where to find other org files.

Emphasis and Font-lock stuff

  • Stacked emphasis like */bold italic/* is no longer allowed.
  • You may finally emphasize a single character like *a*.
  • Font-lock now can hide the emphasis markers, just like Muse does. Configure the variable `org-hide-emphasis-markers' if you want this. Showing the characters continues to be the default in Org-mode.
  • Text in the "=" emphasis is now exported verbatim, i.e. no further parsing and interpretation of this text takes place. So you can write =quoted *xxx* a_x = b=. This and the following point implement a request by Daniel Clemente.
  • There is a new emphasis marker "~" which marks text to be exported verbatim, without special formatting. Inside an org-mode file, this text is highlighted with the org-verbatim face. I am not happy with the face yet (currently is is like org-code, but underlined), please suggest a better one.
  • Whether an emphasis environment is verbatim or not is now an extra flag in the variable `org-emphasis-alist'. If you have configured this variable, do it again by first canceling your customization to revert to the default, and then adding it again.
  • New variable `org-highlight-latex-fragments-and-specials'. When turned on, Org-mode will highlight all strings that are treated in a special way by the exporters. This is great for export-oriented writing, but maybe a bit noisy for note taking, so this feature is off by default.

Properties and Column view

  • `org-use-property-inheritance' may now also be a list of property names that should be treated with inheritance during searches.
  • CATEGORY="work" can now be used in a tags/property search, even if the category is not specified as a property in the entry, but rather is inherited or derived from #+CATEGORY. Thanks to Adam, Tim, and Bastien for an interesting discussion around this issue.
  • Summary type improvements in column view.
    • The {+} summary type can specify a printf-style output format for computed values like this: {+;%5.2f} This was triggered by a report by Levin.
    • New currency summary type {$}, which so far is just a shorthand for {+;%.2f}. Do we need to have a currency symbol in front of each value. Scott Jaderholm asked for this, but I am not sure if this is already what he meant.

The date/time prompt

There have been several small but very useful additions to the date prompt.

  • While entering data at the date prompt, the current interpretation of your input is shown next to your input in the minibuffer. I find this great to understand how the input works. If you find the extra stuff in the minibuffer annoying, turn it off with `org-read-date-display-live'.
  • The date prompt now prefers to select the future. If you enter a date without a month, and the day number is before today (for example, on the 16th of the month you enter "9"), Org-mode will assume next month. Similarly, if you enter a month and no year, next year will be assumed if the entered month is before the current, for example if you enter "May" in September. Thanks to John Rakestraw for this great suggestion. If you find it confusing, turn it off with `org-read-date-prefer-future'.
  • When modifying an existing date using `C-c .' at the stamp, the time or time range in the stamp are now offered as default input at the prompt. This goes a long way to simplifying the modification of an existing date. Thanks to Adam Spiers for this proposal.

Export (all implemented by Bastien…)

  • You can now export special strings in HTML. Here is the list of newly performed conversions:
    OrgDescriptionHTML
    \\-double backslash followed by minus&shy;
    --two dashes (minuses)&ndash;
    ---three dashes (minuses)&mdash;
    ...three dots&hellip;

    You can turn this globally on or off with `org-export-with-special-strings' or locally with "-:t" or "-:nil" in the #+OPTIONS line. Thanks to Adam Spiers for starting the discussion, and thanks to Daniel Clemente and William Henney for relevant inputs.

  • Comma-separated emails in #+EMAIL: are correctly exported. Thanks to Raman for pointing out this omission.

Agenda

  • In the agenda, a few keys have changed
     g  does now the same a "r", refresh current display,
        because "g" is the Emacs standard for "refresh"
     G  toggle the time grid, used to be "g"
     e  Execute another agenda command, pretty much the same as
        `C-c a', but shorter and keep the same agenda window.
    

Miscellaneous (much of it from Bastien)

  • You can now select the sectioning structure of your LaTeX export by setting it either globally (`org-export-latex-default-class') or locally in each Org file (with #+LaTeX_CLASS: myclass). You can also customize the list of available classes and their sectioning structures through the new `org-export-latex-classes' option. Thanks to Daniel for discussions and suggestion on this issue.
  • You can send and receive radio lists in HTML, LaTeX or TeXInfo, just as you send and receive radio tables. Check the documentation for details and examples.
  • The default for `org-ellipsis' is back to nil, some people seem to have had problems with the face as a default.
  • Support for pabbrev-mode, needs pabbrev version 1.1. Thanks to Phillip Lord for adapting his package to make this possible.
  • New variable `org-show-entry-below' to force context-showing commands to expose the body of a headline that is being shown. Thanks to Harald Weis for pointing out this omission.

Version 5.13i

Details

  • On the date/time prompt, you can now also answer with something like +2tue to pick the second tuesday from today. This was a proposal by Sacha Chua.
  • When interpopating into Lisp formulas in the spreadsheet, the values of constants and properties are no longer enclosed into parenthesis. When interpolating for calc, this still happens in order to allow expressions in constants. This problem was reported by Eddward DeVilla.
  • When a directory is listed in `org-agenda-files', all files with extension matched by the new variable `org-agenda-file-regexp' in that directory will be agenda files.
  • Bug fixes.

Version 5.13

Overview

  • Bug fixes and improvements in column view
    • All known bugs fixed.
    • A Column view can be captured into a dynamic block.
    • The ITEM column is formatted core compactly.
    • Also ITEM can be edited with `e'
  • The agenda dispatcher
    • `<' cycles through restriction states.
    • Multi-character access codes to commands (= sub-keymaps).
  • Sorting improvements
    • User-defined sorting keys.
    • Sorting by properties.
    • Sorting of plain lists.
  • HTML <div> structure
  • Other stuff
    • New variables, several of them.
    • Drawers can be set on a per-file basis.
    • Better control over priority fontification in agenda.
    • M-up and M-down now move the current line up and down.
    • Abort remember template selection with C-g.

Details

Bug fixes and improvements in column view

  • All the bugs described by Scott Jaderholm have been fixed (at least I hope so…).
  • You can now capture a column view into a dynamic block, for exporting or printing it. The column view can be
    • global, i.e. for the entire file
    • local, i.e. for the subtree where the dynamic block is
    • from an entry with a specific :ID: property.

    You can identify the entry whose column view you want to capture by assigning an :ID: property, and use that property in the dynamic block definition. For example:

     * Planning
       :PROPERTIES:
         :ID: planning-overview
       :END:
    
     [...]
    
     * The column view
     #+BEGIN: columnview :hlines 1 :id "planning-overview"
    
     #+END:
    

    Use `C-c C-x r' to insert such a dynamic block, and you will be prompted for the ID.

  • When the current column format displays TODO keyword, priority or tags, these parts are stripped from the content of the ITEM column, making for more compact and readable entries. When any of these "properties" are not listed in the current column format, they are instead retained in the ITEM column.
  • You can now also edit the ITEM column with `e'.

The agenda dispatcher

  • Instead of pressing `1' to restrict an agenda command to the current buffer, or `0' to restrict it to the current subtree or region, you can now also press `<' once or twice, respectively. This frees up `1' and `0' for user commands, a request by Bastien. In fact, "<" cycles through different restriction states. "1" and "0" are still available for backward compatibility, until you bind them to custom commands.
  • The access code to custom agenda commands can now contain several characters, effectively allowing to bundle several similar commands into a sub-keymap. This follows an excellent proposal by Adam Spiers. For example:

     (setq org-agenda-custom-commands
       '(("h" . "HOME + Name tag searches") ; describe prefix "h"
         ("hl" tags "+HOME+Lisa")
         ("hp" tags "+HOME+Peter")
         ("hk" tags "+HOME+Kim")))
    

  • The user function option in org-agenda-custom-commands may now also be a lambda expression, following a request by Adam Spiers.

Sorting improvements

We are using a new routine for sorting entries, courtesy of John Wiegley. Many thanks to John.

  • You can define your own function to extract a sorting key and in this way sort entries by anything you like.
  • Entries can now be sorted according to the value of a property.
  • Plain lists can be sorted.

HTML <div> structure

There is now a <div>-based structure in exported HTML.

  • The table of context is wrapped into a div with a class "table-of-contents".
  • The outline structure is embedded in <div> elements with classes "outline-1", "outline-2" etc.
  • The postamble, containing the author information and the date is wrapped into a div with class "postamble".

I am not sure if the class names are the best choice, let me know if there are more "canonical" choices.

Thanks to Mike Newman and Cezar for input, and in particular to Mike for his clearly formulated specification.

Other stuff

  • New variable `org-agenda-window-frame-fractions' to customize the size limits of the agenda window in the case that you display the agenda window by reorganizing the frame.
  • Drawers can be set on a per-file basis using

     #+DRAWERS: HIDDEN STATE PROPERTIES
    

    This will define the drawers :HIDDEN: and :STATE:. The :PROPERTY: drawer should always be part of this list, or your properties will not be folded away. Thanks to Richard G. Riley for this proposal.

  • `org-agenda-fontify-priorities' may now also be an association list of priorities and faces, to specify the faces of priorities in the agenda individually.
  • The variable `org-export-with-property-drawer' no longer exists, please use `org-export-with-drawers' instead. Also, the corresponding switch in the #+OPTIONS line has changed from "p" to "d". Thanks to Bastien for pointing out that we needed to handle not only the property drawer.
  • M-up and M-down now move the current line up and down (if not at a headline, item or table). Among other things you can use this to re-order properties in the drawer. This was a proposal by Bastien.
  • New variable `org-agenda-todo-ignore-with-date', based on a request by Wanrong Lin.
  • Aborting remember template selection with C-g now kills the remember buffer and restores the old window configuration. This was a request by Nuutti Kotivuori.

Version 5.12

Overview

  • Remember templates can now have name.
  • `C-c C-k' will abort taking a note (remember of log)
  • `C-c C-x C-w' and `C-c C-x M-w' now accept a prefix arg.
  • Lines in the agenda can be fontified according to priority.
  • New variable `org-scheduled-past-days'.
  • New variables `org-agenda-deadline-leaders' and `org-agenda-scheduled-leaders'.
  • New sparse tree function `org-sparse-tree'.
  • The variable `org-ellipsis' now defaults to `org-link'.
  • The #+OPTIONS line has a new option "tags".
  • New variable `org-use-property-inheritance'.

Incompatible Changes

  • `C-c /' now calls `org-sparse-tree'.

Details

  • Remember templates can now have a template name as the first element. The name will be listed along with the selection character when prompting for a template. It is best to have the name start with the selection character, for example if you use ("Note" "n"), you will be prompted like "[n]ote". Thanks to Matiyam for this proposal.
  • `C-c C-k' will abort taking a note. You can use this in remember buffers and when taking a logging note (e.g. for a state change). Thanks to Bastien.
  • `C-c C-x C-w' and `C-c C-x M-w' now accept a prefix arg to cut N sequential subtrees. This was a proposal by John.
  • Lines in the agenda are now bold if they have priority A and italic if they have priority C. You can turn this off using the variable `org-agenda-fontify-priorities'. Thanks to John Wiegley for the idea and code.
  • New variable `org-scheduled-past-days' to set the number a scheduled item will be listed after its date has passed. Default is 10000, i.e. indefinitely.
  • New variables `org-agenda-deadline-leaders' and `org-agenda-scheduled-leaders' to adjust the leading text o scheduled items and deadline in the agenda. Thanks to John Wiegley for a patch.
  • New sparse tree function `org-sparse-tree'. This is now the default binding for `C-c /'. It requires one additional keypress to select a command, but in return is provides a single interface to all the different sparse tree commands, with full completion support.
  • The variable `org-ellipsis' now defaults to the face `org-link' because the visibility of the dots is really bad and I have found this change very useful indeed.
  • The #+OPTIONS line has a new option "tags" which can be used to set `org-export-with-tags'. Thanks to Wanrong Lin for this proposal.
  • New variable `org-use-property-inheritance'. Configure it to `t' if you want that searching for entries with certain properties always should assume inheritance. This is not well tested yet, please check it out.
  • Bug fixes

Version 5.11

Overview

  • SUMMARY, DESCRIPTION, LOCATION properties for iCalendar
  • Command to jump to the running clock
  • Clock entries can now have their own drawer
  • `C-c C-x C-r' only updates a clocktable at point
  • New way to assign a remember template to a single key
  • `C-n' and `C-p' are back to their default binding
  • `C-x C-s' in agenda buffer saves all org-mode buffers
  • Schedule/deadline leaves note in agenda buffer
  • Prefix argument for `C-c C-d/s' will remove date
  • New variable to make block aranda more compact
  • Better tag alignment in agenda

Incompatible changes

  • If you have customized `org-drawers', you need to add "CLOCK" to the list of drawers.
  • The variable `org-agenda-align-tags-to-column' has been renamed to `org-agenda-tags-column'. The old name is still an alias, in Emacs 22 and in XEmacs, but not in Emacs 21.
  • The default value for both `org-tags-column' and `org-agenda-tags-column' is now -80.
  • The variable `org-insert-labeled-timestamps-before-properties-drawer' is now obsolete.

Details

  • The LOGGING property allows to modify the settings for progress logging for a single entry. For example:

     :PROPERTIES:
       :LOGGING: nologging nologrepeat
     :END:
    

    turns off all progress logging for the current entry and its children.

  • The properties SUMMARY, DESCRIPTION and LOCATION have special meaning during iCalendar export, when they translate to the corresponding VEVENT and VTODO fields. If not given, Org-ode continues to use cleaned-up version of the headline and body as the summary and the description, respectively.
  • New function to go to the entry with the currently running clock. Bound to `C-c C-x C-j', in agenda also to "J". If you use this often, you might even want to assign a global key. Thanks to Bernt and Bastien.
  • Clock entries can now have their own drawer, the :CLOCK: drawer. Check out the variable `org-clock-into-drawer' for configuration of this feature. The default is to create a drawer when the second clocking line gets added to an entry. Note that "CLOCK" has been added to the default value of `org-drawers', but if you have configured that variable, you must go back and add "CLOCK" yourself to get this drawer folded away. Thanks to Tom Weissman for pointing out that too many clock entries are visually annoying.
  • `C-c C-x C-r' no longer tries to find the first clocktable in a buffer and then updates it. Instead, it will update the clocktable at point if there is one (same as C-c C-c will do if the cursor is in the "#+BEGIN" line of the table). If there is none at point, a new one will be inserted. This change was necessary because the new :scope parameter allows to have several clocktables in a buffer. Thanks to Bastien for pointing this out. To update all dynamic blocks in a file, use `C-u C-c C-x C-u'.
  • The function `org-remember' can now be called with a template selection key as argument. This helps to make key bindings that go directly to a specific template without being prompted for a template, like this:

     (global-set-key [f5] (lambda () (interactive) (org-remember "j")))
    

    Thanks to Richard G Riley for bringing this up.

  • `C-n' and `C-p' are back to their default binding (next/previous line) in the agenda buffer. Enough people, including recently Denis Bueno, have complained about this, and I agree it is not good to break habits like that.
  • `C-x C-s' in an agenda buffer now saves all org-mode buffers (also `s' does this).
  • Setting schedule or deadline dates from the agenda now produces a note in the agenda, similarly to what happens with S-left/right.
  • Using a prefix argument for `C-c C-d' or `C-c C-s' will remove the deadline or scheduling date from an item. Thanks to Wanrong Lin for this proposal.
  • New variable `org-agenda-compact-blocks'. When set, the space between blocks in a block agenda is reduced as much as possible, to show more items on a single screen.
  • The variable `org-agenda-tags-column' (renamed from `org-agenda-align-tags-to-column') can now also be negative, to mean alignment to the left. The new default is -80, just like it is now for `org-tags-column'.
  • Bug fixes

Version 5.10

Overview

  • Category and the archive location can be properties.
  • The clocktable has a new :scope parameter.
  • CSV support when importing a table.
  • Better defaults when modifying a time stamp.
  • New way to specify the duration of an appointment.
  • More aggressive version of orgstruct-mode improved wrapping.
  • Modifications to priority cycling.
  • Modifications to computations in column view.
  • New command `org-occur-in-agenda-files'.
  • Bug fixes.

Details

  • Both the category and the archive location in a (sub)tree of the buffer can now be specified using a property, for example:

     * Tree with special properties
       :PROPERTIES:
         :CATEGORY: Examples
         :ARCHIVE:  /some/special/file::
       :END:
    

    This is a much cleaner way of dealing with multiple categories and archives in a single file. The preferred use of the #+CATEGORY and #+ARCHIVE lines is now to set a single default for the file which is then locally overruled by properties. This was a proposal from Bastien if I remember correctly. Multiple #+ lines still work and I don't plan to remove this support soon, but I encourage you to stop using them.

  • The clocktable has a new :scope parameter that determines the range in the file from which clock entries should be taken. This can be anything from the local subtree to the entire buffer to even the full list of agenda files. Legal values are:
    valuescope
    nilthe current buffer or narrowed region
    filethe full current buffer
    subtreethe subtree where the clocktable is located
    treeNthe surrounding level N tree, for example tree3
    treethe surrounding level 1 tree
    agendaall agenda files

    Thanks to Jason F. McBrayer and Bernt Hansen for inspiration. Thanks to cranreuch (what is you full name?) for mentioning, at the right moment, that the clocktable is not so bad - that remark made it seem worthwhile to add features.

  • The commands to import a table and to convert a region to a table can now handle comma-separated values (CSV). The algorithm does not yet treat quoting correctly, but for basic input it works.
  • When modifying an existing time stamp, or when entering the second stamp of a range, the date prompt will now consistently default to the date/time in the existing stamp. This was triggered by Nuutti Kotivuori's request.
  • At the date/time prompt, there is a new way to specify a range of hours, by using "+DURATION" after the time. For example:

      14:00+2  means 14:00-16:00
      2pm+2:30 means 14:00-16:30
    

    Again, Nuutti Kotivuori's request.

  • When you use the function `turn-on-orgstruct++' to turn on orgstruct-mode, the special org-mode settings for auto-filling, indentation and paragraphs are exported into the buffer, so that typing list items with indentation works better. This was Bastien's idea and request.
  • New variable `org-priority-start-cycle-with-default'. When t (the default), priority cycling will initially set the default priority and then increase or decrease. When nil, the first priority set by cycling is already 1 different from the default priority. This was mostly driven by Bastien.
  • In column view: When an entry has a property for a summary column defined, its value is normally overwritten by the sum of all the children's values each time you enter column view. Now there is an exception to this rule: If none of the children has that particular property defined, the parent's value stays. In this way you can still place TODO items under such an entry without getting the property value changed. Thanks to Russel Adams for pointing out that this is a better way of doing things.
  • In column view, computed values are now bold face, and trying to edit them is an error. I think this works, but testing is appreciated.
  • New command `org-occur-in-agenda-files', this is basically the quick command John Wiegley proposed the other day, but it also works when the agenda files are not yet in buffers. The key is `C-c C-x /', any better proposals?
  • Links containing a space will now be handled correctly when calling the browser. Note that you need to enclose such links in square or angular brackets.
  • Bug fixes.

Version 5.09

Overview

  • Taking a note upon TODO state changes can be restricted to selected states.
  • The format in which dates are shown in the daily/weekly agenda can be configured.
  • The default for `org-remember-store-without-prompt' is now t.
  • `org-goto' has been made into a general lookup command.
  • Priority cycling goes back to the nil state.
  • You can store a remember note to the last used location.
  • On Emacs 23, the headline faces for org-mode are now inherited from the outline faces.

Incompatible Changes

  • The default for `org-remember-store-without-prompt' is now t, in order to better match the original intent of remember.el (storing a note with minimum interruption of work flow). I expect that many people will be hit by this incompatible change - nevertheless I believe it is the right thing to do.

Details

  • You can now select specific states for recording a note when switching to that state. With the setting

     #+SEQ_TODO: TODO(t) ORDERED(o@) INVOICE(i@) PAYED(p) | RECEIVED(r)
     #+STARTUP: lognotestate
    

    only the states ORDERED and INVOICE will record a timestamp and a note.

  • You can now set the format of the string for each day in the agenda and timeline buffers. You can use a format string interpreted by `format-time-string', or you can write your own function. Configure the new variable `org-agenda-format-date'. Thanks to Levin for triggering this development with a patch.
  • The default for `org-remember-store-without-prompt' is now t, in order to better match the original intent of remember.el (storing a note with minimum interruption of work flow). Since we can assign files and headlines to templates, I guess this takes care of selecting a filing location in most cases. For interactive filing, you now need a prefix command when exiting `remember'.
  • `org-goto' (bound to `C-c C-j') now uses an indirect buffer and has additional commands enabled: Org-occur with `C-c /' or even faster with `/', and the commands needed to select and copy a region. This make `org-goto' a more general lookup command instead of only a jumping command. Remember that you can exit with `Q' to go back to the original location. Thanks to William Henney for this idea.
  • Setting the priority with S-up/down now cycles back to a state where no priority is specified. This was requested by Rick Moynihan.
  • You can store a remember note to the last used location. So if you select a location interactively once, you can re-use it without having to find it again. For this, exit the remember buffer with `C-u C-u C-c C-c'. The leading comment in the remember buffer will tell exactly where the note goes if you exit with a particular command. Thanks to Maxim Loginov for this idea.
  • On Emacs 23, the headline faces for org-mode are now inherited from the outline faces. This is just a convenience, so that you only have to configure one set of faces, and that will then be outline-1 .. outline-8. You will actually not see any difference in org-mode, because Stefan Monnier has made the outline faces in Emacs 23 to match the current org-mode faces.

    This change does not effect XEmacs, nor Emacs 21 and 22.

Version 5.08

Incompatible changes

  • The default for `org-deadline-warning-days' is now 14.

Details

  • There is now a separate interface for fast and directly setting a TODO keyword. This interface kicks in when you have configured keys for TODO keywords like

     #+SEQ_TODO: TODO(t) WAITING(w) | DONE(d) CANCELED(c)
    

    C-c C-t still does the cycling thing, you need to use a prefix argument to get to the fast interface. Or configure the variable `org-use-fast-todo-selection' to t, then this will be the default and the prefix argument will make the command fall back to cycling.

    The tag selection no longer does include TODO keywords - Leo's arguments have convinced me that this is not a good idea. If you'd like to see the TODO keywords in the tags interface anyway, set the variable `org-fast-tag-selection-include-todo'. Thanks to Leo and others for input on this issue.

  • New variable `org-edit-timestamp-down-means-later'. When set, `S-down' on a timestamp will change the timestamp to later. Thanks to Raman for this idea.
  • Property names can now contain non-ascii word characters. This follows a request from Daniel Clemente.
  • For export, the date that should be given in the exported file can now be set to a specific value with a line like

     #+DATE: 15 November 2003
    

    If you want to use the date/time when the file was created, use a format string that will be interpreted by `format-time-string', for example:

     #+DATE: %Y/%m/%d %X
    

  • The default of `org-deadline-warning-days' has changed to 14 days. 30 was really too much, I suspect most people (me included) have changed this.
  • When a deadline has an individual lead time, this lead time obviously overrules `org-deadline-warning-days'. However, if you bind `org-deadline-warning-days' to a number <=0, for example during a custom agenda command, then the absolute value of this number will be enforced also when a different lead time has been specified. This is useful to get a list of all deadlines coming up in the next N days.

Version 5.07

Overview

  • Different faces for different TODO keywords.
  • Setting TODO states through the TAG setting interface.
  • Context information is stored when moving a tree to the archive.
  • Sorting can be done by priority.
  • `Org-ellipsis' can now also be a face.
  • Scheduling info is no longer removed entry is marked CLOSED.
  • Unavailable files in `org-agenda-files' can be skipped.

Incompatible changes

  • The time of archiving is now stored as a property. ARCHIVED is no longer a special time keyword.
  • Scheduling info is no longer removed entry is marked CLOSED.

Details

  • You can now define different faces for different TODO keywords. This request has come up frequently, so here it is: Use the variable `org-todo-keyword-faces'.

    A Here is a configuration example:

     (setq org-todo-keyword-faces
       '(("TODO"      . org-warning)
         ("DEFERRED"  . shadow)
         ("CANCELED"  . (:foreground "blue" :weight bold
                        :underline t))))
    

    Org-mode continue still use `org-todo' and `org-done' for keywords that have no specific face assigned.

  • Some People use TODO states more like tags. For them the TODO keywords mark special states and they like to quickly switch between states in arbitrary sequence. The standard TODO interface is not perfect for this, because it assumes that the states are reached in sequence. However, the fast tag setting interface is in fact perfect for this. You can now "misuse" the TAG selection interface to also set TODO states. All you need to do is to assign keys to the TODO states, just like you also do for tags.

     #+SEQ_TODO: TODO(t) WAITING(w) | CANCELED(c) DONE(d)
     #+TAGS: @HOME(h) @OFFICE(o) @SHOP(s)
    

    Next time you try to set tags with C-c C-c, the todo states will be offered as well, and the corresponding key will switch the entry to that state.

  • New variable `org-archive-save-context-info' governs if information that would be lost by moving a subtree to the archive file, should be stored as special properties. For example,

     (setq org-archive-save-context-info '(itags category))
    

    will store the inherited tags and the category in properties ARCHIVE_ITAGS and ARCHIVE_CATEGORY, respectively. The default setting for this variable is to save everything that could be lost. This was a proposal by John Wiegley.

  • Sorting (`C-c ^') can use the use the priority to sort. Use the "p" and "P" keys at the prompt. John Wiegley, again.
  • `Org-ellipsis' can now also be a face to make the folding ellipsis more visible. This is based on a post by Tassilo Horn. Since `org-ellipsis' only works in Org-mode, you might want to use Tassilo Horn's hack directly in order to affect the folding ellipsis globally.
  • Scheduling info is no longer removed when an entry is marked CLOSED. This was a request by Brian van den Broek. Let me know if this breaks anything for you - then it will become an option.
  • New option `org-agenda-skip-unavailable-files'. Currently, if a file does not exist, it will be removed from `org-agenda-files' after a query. When this option is set, the file will simply be skipped.
  • Bug fixes.

Version 5.06

Overview

Details

  • When exporting only a region and this region is a single (sub)tree (for example selected with `C-c @'), the title for the exported document is taken to be the heading of the subtree. The sublevels become top-level entries in the export. Furthermore, if the head entry of the tree has or inherits an EXPORT_FILE_NAME property, that file name (with appropriately substituted extension) will be used for the exported tree. Thanks to Patrick Drechsler and Jost Burkart for these ideas.
  • org-special-ctrl-a/e has a third allowed value, `reversed'. When it is set to this value, the first C-a or C-e command behaves normally, i.e. it goes to the true beginning or end of the line. Only when you press C-a or C-e immediately again, the the "special" position will be found. Additional presses of the same key jump between the two positions. I like this a lot better than the `t' setting, because now the keys behave more predictable and still give easy access to the special locations.
  • New command to set or remove a tag from all headlines in a region.
  • When Org-mode visits a file, it will initially hide all drawers.
  • The default of the variable `org-cycle-global-at-bob' is now nil, meaning that TAB no longer does global visibility cycling at the beginning of the buffer.
  • Bug fixes, in particular the problems with scheduling and deadlines introduced in 5.05. Please check carefully if this works correctly again, and complain if not.

Version 5.05

Overview

  • LaTeX export, finally, thanks to Bastien.
  • Extension mechanism for the hyperlink system.
  • Global access to commands inserting and following links.
  • Individual lead-times for deadlines.
  • Option to show only the next instance of repeating timestamp.
  • Store remember notes with only 2 keys: C-c C-c
  • Appointment reminders from Org-mode.
  • Global values for selected properties.
  • Bug fixes.

Details

  • Bastien's `org-export-latex.el' is now part of the org-mode distribution. You can export an Org-mode document to a LaTeX file with `C-c C-e l'. For more options, see the manual, and the commentary in the Lisp file. Kudos to Bastien for contributing this frequently requested feature. I am sure this has been tough because of the many different ways I have been allowing LaTeX snippets and environments to be incorporated in lazy free-format ways.
  • Org-mode has now an extension mechanism for the hyperlink system. This should clear the road for all those mairix and other ideas that have been floating around. Now it is on you to write and share new link types for Org-mode. The interface for adding a new link type is described in the appendix of the manual, section A2. The unsolved problem is currently how to handle the new link types for export/publishing.
  • New global commands `org-open-at-point-global' and `org-insert-link-global'. You can bind these commands to global keys and use them to insert and follow Org-mode-like links anywhere in Emacs. Thanks to Adam Spiers for this excellent idea.
  • Each deadline timestamp may now specify its own interval of lead-time display, given in days, weeks, months or years. The syntax is like this

     DEADLINE: <2007-08-13 Mon -5d>
    

    When combined with a repeater, the repeater has to come first:

     DEADLINE: <2007-08-13 Mon +2w -5d>
    

    You may now also customize the faces that are used in the agenda to indicate the distance of an approaching deadline. See the new option `org-agenda-deadline-faces'.

    Thanks to Pavel Chalmoviansky and John Wiegley proposals in this direction.

  • New option `org-agenda-repeating-timestamp-show-all'. When set to nil, repeating time stamps will only show up once in the agenda, either today or in the near future. Other matches will be ignored. Thanks to John Wiegley for this proposal.
  • New variable `org-remember-store-without-prompt'. When set, exiting the remember buffer with C-c C-c will store the note without further prompts to the default location, and `C-u C-c C-c' will get the prompts for file and location. So this variable reverses the prefix-argument functionality for storing remember notes. This follows a request from John Wiegley.
  • A new function `org-agenda-to-appt' activates all appointments for the current day so that Emacs will display reminders. This uses appt.el. Thanks to Bastien for this function.
  • You can now set default values for properties that can be inherited by all entries in a buffer, or by all entries globally. Global properties are set in the variable `org-global-properties', like this:

    (setq org-global-properties '(("NAME" "This is the value")))

    Buffer-local values are set like this:

    #+PROPERTY: NAME This is the value

    When using org-entry-get to get the value of a property with the `inherit' flag and the hierarchy above the entry does not contain this property, the buffer-local and global lists are checked as well. This is mostly useful (I think) to set the list of allowed values for a property. Thanks to Bernt Hansen and Bastien for these ideas.

  • Bug fixes.

Version 5.04

Details

  • New variables `org-export-author-info' and `org-export-time-stamp-file' to turn off inclusion of author and time information into exported files. Thank to Patrick Drechsler for pointing out that this would be useful.
  • New variable to avoid moving DEADLINE and SCHEDULED info into the property drawer. The default is now to not move this stuff into the drawer. `org-insert-labeled-timestamps-before-properties-drawer'
  • `org-archive-mark-done' can be a string now, to select a specific keyword that should be used for archived entries.
  • New command "j" in agenda to jump to an arbitrary date. Thanks to Bernt Hansen for the patch.
  • Lots of minor fixes.

Version 5.03

Incompatible Changes

  • The variable `org-special-ctrl-a' has been renamed to `org-special-ctrl-a/e'. The old one is still an alias (but not on Emacs 21 where variable aliases cannot be defined).

Details

  • When the variable `org-special-ctrl-a/e' is set, C-e in a headline first goes to the end of the headline ignoring the tags. A second C-e then goes to after the tags.
  • Typing and removing single characters in a headline now keeps the tags in the headline aligned. This could have a little impact on performance while deleting stuff - let me know if we need to make this customizable.
  • New option `org-n-level-faces' can be used to set the number of different faces that are used for headlines. Default is all 8 faces Org-mode defines for this purpose, level 9 uses again the level-1 face. However, you can use fewer, and then the level-1 face will be reused already for level N+1, etc.
  • Column View and hidestars now work together.
  • Bug fixes.

Version 5.02

Overview

  • The interfaces for properties and column view are finished now and work well.
  • Properties can be summa