1 # -*- mode: org; fill-column: 65 -*-
5 #+TITLE: Org-mode list of user-visible changes
6 #+AUTHOR: Carsten Dominik
7 #+EMAIL: carsten at orgmode dot org
8 #+OPTIONS: H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:{} *:t TeX:t LaTeX:nil f:nil
9 #+INFOJS_OPT: view:info toc:1 path:org-info.js tdepth:2 ftoc:t
11 #+LINK_HOME: http://orgmode.org
13 * Version 6.24 (in preparation)
19 ** Incompatible changes
21 *** New key for creating tags/property sparse trees
23 The key to produce a sparse tree matching tags and properties is
24 now =C-c / m= instead of =C-c a T=. This is also more consistent
25 with the =C-c a m= key for the corresponding agenda view.
26 =C-c / T= will still work for now, but it is no longer advertised
27 in the documentation and may go away at any time in the future.
29 *** IDs in HTML have "ID-" prefix when generated by uuidgen
31 =uuidgen= generates IDs that often start with a number, not a
32 latter. However, IDs and names in XHTML must start with a letter.
33 Therefore, IDs in HTML files will now get an "ID-" prefix if they
34 have been generated by uuidgen. This means that id links from one
35 file to another may stop working until all files have been
40 *** PDF export of agenda views
42 Agenda views can now be exported to PDF files by writing them to
43 a file with extension ".pdf". Internally this works by first
44 producing the postscript version and then converting that to PDF
45 using the ghostview utility =ps2pdf=. Make sure that this
46 utility is installed on your system.
48 The postscript version will not be removed, it will stay around.
50 *** Inline some entry text for Agenda View export
52 When exporting an agenda view to HTML or PDF for printing or
53 remote access, one of the problems can be that information stored
54 in entries below the headline is not accessible in that format.
56 You can now copy some of that information to the agenda view
57 before exporting it. For this you need set the variable
58 =org-agenda-add-entry-text-maxlines= to a number greater than 0.
60 #+begin_src emacs-lisp
61 (setq org-agenda-add-entry-text-maxlines 20)
64 Or you can to this with the settings in a special agenda view,
67 #+begin_src emacs-lisp
70 (org-agenda-add-entry-text-maxlines 5))
74 *** Exporting of citations to LaTeX and HTML, using BibTeX
76 Citations can now me made using BibTeX, and will be exported
77 to LaTeX and HTML. This is implemented in a contributed
78 package by Taru Karttunen, /org-exp-bibtex.el/. Kudos to
79 Taru for this really nice addition.
81 *** Update of org2rem.el
83 /org2rem.el/ has been updated significantly and now does a more
84 comprehensive job of exporting Org events to remind.
86 Thanks to Sharad Pratap for this update.
88 *** Improved ASCII export of links
90 ASCII export of links works now much better. If a link has a
91 link and a description part which are different, then the
92 description will remain in the text while the link part will be
93 moved to the end of the current section, before the next heading,
94 as a footnote-like construct.
96 Configure the variable =org-export-ascii-links-to-notes= if you
97 prefer the links to be shown in the text. In this case, Org will
98 make an attempt to wrap the line which may have become
99 significantly longer by showing the link.
101 *** Turning off time-of-day search in headline
103 Some people like to put a creation time stamp into a headline and
104 then get confused if the time-of-day found in there shows up as
105 the time-of-day of the deadline/scheduling entry for this
106 headline. The reason for this is that Org searches the headline
107 for a free-format time when trying to sort the entry into the
108 agenda, and that search accidentally finds the time in the
109 creation time stamp or something else that happens to look like a
110 time. If this is more painful than useful for you, configure the
111 new variable =org-agenda-search-headline-for-time=.
113 *** Clustering characters for undo
115 When typing in Org-mode, undo will now remove up to 20 characters
116 at a time with a single undo command. This is how things work
117 normally in Emacs, but the special binding of characters in
118 Org-mode made this impossible until now.
120 Thanks to Martin Pohlack for a patch which mimicks the behavior
121 of the Emacs command loop for the Org version of self-insert.
122 Note that this will not work in headlines and tables because
123 typing there will do a lot of extra work.
125 There might be a small typing performance hit resulting from this
126 change - please report in the mailing list if this is noticeable
129 *** New reload command, with keyboard access
131 There is now a special command to reload all Org Lisp files, so
132 that you can stay in your Emacs session while pulling and
133 compiling changes to Org. The command to reload the compiled
134 files (if available) is =C-c C-x r=. If no compiled files are
135 found, uncompiled ones will be loaded. If you want to force
136 loading of uncompiled code (great for producing backtraces), use
137 a prefix arg: =C-u C-c C-x o=. Both commands are available in
140 This new command was inspired by one written earlier by Bernt
143 *** Macro replacement
145 A string like ={{{ title }}}= will be replaced by the title of
146 the document, ={{{ email }}}= by the email setting of the author
147 and similarly for other export settings given in =#+...= lines.
148 In addition to that, you can define an arbitrary number of
152 ,#+MACRO: myaddress 41 Onestreet, 12345 New York, NY
154 ,my address is {{{myaddress}}}, see you there.
157 Macro replacement is the very first thing that happens during
158 export, and macros will be replaced even in source code and other
161 *** Separate settings for special C-a and C-e
163 The variable `org-special-ctrl-a/e' now allows separate settings
164 for =C-a= and =C-e=. For example
166 #+begin_src emacs-lisp
167 (setq org-special-ctrl-a/e '(reversed . t))
170 Thanks to Alan Davis for this proposal.
172 *** orgstruct++-mode improvements
174 In addition to =orgstruct-mode= which allows to use some Org-mode
175 structure commands in other major modes, there is now a more
176 invasive version of this mode: =orgstruct++-mode=. This mode
177 will import all paragraph and line wrapping variables into the
178 major mode, so that, for example, during typing the auto-fill
179 wrapping of items will work just like in Org-mode. This change
180 is not reversible, so turning off orgstruct++-mode will not
181 remove these settings again. =orgstruct++-mode= is most useful in
182 text modes like message-mode or =magit-log-edit-mode=.
183 Furthermore, =orgstruct++-mode= will recognize plain list context
184 not only in the first line of an item, but also further down, so
185 that =M-RET= will correctly insert new items.
187 Thanks to Austin Frank for requesting some of these changes.
189 *** Promotion and demotion works for regions now
191 =M-right= and =M-left= now do demote and promote all headlines in
194 *** The match syntax for tags/properties is now described in a single place
196 The manual chapters about tags and about properties now only
197 refer to the section about agenda views, where the general syntax
198 of tag/property matches is described.
200 *** New div around the entire page in HTMP export
202 A new =<div id=content>= is wrapped around the entire page,
203 everything that is inside =<body>=.
205 *** Faces for priority cookies can now be set freely
207 The new variable =org-priority-faces= can be used to set faces
210 *** In agenda, only priority cookies get the special face
212 So far, an entire task would get a special face when
213 =org-agenda-fontify-priorities= was set. Now, the default value
214 for this variable is the symbol =cookies=, which means that on
215 the cookie is fontified. Set it to =t= if you want the entire
216 task headline to be fontified.
221 - Capture state change notes into a drawer
222 - Clock lines are now captured into the LOGBOOK drawer as well
223 - Added org-R.el to contrib directory
224 - Allow individual formatting of each TODO keyword in HTML export
225 - New hooks for add-ons to tap into context-sensitive commands
226 - Publishing files irrespective of extension
227 - New variable index in the manual
228 - The ORDERED property also influences checkboxes
229 - The ORDERED property can be tracked with a tag
230 - You may now specify line breaks in the fast tags interface
231 - When a TODO is blocked by checkboxes, keep it visible in agenda
232 - LaTeX can import Org's in-buffer definitions for TITLE, EMAIL etc.
234 ** Incompatible changes
236 - CLOCK lines will now be captured into the LOGBOOK drawer.
237 See below for details.
241 *** Capture state change notes into a drawer
243 State change notes can now be captured into a drawer =LOGBOOK=,
244 to keep the entry tidy. If this is what you want, you will need
247 #+begin_src emacs-lisp
248 (setq org-log-into-drawer "LOGBOOK")
251 Thanks to Wanrong Lin for this proposal.
253 *** Clock lines are now captured into the LOGBOOK drawer as well
255 The =CLOCK= drawer will be abandoned, clock lines will now also
256 end up in a drawer =LOGBOOK=. The reason for this is that it's a
257 bit useless to have two different drawers for state change notes
258 and clock lines. If you wish to keep the old way, use
260 #+begin_src emacs-lisp
261 (setq org-clock-into-drawer "CLOCK")
264 *** Added org-R.el to contrib directory
266 Dan Davison has contributed /org-R.el/ which is now in the
267 contrib directory. Org-R performs numerical computations and
268 generates graphics. Data can come from org tables, or from csv
269 files; numerical output can be stored in the org buffer as org
270 tables, and links are created to files containing graphical
271 output. Although, behind the scenes, it uses R, you do not need
272 to know anything about R. Common operations, such as tabulating
273 discrete values in a column of an org table, are available "off
274 the shelf" by specifying options on lines starting with =#+R:=.
275 However, you can also provide raw R code to be evaluated. The
276 documentation is currently the worg tutorial at
277 http://orgmode.org/worg/org-tutorials/org-R/org-R.php
279 Thanks to Dan for this great contribution.
281 *** Allow individual formatting of TODO keyword and tags in HTML export
283 TODO keywords in HTML export have the CSS class =todo= or =done=.
284 Tags have the CSS class =tag=. In addition to this, each keyword
285 has now itself as class, so you could do this in your CSS file:
288 .todo { font-weight:bold; }
289 .done { font-weight:bold; }
291 .WAITING { color:orange; }
292 .DONE { color:green; }
295 If any of your keywords causes conflicts with CSS classes used
296 for different purposes (for example a tag "title" would cause a
297 conflict with the class used for formatting the document title),
298 then you can use the variables =org-export-html-tag-class-prefix=
299 and =org-export-html-todo-kwd-class-prefix= to define prefixes
300 for the class names for keywords, for example "kwd-".
302 Thanks to Wanrong Lin for this request, and to Sebastian Rose for
303 help with the implementation.
305 *** New hooks for add-ons to tap into context-sensitive commands
307 Some commands in Org are context-sensitive, they will execute
308 different functions depending on context. The most important
309 example is of course =C-c C-c=, but also the =M-cursor= keys fall
312 Org has now a system of hooks that can be used by add-on packages
313 to install their own functionality into these keys. See the
314 docstring of =org-ctrl-c-ctrl-c-hook= for details. The other
315 hooks are named like =org-metaleft-hook= or
316 =org-shiftmetaright-hook=.
318 *** Publishing files irrespective of extension
320 If you set the =:base-extension= property for a publishing
321 project to the symbol =any=, all files in the directory will be
322 published, irrespective of extension.
324 Thanks to Richard Klinda for a patch to this effect.
326 *** New variable index in the manual
328 A new index in the manual lists all variables mentioned in the
329 manual, about 200 variables in total.
331 *** The ORDERED property also influences checkboxes
333 When an entry has the ORDERED property set, checkboxes in
334 the entry must be completed in order. This was already the case
335 for children TODO items, now it also applies for checkboxes.
337 Thanks to Rainer Stengele for this proposal.
339 *** The ORDERED property can be tracked with a tag
341 The =ORDERED= property is used to flag an entry so that subtasks
342 (both children TODO items and checkboxes) must be completed in
343 order. This property is most easily toggled with the command
344 =C-c C-x o=. A property was chosen for this functionality,
345 because this should be a behavior local to the current task, not
346 inherited like tags. However, properties are normally
347 invisible. If you would like visual feedback on the state of
348 this property, configure the variable
349 =org-track-ordered-property-with-tag=. If you then use =C-c C-x
350 o= to toggle the property, a tag will be toggled as well, for
353 Note that the tag itself has no meaning for the behavior of TODO
354 items and checkboxes, and that changing the tag with the usual
355 tag commands will not influence the property and therefore the
356 behavior of TODO and checkbox commands.
358 *** You may now specify line breaks in the fast tags interface
360 Up to now, the fast tags interface tried to lump as many tags as
361 possible into a single line, with the exception that groups would
362 always be on a line by themselves.
364 Now, if you use several lines to define your tags, like
367 ,#+TAGS: aa(a) bb(b) cc(c)
368 ,#+TAGS: dd(d) ee(e) ff(f)
371 then there will also be a line break after the "cc" tag in the
372 fast tag selection interface. You may also write
375 ,#+TAGS: aa(a) bb(b) cc(c) \n dd(d) ee(e) ff(f)
378 to achieve the same effect, and you can use =\n= several times in
379 order to produce empty lines. In =org-tag-alist=, newlines are
380 represented as =(:newline)=.
382 Thanks to Christopher Suckling for a patch to this effect.
384 *** When a TODO is blocked by checkboxes, keep it visible in agenda
386 When the variable =org-agenda-dim-blocked-tasks= is set to
387 =invisible=, tasks that are blocked will not be visible in the
388 agenda. If the blocking is due to child TODO entries, this does
389 make sense because the children themselves will show up in the
392 However, as John Rakestraw has [[http://thread.gmane.org/gmane.emacs.orgmode/10939][pointed out]], if the blocking is
393 done by checkboxes, no trace of these subtasks is left.
394 Therefore, when the blocking is done by checkboxes, we now
395 overrule the =invisible= setting and replace it with mere dimming
398 *** LaTeX can import Org's in-buffer definitions for TITLE, EMAIL etc.
400 If you configure =org-export-latex-import-inbuffer-stuff=,
401 in-buffer definitions like #+TITLE will be made available in the
402 LaTeX file as =\orgTITLE=.
404 This was a request by Russel Adams.
409 *** org-choose.el by Tom Breton is now included
411 Org-choose helps documenting a decision-making process by using
412 TODO keywords for different degrees of /chosenness/, and by
413 automatically keeping a set of alternatives in a consistent state.
415 Documentation for /org-choose.el/ is available [[http://orgmode.org/worg/org-contrib/org-choose.php][here]].
417 This package inserts itself into Org using hooks, so if other
418 people would like to do interesting stuff with TODO keywords for
419 special purposes, looking at Tom's code might be a good way to
422 Thanks to Tom for this interesting contribution!
424 *** orgmode.org and Worg css works now better on IE
426 Thanks to Sebastian Rose for making these changes.
428 *** When exporting a subtree, headline levels are now relative to parent
430 This was reported as a bug by William Henney and is fixed now.
432 *** Inactive dates in tables can be used for sorting.
434 When sorting table fields or entries by date, Org first tries to
435 find an active date, and, if none exist, uses a passive date if
438 This was a request by Hsui-Khuen Tang
440 *** The default for =org-return-follows-link= is back to =nil=
442 Setting it to =t= violates Emacs rules to some extent. The
443 internal implementation of this has been improved, so setting it
444 to =t= should now be pretty stable.
446 *** Automatic scheduling of siblings with org-depend.el
448 The sibling of a DONE task can now automatically be scheduled.
450 This was a patch by Andrew Hyatt.
452 *** New skipping conditions
454 The functions =org-agenda-skip-entry-if= and
455 =org-agenda-skip-subtree-if= now accept =timestamp= and
456 =nottimestamp= as additional conditions.
458 This was in response to a request by Saurabh Agrawal.
464 *** Changes to some default values of variables:
466 Here are the new default values:
469 (setq org-return-follows-link t)
471 (setq org-use-fast-todo-selection t)
473 (setq org-yank-adjusted-subtrees nil)
475 (setq org-tags-column -77)
477 (setq org-agenda-sorting-strategy
478 '((agenda time-up priority-down category-keep)
479 (todo time-up priority-down category-keep)
480 (tags time-up priority-down category-keep)
481 (search category-keep)))
484 *** Final cleanup for Emacs 21.1 pretest
490 *** Support for simple TODO dependencies
492 John Wiegley's code for enforcing simple TODO dependencies has
493 been integrated into Org-mode. Thanks John!
495 The structure of Org files (hierarchy and lists) makes it easy to
496 define TODO dependencies. A parent TODO task should not be
497 marked DONE until all subtasks (defined as children tasks) are
498 marked as DONE. And sometimes there is a logical sequence to a
499 number of (sub)tasks, so that one task cannot be acted upon
500 before all siblings above it are done. If you customize the
501 variable =org-enforce-todo-dependencies=, Org will block entries
502 from changing state while they have children that are not DONE.
503 Furthermore, if an entry has a property =ORDERED=, each of its
504 children will be blocked until all earlier siblings are marked
505 DONE. Here is an example:
508 ,* TODO Blocked until (two) is done
517 ,** TODO b, needs to wait for (a)
518 ,** TODO c, needs to wait for (a) and (b)
521 The command =C-c C-x o= toggles the value of the =ORDERED=
524 The variable =org-agenda-dim-blocked-tasks= controls how blocked
525 entries should appear in the agenda, where they can be dimmed or
528 Furthermore, you can use the variable
529 =org-enforce-todo-checkbox-dependencies= to block TODO entries
530 from switching to DONE while any checkboxes are unchecked in the entry.
532 *** Support for shift-selection in Emacs 23
534 Customize the variable =org-support-shift-select= to use S-cursor
535 key for selecting text. Make sure that you carefully read the
536 docstring of that variable first.
538 *** Adding and removing checkboxes from many lines
540 The command =C-c C-x C-b= normally toggles checkbox status in the
541 current line, or in all lines in the region. With prefix
542 argument it now either adds or removes the checkbox.
544 This was a requested by Daniel Clemente.
550 - Improved behavior of conversion commands =C-c -= and =C-c *=
551 - Table formulas may now reference fields in other tables
552 - A final hline is imagined in each table, for the sake of references
553 - A tags-todo search can now ignore timestamped items
554 - =\par= can be used to force a paragraph break, also in footnotes
559 *** Improved behavior of conversion commands =C-c -= and =C-c *=
561 The conversion commands =C-c -= and =C-c *= are now better
562 behaved and therefore more useful, I hope.
564 If there is an active region, these commands will act on the
565 region, otherwise on the current line.
567 - C-c - :: This command turns headings or normal lines into
568 items, or items into normal lines. When there is a
569 region, everything depends on the first line of the
571 - if it is a item, turn all items in the region into
573 - if it is a headline, turn all headlines in the region
575 - if it is a normal line, turn all lines into items.
576 - special case: if there is no active region and the
577 current line is an item, cycle the bullet type of the
579 - C-c * :: This command turns items and normal lines into
580 headings, or headings into normal lines. When there is
581 a region, everything depends on the first line of the
583 - if it is a item, turn all items in the region into
585 - if it is a headline, turn all headlines in the region
587 - if it is a normal line, turn all lines into headlines.
589 *** Table formulas may now reference fields in other tables
591 You may now reference constants, fields and ranges from a
592 different table, either in the current file or even in a
593 different file. The syntax is
595 : remote(NAME-OR-ID,REF)
597 where /NAME/ can be the name of a table in the current file as
598 set by a =#+TBLNAME: NAME= line before the table. It can also be
599 the ID of an entry, even in a different file, and the reference
600 then refers to the first table in that entry. /REF/ is an
601 absolute field or range reference, valid in the referenced table.
602 Note that since there is no "current filed" for the remote table,
603 all row and column references must be absolute, not relative.
605 *** A final hline is imagined in each table, for the sake of references
607 Even if a table does not end with a hline (mine never do because I
608 think it is not pretty), for the sake of references you can
609 assume there is one. So in the following table
618 a reference like =@I$1..@II$2= will now work.
620 *** A tags-todo search can now ignore timestamped items
621 The variables =org-agenda-todo-ignore-with-date=,
622 =org-agenda-todo-ignore-with-date=, and
623 =org-agenda-todo-ignore-with-date= make it possible to
624 exclude TODO entries which have this kind of planning info
625 associated with them. This is most useful for people who
626 schedule everything, and who use the TODO list mainly to find
627 things that are not yet scheduled. Thomas Morgan pointed out
628 that also the tags-todo search may serve exactly this
629 purpose, and that it might be good to have a way to make
630 these variables also apply to the tags-todo search. I can
631 see that, but could not convince myself to make this the
632 default. A new variable must be set to make this happen:
633 =org-agenda-tags-todo-honor-ignore-options=.
635 *** =\par= can be used to force a paragraph break, also in footnotes
637 The LaTeX idiom =\par= will insert a paragraph break at that
638 location. Normally you would simply leave an empty line to get
639 such a break, but this is useful for footnotes whose
640 definitions may not contain empty lines.
643 ** Incompatible changes
645 *** Short examples must have a space after the colon
647 Short literal examples can be created by preceding lines
648 with a colon. Such lines must now have a space after the
649 colon. I believe this is already general practice, but now
650 it must be like this. The only exception are lines that are
651 empty except for the colon.
655 *** Include files can now also process switches
657 The example and src switches like =-n= can now also be added
658 to include file statements:
660 : #+INCLUDE "~/.emacs" src emacs-lisp -n -r
662 Thanks to Manish for pointing out that this was not yet
665 *** Examples can be exported to HTML as text areas
667 You can now specify a =-t= switch to an example or src block,
668 to make it export to HTML as a text area. To change the
669 defaults for height (number of lines in the example) and
670 width of this area (80), use the =-h= and =-w= switches.
672 Thanks to Ulf Stegemann for driving this development.
674 *** LaTeX_CLASS can be given as a property
676 When exporting a single subtree by selecting it as a region
677 before export, the LaTeX class for the export will be taken
678 from the =LaTeX_CLASS= property of the entry if present.
680 Thanks to Robert Goldman for this request.
682 *** Better handling of inlined images in different backends
684 Two new variables govern which kind of files can be inlined
685 during export. These are
686 =org-export-html-inline-image-extensions= and
687 =org-export-latex-inline-image-extensions=. Remember that
688 links are turned into an inline image if they are a pure link
689 with no description. HTML files can inline /.png/, /.jpg/,
690 and /.gif/ files, while LaTeX files, when processed with
691 /pdflatex/, can inline /.png/, /.jpg/, and /.pdf/ files.
692 These also represent the default settings for the new
693 variables. Note that this means that pure links to /.pdf/
694 files will be inlined - to avoid this for a particular link,
695 make sure that the link has a description part which is not
696 equal to the link part.
698 *** Links by ID now continue to work in HTML exported files
700 If you make links by ID, these links will now still work in
701 HTML exported files, provided that you keep the relative path
702 from link to target file the same.
704 Thanks to Friedrich Delgado Friedrichs for pushing this over
707 *** The relative timer can be paused
709 The new command `C-c C-x ,' will pause the relative timer.
710 When the relative timer is running, its value will be shown
711 in the mode line. To get rid of this display, you need to
712 really stop the timer with `C-u C-c C-x ,'.
714 Thanks to Alan Davis for driving this change.
716 *** The attachment directory may now be chosen by the user
718 Instead of using the automatic, unique directory related to
719 the entry ID, you can also use a chosen directory for the
720 attachments of an entry. This directory is specified by the
721 ATTACH_DIR property. You can use `C-c C-a s' to set this
724 Thanks to Jason Jackson for this proposal.
726 *** You can use a single attachment directory for a subtree
728 By setting the property ATTACH_DIR_INHERIT, you can now tell
729 Org that children of the entry should use the same directory
730 for attachments, unless a child explicitly defines its own
731 directory with the ATTACH_DIR property. You can use the
732 command `C-c C-a i' to set this property in an entry.
739 - Line numbers and references in literal examples
740 - New hooks for export preprocessing
741 - Capture column view into a different file
747 Org-mode now directly supports the creation of footnotes. In
748 contrast to the /footnote.el/ package, Org-mode's footnotes are
749 designed for work on a larger document, not only for one-off
750 documents like emails. The basic syntax is similar to the one
751 used by /footnote.el/, i.e. a footnote is defined in a paragraph
752 that is started by a footnote marker in square brackets in column
753 0, no indentation allowed. The footnote reference is simply the
754 marker in square brackets inside text. For example:
757 The Org homepage[fn:1] now looks a lot better than it used to.
759 [fn:1] The link is: http://orgmode.org
762 Org-mode extends the number-based syntax to /named/ footnotes and
763 optional inline definition. Using plain numbers as markers is
764 supported for backward compatibility, but not encouraged because
765 of possible conflicts with LaTeX syntax. Here are the valid
768 - [1] :: A plain numeric footnote marker.
770 - [fn:name] :: A named footnote reference, where `name' is a
771 unique label word or, for simplicity of automatic creation,
774 - [fn:: This is the inline definition of this footnote] :: A
775 LaTeX-like anonymous footnote where the definition is given
776 directly at the reference point.
778 - [fn:name: a definition] :: An inline definition of a footnote,
779 which also specifies a name for the note. Since Org allows
780 multiple references to the same note, you can then use use
781 `[fn:name]' to create additional references.
783 Footnote labels can be created automatically, or you create names
784 yourself. This is handled by the variable
785 =org-footnote-auto-label= and its corresponding =#+STARTUP=
786 keywords, see the docstring of that variable for details.
788 The following command handles footnotes:
790 - C-c C-x f :: The footnote action command. When the cursor is
791 on a footnote reference, jump to the definition. When it is
792 at a definition, jump to the (first) reference. Otherwise,
793 create a new footnote. Depending on the variable
794 `org-footnote-define-inline' (with associated =#+STARTUP=
795 options =fninline= and =nofninline=), the definitions will
796 be placed right into the text as part of the reference, or
797 separately into the location determined by the variable
798 =org-footnote-section=.
799 When this command is called with a prefix argument, a menu
800 of additional options is offered:
801 - s :: Sort the footnote definitions by reference sequence.
802 During editing, Org makes no effort to sort footnote
803 definitions into a particular sequence. If you want
804 them sorted, use this command, which will also move
805 entries according to =org-footnote-section=.
806 - n :: Normalize the footnotes by collecting all
807 definitions (including inline definitions) into a
808 special section, and then numbering them in
809 sequence. The references will then also be
810 numbers. This is meant to be the final step before
811 finishing a document (e.g. sending off an email).
812 The exporters do this automatically, and so could
813 something like `message-send-hook'.
814 - d :: Delete the footnote at point, and all references to it.
816 - C-c C-c :: If the cursor is on a footnote reference, jump to
817 the definition. If it is a the definition, jump back to the
818 reference. When called with a prefix argument at either
819 location, offer the same menu as `C-u C-c C-x f'.
821 - C-c C-o or mouse-1/2 :: Footnote labels are also links to the
822 corresponding definition/reference, and you can use the
823 usual commands to follow these links.
825 Org-mode's footnote support is designed so that it should also
826 work in buffers that are not in Org-mode, for example in email
827 messages. Just bind =org-footnote-action= to a global key like
830 The main trigger for this development came from a hook function
831 written by Paul Rivier, to implement named footnotes and to
832 convert them to numbered ones before export. Thanks, Paul!
834 Thanks also to Scot Becker for a thoughtful post bringing this
835 subject back onto the discussion table, and to Matt Lundin for
836 the idea of named footnotes and his prompt testing of the new
839 *** Line numbers and references in literal examples
841 Literal examples introduced with =#+BEGIN_EXAMPLE= or =#+BEGIN_SRC=
842 do now allow optional line numbering in the example.
843 Furthermore, links to specific code lines are supported, greatly
844 increasing Org-mode's utility for writing tutorials and other
847 Code references use special labels embedded directly into the
848 source code. Such labels look like "(ref:name)" and must be
849 unique within a document. Org-mode links with "(name)" in the
850 link part will be correctly interpreted, both while working with
851 an Org file (internal links), and while exporting to the
852 different backends. Line numbering and code references are
853 supported for all three major backends, HTML, LaTeX, and ASCII.
854 In the HTML backend, hovering the mouse over a link to a source
855 line will remote-highlight the referenced code line.
857 The options for the BEGIN lines are:
859 - -n :: Number the lines in the example
860 - +n :: Like -n, but continue numbering from where the previous
862 - -r :: Remove the coderef cookies from the example, and replace
863 links to this reference with line numbers. This option
864 takes only effect if either -n or +n are given as well.
865 If -r is not given, coderefs simply use the label name.
866 - -l "fmt" :: Define a local format for coderef labels, see the
867 variable =org-coderef-label-format= for details. Use this
868 of the default syntax causes conflicts with the code in the
869 code snippet you are using.
874 #+begin_src emacs-lisp -n -r
875 (defmacro org-unmodified (&rest body) (ref:def)
876 "Execute body without changing `buffer-modified-p'."
877 `(set-buffer-modified-p (ref:back)
878 (prog1 (buffer-modified-p) ,@body)))
880 [[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
884 When exported, this is translated to:
885 #+begin_src emacs-lisp -n -r
886 (defmacro org-unmodified (&rest body) (ref:def)
887 "Execute body without changing `buffer-modified-p'."
888 `(set-buffer-modified-p (ref:back)
889 (prog1 (buffer-modified-p) ,@body)))
891 [[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
894 Thanks to Ilya Shlyakhter for proposing this feature set. Thanks
895 to Sebastian Rose for the key Javascript element that made the
896 remote highlighting possible.
898 *** New hooks for export preprocessing
899 The export preprocessor now runs more hooks, to allow
900 better-timed tweaking by user functions:
902 - =org-export-preprocess-hook= ::
903 Pretty much the first thing in the preprocessor. But org-mode
904 is already active in the preprocessing buffer.
906 - =org-export-preprocess-after-include-files-hook= ::
907 This is run after the contents of included files have been inserted.
909 - =org-export-preprocess-after-tree-selection-hook= ::
910 This is run after selection of trees to be exported has
911 happened. This selection includes tags-based selection, as
912 well as removal of commented and archived trees.
914 - =org-export-preprocess-before-backend-specifics-hook= ::
915 Hook run before backend-specific functions are called during preprocessing.
917 - =org-export-preprocess-final-hook= ::
918 Hook for preprocessing an export buffer. This is run as the
919 last thing in the preprocessing buffer, just before returning
920 the buffer string to the backend.
922 *** Capture column view into a different file
924 The :id parameter for the dynamic block capturing column view
925 can now truly be an ID that will also be found in a
926 different file. Also, it can be like =file:path/to/file=, to
927 capture the global column view from a different file.
929 Thanks to Francois Lagarde for his report that IDs outside
930 the current file would not work.
933 Cleanup of many small bugs, and one new feature.
937 *** References to last table row with special names
939 Fields in the last row of a table can now be referenced with
940 $LR1, $LR2, etc. These references can appear both on the
941 left hand side and right hand side of a formula.
945 This version reverses the introduction of @0 as a reference to
946 the last rwo in a table, because of a conflict with the use of
947 @0 for the current row.
952 - All known LaTeX export issues fixed
953 - Captions and attributes for figures and tables.
954 - Better implementation for entry IDs
955 - Spreadsheet references to the last table line.
956 - Old syntax for link attributes abandoned
958 ** Incompatible changes
959 *** Old syntax for link attributes abandoned
961 There used to be a syntax for setting link attributes for
962 HTML export by enclosing the attributes into double braces
963 and adding them to the link itself, like
966 [[./img/a.jpg{{alt="an image"}}] ]
969 This syntax is not longer supported, use instead
972 ,#+ATTR_HTML: alt="an image"
978 *** All known LaTeX export issues fixed
980 All the remaining issues with the LaTeX exporter have hopefully
981 been addressed in this release. In particular, this covers
982 quoting of special characters in tables and problems with
983 exporting files where the headline is in the first line, or with
986 *** Captions and attributes for figures and tables.
988 Tables, and Hyperlinks that represent inlined images, can now be
989 equipped with additional information that will be used during
990 export. The information will be taken from the following special
991 lines in the buffer and apply to the first following table or
994 - #+CAPTION: :: The caption of the image or table. This string
995 should be processed according to the export backend, but
996 this is not yet done.
998 - #+LABEL: :: A label to identify the figure/table for cross
999 references. For HTML export, this string will become the
1000 ID for the ~<div class="figure">~ element that encapsulates
1001 the image tag and the caption. For LaTeX export, this
1002 string will be used as the argument of a ~\label{...}~
1003 macro. These labels will be available for internal links
1004 like ~[[label][Table] ]~.
1006 - #+ATTR_HTML: :: Attributes for HTML export of image, to be
1007 added as attributes into the ~<img...>~ tag. This string
1008 will not be processed, so it should have immediately the
1011 - #+ATTR_LaTeX: :: Attributes for LaTeX export of images and
1013 For /images/, this string is directly inserted into
1014 the optional argument of the ~\includegraphics[...]{file}~
1015 command, to specify scaling, clipping and other options.
1016 This string will not be processed, so it should have
1017 immediately the right format, like =width=5cm,angle=90=.\\
1018 For /tables/, this can currently contain the keyword
1019 =longtable=, to request typesetting of the table using the
1020 longtable package, which automatically distributes the table
1021 over several pages if needed. Also, the attributes line may
1022 contain an alignment string for the tabular environment, like
1023 =longtable,align=l|lrl=
1025 For LaTeX export, if either a caption or a label is given, the element
1026 will be exported as a float, i.e. wrapped into a figure or table
1029 *** Better implementation for entry IDs
1031 Unique identifiers for entries can now be used more efficiently.
1032 Internally, a hash array has replaced the alist used so far to
1033 keep track of the files in which an ID is defined. This makes it
1034 quite fast to find an entry by ID.
1036 There is a new link type which looks like this:
1039 id:GLOBALLY-UNIQUE-IDENTIFIER
1042 This link points to a specific entry. When you move the entry to
1043 a different file, for example if you move it to an archive
1044 file, the link will continue to work.
1046 The file /org-id.el/ contains an API that can be used to write
1047 code using these identifiers, including creating IDs and finding
1048 them wherever they are.
1050 Org has its own method to create unique identifiers, but if the system
1051 has /uuidgen/ command installed (Mac's and Linux systems generally
1052 do), it will be used by default (a change compared to the earlier
1053 implmentation, where you explicitdly had to opt for uuidgen). You can
1054 also select the method by hand, using the variable =org-id-method=.
1056 If the ID system ever gets confused about where a certain ID is, it
1057 initiates a global scan of all agenda files with associated archives,
1058 all files previously known containing any IDs, and all currently
1059 visited Org-mode files to rebuild the hash. You can also initiate
1060 this by hand: =M-x org-id-update-id-locations=. Running this command
1061 will also dump into the =*Messages*= buffer information about any
1062 duplicate IDs. These should not exist, and Org will never /make/ the
1063 same ID twice, but if you /copy/ an entry with its properties,
1064 duplicate IDs will inevitably be produced. Unfortunately, this is
1065 unavoidable in a plain text system that allows you to edit the text in
1066 arbitrary ways, and a portion of care on your side is needed to keep
1069 The hash is stored in the file =~/.emacs.d/.org-id-locations=.
1070 This is also a change from previous versions where the file was
1071 =~/.org=id-locations=. Therefore, you can remove this old file
1072 if you have it. I am not sure what will happen if the =.emacs.d=
1073 directory does not exists in your setup, but in modern Emacsen, I
1074 believe it should exist. If you do not want to use IDs across
1075 files, you can avoid the overhead with tracking IDs by
1076 customizing the variable =org-id-track-globally=. IDs can then
1077 still be used for links inside a single file.
1079 IDs will also be used when you create a new link to an Org-mode
1080 buffer. If you use =org-store-link= (normally at =C-c l=) inside
1081 en entry in an Org-mode buffer, and ID property will be created
1082 if it does not exist, and the stored link will be an =id:= link.
1083 If you prefer the much less secure linking to headline text, you
1084 can configure the variable =org-link-to-org-use-id=. The default
1085 setting for this variable is =create-if-interactive=, meaning
1086 that an ID will be created when you store a link interactively,
1087 but not if you happen to be in an Org-mode file while you create
1088 a remember note (which usually has a link to the place where you
1089 were when starting remember).
1091 *** Spreadsheet references to the last table line.
1093 You may now use =@0= to reference the last dataline in a table
1094 in a stable way. This is useful in particular for automatically
1095 generated tables like the ones using /org-collector.el/ by Eric
1101 - New relative timer to support timed notes
1102 - Special faces can be set for individual tags
1103 - The agenda shows now all tags, including inherited ones.
1104 - Exclude some tags from inheritance.
1105 - More special values for time comparisons in property searches
1106 - Control for exporting meta data
1107 - Cut and Paste with hot links from w3m to Org
1108 - LOCATION can be inherited for iCalendar export
1109 - Relative row references crossing hlines now throw an error
1111 ** Incompatible Changes
1113 *** Relative row references crossing hlines now throw an error
1115 Relative row references in tables look like this: "@-4" which
1116 means the forth row above this one. These row references are
1117 not allowed to cross horizontal separator lines (hlines). So
1118 far, when a row reference violates this policy, Org would
1119 silently choose the field just next to the hline.
1121 Tassilo Horn pointed out that this kind of hidden magic is
1122 actually confusing and may cause incorrect formulas, and I do
1123 agree. Therefore, trying to cross a hline with a relative
1124 reference will now throw an error.
1126 If you need the old behavior, customize the variable
1127 `org-table-error-on-row-ref-crossing-hline'.
1131 *** New relative timer to support timed notes
1133 Org now supports taking timed notes, useful for example while
1134 watching a video, or during a meeting which is also recorded.
1137 Insert a relative time into the buffer. The first time
1138 you use this, the timer will be started. When called
1139 with a prefix argument, the timer is reset to 0.
1142 Insert a description list item with the current relative
1143 time. With a prefix argument, first reset the timer to 0.
1146 Once the time list has been initiated, you can also use the
1147 normal item-creating command to insert the next timer item.
1150 Reset the timer without inserting anything into the buffer.
1151 By default, the timer is reset to 0. When called with a
1152 =C-u= prefix, reset the timer to specific starting
1153 offset. The user is prompted for the offset, with a
1154 default taken from a timer string at point, if any, So this
1155 can be used to restart taking notes after a break in the
1156 process. When called with a double prefix argument
1157 =C-c C-u=, change all timer strings in the active
1158 region by a certain amount. This can be used to fix timer
1159 strings if the timer was not started at exactly the right
1162 Thanks to Alan Dove, Adam Spiers, and Alan Davis for
1163 contributions to this idea.
1165 *** Special faces can be set for individual tags
1167 You may now use the variable =org-tag-faces= to define the
1168 face used for specific tags, much in the same way as you can
1169 do for TODO keywords.
1171 Thanks to Samuel Wales for this proposal.
1173 *** The agenda shows now all tags, including inherited ones.
1175 This request has come up often, most recently it was
1176 formulated by Tassilo Horn.
1178 If you prefer the old behavior of only showing the local
1179 tags, customize the variable =org-agenda-show-inherited-tags=.
1181 *** Exclude some tags from inheritance.
1183 So far, the only way to select tags for inheritance was to
1184 allow it for all tags, or to do a positive selection using
1185 one of the more complex settings for
1186 `org-use-tag-inheritance'. It may actually be better to
1187 allow inheritance for all but a few tags, which was difficult
1188 to achieve with this methodology.
1190 A new option, `org-tags-exclude-from-inheritance', allows to
1191 specify an exclusion list for inherited tags.
1193 *** More special values for time comparisons in property searches
1195 In addition to =<now>=, =<today>=, =<yesterday>=, and
1196 =<tomorrow>=, there are more special values accepted now in
1197 time comparisons in property searches: You may use strings
1198 like =<+3d>= or =<-2w>=, with units d, w, m, and y for day,
1199 week, month, and year, respectively
1201 Thanks to Linday Todd for this proposal.
1203 *** Control for exporting meta data
1205 All the metadata in a headline, i.e. the TODO keyword, the
1206 priority cookie, and the tags, can now be excluded from
1207 export with appropriate options:
1209 | Variable | Publishing property | OPTIONS switch |
1210 |-------------------------------+---------------------+----------------|
1211 | org-export-with-todo-keywords | :todo-keywords | todo: |
1212 | org-export-with-tags | :tags | tags: |
1213 | org-export-with-priority | :priority | pri: |
1215 *** Cut and Paste with hot links from w3m to Org
1217 You can now use the key =C-c C-x M-w= in a w3m buffer with
1218 HTML content to copy either the region or the entire file in
1219 a special way. When you yank this text back into an Org-mode
1220 buffer, all links from the w3m buffer will continue to work
1223 For this to work you need to load the new file /org-w3m.el./
1224 Please check your org-modules variable to make sure that this
1227 Thanks for Richard Riley for the idea and to Andy Stewart for
1230 *** LOCATION can be inherited for iCalendar export
1232 The LOCATION property can now be inherited during iCalendar
1233 export if you configure =org-use-property-inheritance= like
1236 #+begin_src emacs-lisp
1237 (setq org-use-property-inheritance '("LOCATION"))
1244 - Keybindings in Remember buffers can be configured
1245 - Support for ido completion
1246 - New face for date lines in agenda column view
1247 - Invisible targets become now anchors in headlines.
1248 - New contributed file /org-exp-blocks.el/
1249 - New contributed file /org-eval-light.el/
1251 - BBDB links may use regular expressions.
1252 - Link abbreviations can use %h to insert a url-encoded target value
1253 - Improved XHTML compliance
1257 *** Keybindings in Remember buffers can be configured
1259 The remember buffers created with Org's extensions are in
1260 Org-mode, which is nice to prepare snippets that will
1261 actually be stored in Org-mode files. However, this makes it
1262 hard to configure key bindings without modifying the Org-mode
1263 keymap. There is now a minor mode active in these buffers,
1264 `org-remember-mode', and its keymap org-remember-mode-map can
1265 be used for key bindings. By default, this map only contains
1266 the bindings for =C-c C-c= to store the note, and =C-c C-k=
1267 to abort it. Use `org-remember-mode-hook' to define your own
1270 #+begin_src emacs-lisp
1272 'org-remember-mode-hook
1274 (define-key org-remember-mode-map
1275 "\C-x\C-s" 'org-remember-finalize)))
1278 If you wish, you can also use this to free the =C-c C-c=
1279 binding (by binding this key to nil in the minor mode map),
1280 so that you can use =C-c C-c= again to set tags.
1282 This modification is based on a request by Tim O'Callaghan.
1284 *** Support for ido completion
1286 You can now get the completion interface from /ido.el/ for
1287 many of Org's internal completion commands by turning on the
1288 variable =org-completion-use-ido=. =ido-mode= must also be
1289 active before you can use this.
1291 This change is based upon a request by Samuel Wales.
1293 *** New face for date lines in agenda column view
1295 When column view is active in the agenda, and when you have
1296 summarizing properties, the date lines become normal column
1297 lines and the separation between different days becomes
1298 harder to see. If this bothers you, you can now customize
1299 the face =org-agenda-column-dateline=.
1301 This is based on a request by George Pearson.
1303 *** Invisible targets become now anchors in headlines.
1305 These anchors can be used to jump to a directly with an HTML
1306 link, just like the =sec-xxx= IDs. For example, the
1307 following will make a http link
1308 =//domain/path-to-my-file.html#dummy= work:
1315 This is based on a request by Matt Lundin.
1317 *** New contributed file /org-exp-blocks.el/
1319 This new file implements special export behavior of
1320 user-defined blocks. The currently supported blocks are
1322 - comment :: Comment blocks with author-specific markup
1323 - ditaa :: conversion of ASCII art into pretty png files
1324 using Stathis Sideris' /ditaa.jar/ program
1325 - dot :: creation of graphs in the /dot/ language
1326 - R :: Sweave type exporting using the R program
1328 For more details and examples, see the file commentary in
1329 /org-exp-blocks.el/.
1331 Kudos to Eric Schulte for this new functionality, after
1332 /org-plot.el/ already his second major contribution. Thanks
1333 to Stathis for this excellent program, and for allowing us to
1334 bundle it with Org-mode.
1336 *** New contributed file /org-eval-light.el/
1338 This module gives control over execution Emacs Lisp code
1339 blocks included in a file.
1341 Thanks to Eric Schulte also for this file.
1343 *** Link translation
1345 You can now configure Org to understand many links created
1346 with the Emacs Planner package, so you can cut text from
1347 planner pages and paste them into Org-mode files without
1348 having to re-write the links. Among other things, this means
1349 that the command =org-open-at-point-global= which follows
1350 links not only in Org-mode, but in arbitrary files like
1351 source code files etc, will work also with links created by
1352 planner. The following customization is needed to make all of
1355 #+begin_src emacs-lisp
1356 (setq org-link-translation-function
1357 'org-translate-link-from-planner)
1360 I guess an inverse translator could be written and integrated
1363 *** BBDB links may use regular expressions.
1365 This did work all along, but only now I have documented it.
1367 *** =yank-pop= works again after yanking an outline tree
1369 Samuel Wales had noticed that =org-yank= did mess up this
1370 functionality. Now you can use =yank-pop= again, the only
1371 restriction is that the so-yanked text will not be
1372 pro/demoted or folded.
1374 *** Link abbreviations can use %h to insert a url-encoded target value
1376 Thanks to Steve Purcell for a patch to this effect.
1378 *** Improved XHTML compliance
1380 Thanks to Sebastian Rose for pushing this.
1382 *** Many bug fixes again.
1387 - A region of entries can now be refiled with a single command
1388 - Fine-tuning the behavior of `org-yank'
1389 - Formulas for clocktables
1390 - Better implementation of footnotes for HTML export
1391 - More languages for HTML export.
1395 *** A region of entries can now be refiled with a single command
1397 With =transient-make-mode= active (=zmacs-regions= under
1398 XEmacs), you can now select a region of entries and refile
1399 them all with a single =C-c C-w= command.
1401 Thanks to Samuel Wales for this useful proposal.
1403 *** Fine-tuning the behavior of =org-yank=
1405 The behavior of Org's yanking command has been further
1406 fine-tuned in order to avoid some of the small annoyances
1407 this command caused.
1409 - Calling =org-yank= with a prefix arg will stop any special
1410 treatment and directly pass through to the normal =yank=
1411 command. Therefore, you can now force a normal yank with
1414 - Subtrees will only be folded after a yank if doing so will
1415 now swallow any non-white characters after the yanked text.
1416 This is, I think a really important change to make the
1417 command work more sanely.
1419 *** Formulas for clocktables
1421 You can now add formulas to a clock table, either by hand, or
1422 with a =:formula= parameter. These formulas can be used to
1423 create additional columns with further analysis of the
1426 Thanks to Jurgen Defurne for triggering this addition.
1428 *** Better implementation of footnotes for HTML export
1430 The footnote export in 6.11 really was not good enough. Now
1431 it works fine. If you have customized
1432 =footnote-section-tag=, make sure that your customization is
1433 matched by =footnote-section-tag-regexp=.
1435 Thanks to Sebastian Rose for pushing this change.
1437 *** More languages for HTML export.
1439 More languages are supported during HTML export. This is
1440 only relevant for the few special words Org inserts, like
1441 "Table of Contents", or "Footnotes". Also the encoding
1442 issues with this feature seem to be solved now.
1444 Thanks to Sebastian Rose for pushing me to fix the encoding
1451 - Yanking subtree with =C-y= now adjusts the tree level
1452 - State changes can now be shown in the log mode in the agenda
1453 - Footnote in HTML export are now collected at the end of the document
1454 - HTML export now validates again as XHTML
1455 - The clock can now be resumed after exiting and re-starting Emacs
1456 - Clock-related data can be saved and resumed across Emacs sessions
1457 - Following file links can now use C-u C-u to force use of an external app
1458 - Inserting absolute files names now abbreviates links with "~"
1459 - Links to attachment files
1460 - Completed repeated tasks listed briefly in agenda
1461 - Remove buffers created during publishing are removed
1465 *** Yanking subtree with =C-y= now adjusts the tree level
1466 When yanking a cut/copied subtree or a series of trees, the
1467 normal yank key =C-y= now adjusts the level of the tree to
1468 make it fit into the current outline position, without losing
1469 its identity, and without swallowing other subtrees.
1471 This uses the command =org-past-subtree=. An additional
1472 change in that command has been implemented: Normally, this
1473 command picks the right outline level from the surrounding
1474 *visible* headlines, and uses the smaller one. So if the
1475 cursor is between a level 4 and a level 3 headline, the tree
1476 will be pasted as level 3. If the cursor is actually *at*
1477 the beginning of a headline, the level of that headline will
1478 be used. For example, lets say you have a tree like this:
1484 ,(2)* Level one again
1487 with (1) and (2) indicating possible cursor positions for the
1488 insertion. When at (1), the tree will be pasted as level 2.
1489 When at (2), it will be pasted as level 1.
1491 If you do not want =C-y= to behave like this, configure the
1492 variable =org-yank-adjusted-subtrees=.
1494 Thanks to Samuel Wales for this idea and a partial implementation.
1496 *** State changes can now be shown in the log mode in the agenda
1498 If you configure the variable =org-agenda-log-mode-items=,
1499 you can now request that all logged state changes be included
1500 in the agenda when log mode is active. If you find this too
1501 much for normal applications, you can also temporarily
1502 request the inclusion of state changes by pressing =C-u l= in
1505 This was a request by Hsiu-Khuern Tang.
1507 You can also press `C-u C-u l' to get *only* log items in the
1508 agenda, withour any timestamps/deadlines etc.
1510 *** Footnote in HTML export are now collected at the end of the document
1511 Previously, footnotes would be left in the document where
1512 they are defined, now they are all collected and put into a
1513 special =<div>= at the end of the document.
1515 Thanks to Sebastian Rose for this request.
1517 *** HTML export now validates again as XHTML.
1519 Thanks to Sebastian Rose for pushing this cleanup.
1521 *** The clock can now be resumed after exiting and re-starting Emacs
1523 If the option =org-clock-in-resume= is t, and the first clock
1524 line in an entry is unclosed, clocking into that task resumes
1525 the clock from that time.
1527 Thanks to James TD Smith for a patch to this effect.
1529 *** Clock-related data can be saved and resumed across Emacs sessions
1531 The data saved include the contents of =org-clock-history=,
1532 and the running clock, if there is one.
1534 To use this, you will need to add to your .emacs
1536 #+begin_src emacs-lisp
1537 (setq org-clock-persist t)
1538 (setq org-clock-in-resume t)
1539 (org-clock-persistence-insinuate)
1542 Thanks to James TD Smith for a patch to this effect.
1544 *** Following file links can now use C-u C-u to force use of an external app.
1546 So far you could only bypass your setup in `org-file-apps'
1547 and force opening a file link in Emacs by using a =C-u= prefix arg
1548 with =C-c C-o=. Now you can call =C-u C-u C-c C-o= to force
1549 an external application. Which external application depends
1550 on your system. On Mac OS X and Windows, =open= is used. On
1551 a GNU/Linux system, the mailcap settings are used.
1553 This was a proposal by Samuel Wales.
1555 *** Inserting absolute files names now abbreviates links with "~".
1557 Inserting file links with =C-u C-c C-l= was buggy if the
1558 setting of `org-link-file-path-type' was `adaptive' (the
1559 default). Absolute file paths were not abbreviated relative
1560 to the users home directory. This bug has been fixed.
1562 Thanks to Matt Lundin for the report.
1564 *** Links to attachment files
1566 Even though one of the purposes of entry attachments was to
1567 reduce the number of links in an entry, one might still want
1568 to have the occasional link to one of those files. You can
1569 now use link abbreviations to set up a special link type that
1570 points to attachments in the current entry. Note that such
1571 links will only work from within the same entry that has the
1572 attachment, because the directory path is entry specific.
1573 Here is the setup you need:
1575 #+begin_src emacs-lisp
1576 (setq org-link-abbrev-alist '(("att" . org-attach-expand-link)))
1579 After this, a link like this will work
1582 [[att:some-attached-file.txt]]
1584 This was a proposal by Lindsay Todd.
1586 *** Completed repeated tasks listed briefly in agenda
1588 When a repeating task, listed in the daily/weekly agenda under
1589 today's date, is completed from the agenda, it is listed as
1590 DONE in the agenda until the next update happens. After the
1591 next update, the task will have disappeared, of course,
1592 because the new date is no longer today.
1594 *** Remove buffers created during publishing are removed
1596 Buffers that are created during publishing are now deleted
1597 when the publishing is over. At least I hope it works like this.
1603 - Secondary agenda filtering is becoming a killer feature
1604 - Setting tags has now its own binding, =C-c C-q=
1605 - Todo state changes can trigger tag changes
1606 - C-RET will now always insert a new headline, never an item.
1607 - Customize org-mouse.el feature set to free up mouse events
1608 - New commands for export all the way to PDF (through LaTeX)
1609 - Some bug fixed for LaTeX export, more bugs remain.
1613 *** Enhancements to secondary agenda filtering
1615 This is, I believe, becoming a killer feature. It allows you
1616 to define fewer and more general custom agenda commands, and
1617 then to do the final narrowing to specific tasks you are
1618 looking for very quickly, much faster than calling a new
1621 If you have not tries this yet, you should!
1623 **** You can now refining the current filter by an additional criterion
1624 When filtering an existing agenda view with =/=, you can
1625 now narrow down the existing selection by an additional
1626 condition. Do do this, use =\= instead of =/= to add the
1627 additional criterion. You can also press =+= or =-= after
1628 =/= to add a positive or negative condition. A condition
1629 can be a TAG, or an effort estimate limit, see below.
1631 **** It is now possible to filter for effort estimates
1632 This means to filter the agenda for the value of the Effort
1633 property. For this you should best set up global allowed
1634 values for effort estimates, with
1636 #+begin_src emacs-lisp
1637 (setq org-global-properties
1638 '(("Effort_ALL" . "0 0:10 0:30 1:00 2:00 3:00 4:00")))
1641 You may then select effort limits with single keys in the
1642 filter. It works like this: After =/= or =\=, first select
1643 the operator which you want to use to compare effort
1646 : < Select entries with effort smaller than or equal to the limit
1647 : > Select entries with effort larger than or equal to the limit
1648 : = Select entries with effort equal to the limit
1650 After that, you can press a single digit number which is
1651 used as an index to the allowed effort estimates.
1653 If you do not use digits to fast-select tags, you can even
1654 skip the operator, which will then default to
1655 `org-agenda-filter-effort-default-operator', which is by
1658 Thanks to Manish for the great idea to include fast effort
1659 filtering into the agenda filtering process.
1661 **** The mode line will show the active filter
1662 For example, if there is a filter in place that does select
1663 for HOME tags, against EMAIL tags, and for tasks with an
1664 estimated effort smaller than 30 minutes, the mode-line with
1665 show =+HOME-EMAIL+<0:30=
1667 **** The filter now persists when the agenda view is refreshed
1668 All normal refresh commands, including those that move the
1669 weekly agenda from one week to the next, now keep the
1670 current filter in place.
1672 You need to press =/ /= to turn off the filter. However,
1673 when you run a new agenda command, for example going from
1674 the weekly agenda to the TODO list, the filter will be
1677 *** Setting tags has now its own binding, =C-c C-q=
1679 You can still use =C-c C-c= on a headline, but the new
1680 binding should be considered as the main binding for this
1681 command. The reasons for this change are:
1683 - Using =C-c C-c= for tags is really out of line with other
1686 - I hate it in Remember buffers when I try to set tags and I
1687 cannot, because =C-c C-c= exits the buffer :-(
1689 - =C-c C-q= will also work when the cursor is somewhere down
1690 in the entry, it does not have to be on the headline.
1692 *** Todo state changes can trigger tag changes
1694 The new option =org-todo-state-tags-triggers= can be used to
1695 define automatic changes to tags when a TODO state changes.
1696 For example, the setting
1698 : (setq org-todo-state-tags-triggers
1699 : '((done ("Today" . nil) ("NEXT" . nil))
1700 : ("WAITING" ("Today" . t))))
1702 will make sure that any change to any of the DONE states will
1703 remove tags "Today" and "NEXT", while switching to the
1704 "WAITING" state will trigger the tag "Today" to be added.
1706 I use this mostly to get rid of TODAY and NEXT tags which I
1707 apply to select an entry for execution in the near future,
1708 which I often prefer to specific time scheduling.
1710 *** C-RET will now always insert a new headline, never an item.
1711 The new headline is inserted after the current subtree.
1713 Thanks to Peter Jones for patches to fine-tune this behavior.
1715 *** Customize org-mouse.el feature set
1716 There is a new variable =org-mouse-features= which gives you
1717 some control about what features of org-mouse you want to
1718 use. Turning off some of the feature will free up the
1719 corresponding mouse events, or will avoid activating special
1720 regions for mouse clicks. By default I have urned off the
1721 feature to use drag mouse events to move or promote/demote
1722 entries. You can of course turn them back on if you wish.
1724 This variable may still change in the future, allowing more
1725 fine-grained control.
1727 *** New commands for export to PDF
1729 This is using LaTeX export, and then processes it to PDF
1732 : C-c C-e p process to PDF.
1733 : C-c C-e d process to PDF, and open the file.
1736 - \usepackage{graphicx} is now part of the standard class
1738 - Several bugs fixed, but definitely not all of them :-(
1740 *** New option `org-log-state-notes-insert-after-drawers'
1742 Set this to =t= if you want state change notes to be inserted
1743 after any initial drawers, i.e drawers the immediately follow
1744 the headline and the planning line (the one with
1745 DEADLINE/SCHEDULED/CLOSED information).
1749 *** =org-file-apps= now uses regular expressions, see [[*%20org%20file%20apps%20now%20uses%20regular%20repressions%20instead%20of%20extensions][below]]
1753 *** =org-file-apps= now uses regular repressions instead of extensions
1754 Just like in =auto-mode-alist=, car's in the variable
1755 =org-file-apps= that are strings are now interpreted as
1756 regular expressions that are matched against a file name. So
1757 instead of "txt", you should now write "\\.txt\\'" to make
1758 sure the matching is done correctly (even though "txt" will
1759 be recognized and still be interpreted as an extension).
1761 There is now a shortcut to get many file types visited by
1762 Emacs. If org-file-apps contains `(auto-mode . emacs)', then
1763 any files that are matched by `auto-mode-alist' will be
1766 *** Changes to the attachment system
1768 - The default method to attach a file is now to copy it
1769 instead of moving it.
1770 - You can modify the default method using the variable
1771 `org-attach-method'. I believe that most Unix people want
1772 to set it to `ln' to create hard links.
1773 - The keys =c=, =m=, and =l= specifically select =copy=,
1774 =move=, or =link=, respectively, as the attachment method
1775 for a file, overruling `org-attach-method'.
1776 - To create a new attachment as an Emacs buffer, you have not
1777 now use =n= instead of =c=.
1778 - The file list is now always retrieved from the directory
1779 itself, not from the "Attachments" property. We still
1780 keep this property by default, but you can turn it off, by
1781 customizing the variable =org-attach-file-list-property=.
1785 ** Incompatible changes
1787 - Changes in the structure of IDs, see [[*The%20default%20structure%20of%20IDs%20has%20changed][here]] for details.
1789 - C-c C-a has been redefined, see [[*%20C%20c%20C%20a%20no%20longer%20calls%20show%20all][here]] for details.
1793 *** The default structure of IDs has changed
1795 IDs created by Org have changed a bit:
1796 - By default, there is no prefix on the ID. There used to be
1797 an "Org" prefix, but I now think this is not necessary.
1798 - IDs use only lower-case letters, no upper-case letters
1799 anymore. The reason for this is that IDs are now also used
1800 as directory names for org-attach, and some systems do not
1801 distinguish upper and lower case in the file system.
1802 - The ID string derived from the current time is now
1803 /reversed/ to become an ID. This assures that the first
1804 two letters of the ID change fast, so hat it makes sense to
1805 split them off to create subdirectories to balance load.
1806 - You can now set the `org-id-method' to `uuidgen' on systems
1809 *** =C-c C-a= no longer calls `show-all'
1811 The reason for this is that =C-c C-a= is now used for the
1812 attachment system. On the rare occasions that this command
1813 is needed, use =M-x show-all=, or =C-u C-u C-u TAB=.
1815 *** New attachment system
1817 You can now attach files to each node in the outline tree.
1818 This works by creating special directories based on the ID of
1819 an entry, and storing files in these directories. Org can
1820 keep track of changes to the attachments by automatically
1821 committing changes to git. See the manual for more
1824 Thanks to John Wiegley who contributed this fantastic new
1825 concept and wrote org-attach.el to implement it.
1827 *** New remember template escapes
1829 : %^{prop}p to insert a property
1830 : %k the heading of the item currently being clocked
1831 : %K a link to the heading of the item currently being clocked
1833 Also, when you exit remember with =C-2 C-c C-c=, the item
1834 will be filed as a child of the item currently being
1835 clocked. So the idea is, if you are working on something and
1836 think of a new task related to this or a new note to be
1837 added, you can use this to quickly add information to that
1840 Thanks to James TD Smith for a patch to this effect.
1842 *** Clicking with mouse-2 on clock info in mode-line visits the clock.
1844 Thanks to James TD Smith for a patch to this effect.
1846 *** New file in contrib: lisp/org-checklist.el
1848 This module deals with repeated tasks that have checkbox
1851 Thanks to James TD Smith for this contribution.
1853 *** New in-buffer setting #+STYLE
1855 It can be used to locally set the variable
1856 `org-export-html-style-extra'. Several such lines are
1857 allowed-, they will all be concatenated. For an example on
1858 how to use it, see the [[http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php][publishing tutorial]].
1864 - Filtering existing agenda views with respect to a tag
1865 - Editing fixed-width regions with picture or artist mode
1866 - /org-plot.el/ is now part of Org
1867 - Tags can be used to select the export part of a document
1868 - Prefix interpretation when storing remember notes
1869 - Yanking inserts folded subtrees
1870 - Column view capture tables can have formulas, plotting info
1871 - In column view, date stamps can be changed with S-cursor keys
1872 - The note buffer for clocking out now mentions the task
1873 - Sorting entries alphabetically ignores TODO keyword and priority
1874 - Agenda views can sort entries by TODO state
1875 - New face =org-scheduled= for entries scheduled in the future.
1876 - Remember templates for gnus links can use the :to escape.
1877 - The file specification in a remember template may be a function
1878 - Categories in iCalendar export include local tags
1879 - It is possible to define filters for column view
1880 - Disabling integer increment during table Field copy
1881 - Capturing column view is on `C-c C-x i'
1882 - And tons of bugs fixed.
1885 ** Incompatible changes
1887 *** Prefix interpretation when storing remember notes has changed
1889 The prefix argument to the `C-c C-c' command that finishes a
1890 remember process is now interpreted differently:
1892 : C-c C-c Store the note to predefined file and headline
1893 : C-u C-c C-c Like C-c C-c, but immediately visit the note
1894 : in its new location.
1895 : C-1 C-c C-c Select the storage location interactively
1896 : C-0 C-c C-c Re-use the last used location
1898 This was requested by John Wiegley.
1900 *** Capturing column view is now on `C-c C-x i'
1902 The reason for this change was that `C-c C-x r' is also used
1903 as a tty key replacement.
1905 *** Categories in iCalendar export now include local tags
1907 The locally defined tags are now listed as categories when
1908 exporting to iCalendar format. Org's traditional file/tree
1909 category is now the last category in this list. Configure
1910 the variable =org-icalendar-categories= to modify or revert
1913 This was a request by Charles Philip Chan.
1917 *** Secondary filtering of agenda views.
1919 You can now easily and interactively filter an existing
1920 agenda view with respect to a tag. This command is executed
1921 with the =/= key in the agenda. You will be prompted for a
1922 tag selection key, and all entries that do not contain or
1923 inherit the corresponding tag will be hidden. With a prefix
1924 argument, the opposite filter is applied: entries that
1925 do have the tag will be hidden.
1927 This operation only /hides/ lines in the agenda buffer, it
1928 does not remove them. Changing the secondary filtering does
1929 not require a new search and is very fast.
1931 If you press TAB at the tag selection prompt, you will be
1932 switched to a completion interface to select a tag. This is
1933 useful when you want to select a tag that does not have a
1934 direct access character.
1936 A double =/ /= will restore the original agenda view by
1937 unhiding any hidden lines.
1939 This functionality was John Wiegley's idea. It is a simpler
1940 implementation of some of the query-editing features proposed
1941 and implemented some time ago by Christopher League (see the
1942 file contrib/lisp/org-interactive-query.el).
1944 *** Editing fixed-width regions with picture or artist mode
1946 The command @<code>C-c '@</code> (that is =C-c= followed by a
1947 single quote) can now also be used to switch to a special
1948 editing mode for fixed-width sections. The default mode is
1949 =artist-mode= which allows you to create ASCII drawings.
1951 It works like this: Enter the editing mode with
1952 @<code>C-c '@</code>. An indirect buffer will be created and
1953 narrowed to the fixed-width region. Edit the drawing, and
1954 press @<code>C-c '@</code> again to exit.
1956 Lines in a fixed-width region should be preceded by a colon
1957 followed by at least one space. These will be removed during
1958 editing, and then added back when you exit the editing mode.
1960 Using the command in an empty line will create a new
1963 This new feature arose from a discussion involving Scott
1964 Otterson, Sebastian Rose and Will Henney.
1966 *** /org-plot.el/ is now part of Org.
1968 You can run it by simple calling org-plot/gnuplot.
1969 Documentation is not yet included with Org, please refer to
1970 http://github.com/eschulte/org-plot/tree/master until we have
1971 moved the docs into Org or Worg.
1973 Thanks to Eric Schulte for this great contribution.
1975 *** Tags can be used to select the export part of a document
1977 You may now use tags to select parts of a document for
1978 inclusion into the export, and to exclude other parts. This
1979 behavior is governed by two new variables:
1980 =org-export-select-tags= and =org-export-exclude-tags=.
1981 These default to =("export")= and =("noexport")=, but can be
1982 changed, even to include a list of several tags.
1984 Org first checks if any of the /select/ tags is present in
1985 the buffer. If yes, all trees that do not carry one of these
1986 tags will be excluded. If a selected tree is a subtree, the
1987 heading hierarchy above it will also be selected for export,
1988 but not the text below those headings. If none of the select
1989 tags is found anywhere in the buffer, the whole buffer will
1990 be selected for export. Finally, all subtrees that are
1991 marked by any of the /exclude/ tags will be removed from the
1994 You may set these tags with in-buffer options
1995 =EXPORT_SELECT_TAGS= and =EXPORT_EXCLUDE_TAGS=.
1997 I love this feature. Thanks to Richard G Riley for coming
2000 *** Prefix interpretation when storing remember notes
2002 The prefix argument to the `C-c C-c' command that finishes a
2003 remember process is now interpreted differently:
2005 : C-c C-c Store the note to predefined file and headline
2006 : C-u C-c C-c Like C-c C-c, but immediately visit the note
2007 : in its new location.
2008 : C-1 C-c C-c Select the storage location interactively
2009 : C-0 C-c C-c Re-use the last used location
2011 This was requested by John Wiegley.
2013 *** Yanking inserts folded subtrees
2015 If the kill is a subtree or a sequence of subtrees, yanking
2016 them with =C-y= will leave all the subtrees in a folded
2017 state. This basically means, that kill and yank are now
2018 much more useful in moving stuff around in your outline. If
2019 you do not like this, customize the variable
2020 =org-yank-folded-subtrees=.
2022 Right now, I am only binding =C-y= to this new function,
2023 should I modify all bindings of yank? Do we need to amend
2026 This feature was requested by John Wiegley.
2028 *** Column view capture tables can have formulas, plotting info
2030 If you attach formulas and plotting instructions to a table
2031 capturing column view, these extra lines will now survive an
2032 update of the column view capture, and any formulas will be
2033 re-applied to the captured table. This works by keeping any
2034 continuous block of comments before and after the actual
2037 *** In column view, date stamps can be changed with S-cursor keys
2039 If a property value is a time stamp, S-left and S-right can
2040 now be used to shift this date around while in column view.
2042 This was a request by Chris Randle.
2044 *** The note buffer for clocking out now mentions the task
2046 This was a request by Peter Frings.
2048 *** Sorting entries alphabetically ignores TODO keyword and priority
2050 Numerical and alphanumerical sorting now skips any TODO
2051 keyword or priority cookie when constructing the comparison
2052 string. This was a request by Wanrong Lin.
2054 *** Agenda views can sort entries by TODO state
2056 You can now define a sorting strategy for agenda entries that
2057 does look at the TODO state of the entries. Sorting by TODO
2058 entry does first separate the non-done from the done states.
2059 Within each class, the entries are sorted not alphabetically,
2060 but in definition order. So if you have a sequence of TODO
2061 entries defined, the entries will be sorted according to the
2062 position of the keyword in this sequence.
2064 This follows an idea and sample implementation by Christian
2067 *** New face =org-scheduled= for entries scheduled in the future.
2069 This was a request by Richard G Riley.
2071 *** Remember templates for gnus links can now use the :to escape.
2073 Thanks to Tommy Lindgren for a patch to this effect.
2074 *** The file specification in a remember template may now be a function
2076 Thanks to Gregory Sullivan for a patch to this effect.
2078 *** Categories in iCalendar export now include local tags
2080 The locally defined tags are now listed as categories when
2081 exporting to iCalendar format. Org's traditional file/tree
2082 category is now the last category in this list. Configure
2083 the variable =org-icalendar-categories= to modify or revert
2086 This was a request by Charles Philip Chan.
2088 *** It is now possible to define filters for column view
2090 The filter can modify the value that will be displayed in a
2091 column, for example it can cut out a part of a time stamp.
2092 For more information, look at the variable
2093 =org-columns-modify-value-for-display-function=.
2095 *** Disabling integer increment during table field copy
2097 Prefix arg 0 to S-RET does the trick.
2099 This was a request by Chris Randle.
2104 For older Changes, see [[file:Changes_old.org]]