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
18 ** Incompatible changes
20 *** Short examples must have a space after the colon
22 Short literal examples can be created by preceding lines
23 with a colon. Such lines must now have a space after the
24 colon. I believe this is already general practice, but now
25 it must be like this. The only exception are lines what are
26 empty except for the colon.
30 *** Include files can now also process switches
32 The example and src switches like =-n= can now also be added
33 to include file statements:
35 : #+INCLUDE "~/.emacs" src emacs-lisp -n -r
37 Thanks to Manish for pointing out that this was not yet
40 *** Examples can be exported to HTML as text areas
42 You can now specify a =-t= switch to an example or src block,
43 to make it export to HTML as a text area. To change the
44 defaults for height (number of lines in the example) and
45 width of this area (80), use the =-h= and =-w= switches.
47 Thanks to Ulf Stegemann for driving this development.
49 *** LaTeX_CLASS can be given as a property
51 When exporting a single subtree by selecting it as a region
52 before export, the LaTeX class for the export will be taken
53 from the =LaTeX_CLASS= property of the entry if present.
55 Thanks to Robert Goldman for this request.
57 *** Better handling of inlined images in different backends
59 Two new variables govern which kind of files can be inlined
60 during export. These are
61 =org-export-html-inline-image-extensions= and
62 =org-export-latex-inline-image-extensions=. Remember that
63 links are turned into an inline image if they are a pure link
64 with no description. HTML files can inline /.png/, /.jpg/,
65 and /.gif/ files, while LaTeX files, when processed with
66 /pdflatex/, can inline /.png/, /.jpg/, and /.pdf/ files.
67 These also represent the default settings for the new
68 variables. Note that this means that pure links to /.pdf/
69 files will be inlined - to avoid this for a particular link,
70 make sure that the link has a description part which is not
71 equal to the link part.
73 *** Links by ID now continue to work in HTML exported files
75 If you make links by ID, these links will now still work in
76 HTML exported files, provided that you keep the relative path
77 from link to target file the same.
79 Thanks to Friedrich Delgado Friedrichs for pushing this over
82 *** The relative timer can be paused
84 The new command `C-c C-x ,' will pause the relative timer.
85 When the relative timer is running, its value will be shown
86 in the mode line. To get rid of this display, you need to
87 really stop the timer with `C-u C-c C-x ,'.
89 Thanks to Alan Davis for driving this change.
91 *** The attachment directory may now be chosen by the user
93 Instead of using the automatic, unique directory related to
94 the entry ID, you can also use a chosen directory for the
95 attachments of an entry. This directory is specified by the
96 ATTACH_DIR property. You can use `C-c C-a s' to set this
99 Thanks to Jason Jackson for this proposal.
101 *** You can use a single attachment directory for a subtree
103 By setting the property ATTACH_DIR_INHERIT, you can now tell
104 Org that children of the entry should use the same directory
105 for attachments, unless a child explicitly defines its own
106 directory with the ATTACH_DIR property. You can use the
107 command `C-c C-a i' to set this property in an entry.
114 - Line numbers and references in literal examples
115 - New hooks for export preprocessing
116 - Capture column view into a different file
122 Org-mode now directly supports the creation of footnotes. In
123 contrast to the /footnote.el/ package, Org-mode's footnotes are
124 designed for work on a larger document, not only for one-off
125 documents like emails. The basic syntax is similar to the one
126 used by /footnote.el/, i.e. a footnote is defined in a paragraph
127 that is started by a footnote marker in square brackets in column
128 0, no indentation allowed. The footnote reference is simply the
129 marker in square brackets inside text. For example:
132 The Org homepage[fn:1] now looks a lot better than it used to.
134 [fn:1] The link is: http://orgmode.org
137 Org-mode extends the number-based syntax to /named/ footnotes and
138 optional inline definition. Using plain numbers as markers is
139 supported for backward compatibility, but not encouraged because
140 of possible conflicts with LaTeX syntax. Here are the valid
143 - [1] :: A plain numeric footnote marker.
145 - [fn:name] :: A named footnote reference, where `name' is a
146 unique label word or, for simplicity of automatic creation,
149 - [fn:: This is the inline definition of this footnote] :: A
150 LaTeX-like anonymous footnote where the definition is given
151 directly at the reference point.
153 - [fn:name: a definition] :: An inline definition of a footnote,
154 which also specifies a name for the note. Since Org allows
155 multiple references to the same note, you can then use use
156 `[fn:name]' to create additional references.
158 Footnote labels can be created automatically, or you create names
159 yourself. This is handled by the variable
160 =org-footnote-auto-label= and its corresponding =#+STARTUP=
161 keywords, see the docstring of that variable for details.
163 The following command handles footnotes:
165 - C-c C-x f :: The footnote action command. When the cursor is
166 on a footnote reference, jump to the definition. When it is
167 at a definition, jump to the (first) reference. Otherwise,
168 create a new footnote. Depending on the variable
169 `org-footnote-define-inline' (with associated =#+STARTUP=
170 options =fninline= and =nofninline=), the definitions will
171 be placed right into the text as part of the reference, or
172 separately into the location determined by the variable
173 =org-footnote-section=.
174 When this command is called with a prefix argument, a menu
175 of additional options is offered:
176 - s :: Sort the footnote definitions by reference sequence.
177 During editing, Org makes no effort to sort footnote
178 definitions into a particular sequence. If you want
179 them sorted, use this command, which will also move
180 entries according to =org-footnote-section=.
181 - n :: Normalize the footnotes by collecting all
182 definitions (including inline definitions) into a
183 special section, and then numbering them in
184 sequence. The references will then also be
185 numbers. This is meant to be the final step before
186 finishing a document (e.g. sending off an email).
187 The exporters do this automatically, and so could
188 something like `message-send-hook'.
189 - d :: Delete the footnote at point, and all references to it.
191 - C-c C-c :: If the cursor is on a footnote reference, jump to
192 the definition. If it is a the definition, jump back to the
193 reference. When called with a prefix argument at either
194 location, offer the same menu as `C-u C-c C-x f'.
196 - C-c C-o or mouse-1/2 :: Footnote labels are also links to the
197 corresponding definition/reference, and you can use the
198 usual commands to follow these links.
200 Org-mode's footnote support is designed so that it should also
201 work in buffers that are not in Org-mode, for example in email
202 messages. Just bind =org-footnote-action= to a global key like
205 The main trigger for this development came from a hook function
206 written by Paul Rivier, to implement named footnotes and to
207 convert them to numbered ones before export. Thanks, Paul!
209 Thanks also to Scot Becker for a thoughtful post bringing this
210 subject back onto the discussion table, and to Matt Lundin for
211 the idea of named footnotes and his prompt testing of the new
214 *** Line numbers and references in literal examples
216 Literal examples introduced with =#+BEGIN_EXAMPLE= or =#+BEGIN_SRC=
217 do now allow optional line numbering in the example.
218 Furthermore, links to specific code lines are supported, greatly
219 increasing Org-mode's utility for writing tutorials and other
222 Code references use special labels embedded directly into the
223 source code. Such labels look like "(ref:name)" and must be
224 unique within a document. Org-mode links with "(name)" in the
225 link part will be correctly interpreted, both while working with
226 an Org file (internal links), and while exporting to the
227 different backends. Line numbering and code references are
228 supported for all three major backends, HTML, LaTeX, and ASCII.
229 In the HTML backend, hovering the mouse over a link to a source
230 line will remote-highlight the referenced code line.
232 The options for the BEGIN lines are:
234 - -n :: Number the lines in the example
235 - +n :: Like -n, but continue numbering from where the previous
237 - -r :: Remove the coderef cookies from the example, and replace
238 links to this reference with line numbers. This option
239 takes only effect if either -n or +n are given as well.
240 If -r is not given, coderefs simply use the label name.
241 - -l "fmt" :: Define a local format for coderef labels, see the
242 variable =org-coderef-label-format= for details. Use this
243 of the default syntax causes conflicts with the code in the
244 code snippet you are using.
249 #+begin_src emacs-lisp -n -r
250 (defmacro org-unmodified (&rest body) (ref:def)
251 "Execute body without changing `buffer-modified-p'."
252 `(set-buffer-modified-p (ref:back)
253 (prog1 (buffer-modified-p) ,@body)))
255 [[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
259 When exported, this is translated to:
260 #+begin_src emacs-lisp -n -r
261 (defmacro org-unmodified (&rest body) (ref:def)
262 "Execute body without changing `buffer-modified-p'."
263 `(set-buffer-modified-p (ref:back)
264 (prog1 (buffer-modified-p) ,@body)))
266 [[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
269 Thanks to Ilya Shlyakhter for proposing this feature set. Thanks
270 to Sebastian Rose for the key Javascript element that made the
271 remote highlighting possible.
273 *** New hooks for export preprocessing
274 The export preprocessor now runs more hooks, to allow
275 better-timed tweaking by user functions:
277 - =org-export-preprocess-hook= ::
278 Pretty much the first thing in the preprocessor. But org-mode
279 is already active in the preprocessing buffer.
281 - =org-export-preprocess-after-include-files-hook= ::
282 This is run after the contents of included files have been inserted.
284 - =org-export-preprocess-after-tree-selection-hook= ::
285 This is run after selection of trees to be exported has
286 happened. This selection includes tags-based selection, as
287 well as removal of commented and archived trees.
289 - =org-export-preprocess-before-backend-specifics-hook= ::
290 Hook run before backend-specific functions are called during preprocessing.
292 - =org-export-preprocess-final-hook= ::
293 Hook for preprocessing an export buffer. This is run as the
294 last thing in the preprocessing buffer, just before returning
295 the buffer string to the backend.
297 *** Capture column view into a different file
299 The :id parameter for the dynamic block capturing column view
300 can now truly be an ID that will also be found in a
301 different file. Also, it can be like =file:path/to/file=, to
302 capture the global column view from a different file.
304 Thanks to Francois Lagarde for his report that IDs outside
305 the current file would not work.
308 Cleanup of many small bugs, and one new feature.
312 *** References to last table row with special names
314 Fields in the last row of a table can now be referenced with
315 $LR1, $LR2, etc. These references can appear both on the
316 left hand side and right hand side of a formula.
320 This version reverses the introduction of @0 as a reference to
321 the last rwo in a table, because of a conflict with the use of
322 @0 for the current row.
327 - All known LaTeX export issues fixed
328 - Captions and attributes for figures and tables.
329 - Better implementation for entry IDs
330 - Spreadsheet references to the last table line.
331 - Old syntax for link attributes abandoned
333 ** Incompatible changes
334 *** Old syntax for link attributes abandoned
336 There used to be a syntax for setting link attributes for
337 HTML export by enclosing the attributes into double braces
338 and adding them to the link itself, like
341 [[./img/a.jpg{{alt="an image"}}] ]
344 This syntax is not longer supported, use instead
347 ,#+ATTR_HTML: alt="an image"
353 *** All known LaTeX export issues fixed
355 All the remaining issues with the LaTeX exporter have hopefully
356 been addressed in this release. In particular, this covers
357 quoting of special characters in tables and problems with
358 exporting files where the headline is in the first line, or with
361 *** Captions and attributes for figures and tables.
363 Tables, and Hyperlinks that represent inlined images, can now be
364 equipped with additional information that will be used during
365 export. The information will be taken from the following special
366 lines in the buffer and apply to the first following table or
369 - #+CAPTION: :: The caption of the image or table. This string
370 should be processed according to the export backend, but
371 this is not yet done.
373 - #+LABEL: :: A label to identify the figure/table for cross
374 references. For HTML export, this string will become the
375 ID for the ~<div class="figure">~ element that encapsulates
376 the image tag and the caption. For LaTeX export, this
377 string will be used as the argument of a ~\label{...}~
378 macro. These labels will be available for internal links
379 like ~[[label][Table] ]~.
381 - #+ATTR_HTML: :: Attributes for HTML export of image, to be
382 added as attributes into the ~<img...>~ tag. This string
383 will not be processed, so it should have immediately the
386 - #+ATTR_LaTeX: :: Attributes for LaTeX export of images and
388 For /images/, this string is directly inserted into
389 the optional argument of the ~\includegraphics[...]{file}~
390 command, to specify scaling, clipping and other options.
391 This string will not be processed, so it should have
392 immediately the right format, like =width=5cm,angle=90=.\\
393 For /tables/, this can currently contain the keyword
394 =longtable=, to request typesetting of the table using the
395 longtable package, which automatically distributes the table
396 over several pages if needed. Also, the attributes line may
397 contain an alignment string for the tabular environment, like
398 =longtable,align=l|lrl=
400 For LaTeX export, if either a caption or a label is given, the element
401 will be exported as a float, i.e. wrapped into a figure or table
404 *** Better implementation for entry IDs
406 Unique identifiers for entries can now be used more efficiently.
407 Internally, a hash array has replaced the alist used so far to
408 keep track of the files in which an ID is defined. This makes it
409 quite fast to find an entry by ID.
411 There is a new link type which looks like this:
414 id:GLOBALLY-UNIQUE-IDENTIFIER
417 This link points to a specific entry. When you move the entry to
418 a different file, for example if you move it to an archive
419 file, the link will continue to work.
421 The file /org-id.el/ contains an API that can be used to write
422 code using these identifiers, including creating IDs and finding
423 them wherever they are.
425 Org has its own method to create unique identifiers, but if the system
426 has /uuidgen/ command installed (Mac's and Linux systems generally
427 do), it will be used by default (a change compared to the earlier
428 implmentation, where you explicitdly had to opt for uuidgen). You can
429 also select the method by hand, using the variable =org-id-method=.
431 If the ID system ever gets confused about where a certain ID is, it
432 initiates a global scan of all agenda files with associated archives,
433 all files previously known containing any IDs, and all currently
434 visited Org-mode files to rebuild the hash. You can also initiate
435 this by hand: =M-x org-id-update-id-locations=. Running this command
436 will also dump into the =*Messages*= buffer information about any
437 duplicate IDs. These should not exist, and Org will never /make/ the
438 same ID twice, but if you /copy/ an entry with its properties,
439 duplicate IDs will inevitably be produced. Unfortunately, this is
440 unavoidable in a plain text system that allows you to edit the text in
441 arbitrary ways, and a portion of care on your side is needed to keep
444 The hash is stored in the file =~/.emacs.d/.org-id-locations=.
445 This is also a change from previous versions where the file was
446 =~/.org=id-locations=. Therefore, you can remove this old file
447 if you have it. I am not sure what will happen if the =.emacs.d=
448 directory does not exists in your setup, but in modern Emacsen, I
449 believe it should exist. If you do not want to use IDs across
450 files, you can avoid the overhead with tracking IDs by
451 customizing the variable =org-id-track-globally=. IDs can then
452 still be used for links inside a single file.
454 IDs will also be used when you create a new link to an Org-mode
455 buffer. If you use =org-store-link= (normally at =C-c l=) inside
456 en entry in an Org-mode buffer, and ID property will be created
457 if it does not exist, and the stored link will be an =id:= link.
458 If you prefer the much less secure linking to headline text, you
459 can configure the variable =org-link-to-org-use-id=. The default
460 setting for this variable is =create-if-interactive=, meaning
461 that an ID will be created when you store a link interactively,
462 but not if you happen to be in an Org-mode file while you create
463 a remember note (which usually has a link to the place where you
464 were when starting remember).
466 *** Spreadsheet references to the last table line.
468 You may now use =@0= to reference the last dataline in a table
469 in a stable way. This is useful in particular for automatically
470 generated tables like the ones using /org-collector.el/ by Eric
476 - New relative timer to support timed notes
477 - Special faces can be set for individual tags
478 - The agenda shows now all tags, including inherited ones.
479 - Exclude some tags from inheritance.
480 - More special values for time comparisons in property searches
481 - Control for exporting meta data
482 - Cut and Paste with hot links from w3m to Org
483 - LOCATION can be inherited for iCalendar export
484 - Relative row references crossing hlines now throw an error
486 ** Incompatible Changes
488 *** Relative row references crossing hlines now throw an error
490 Relative row references in tables look like this: "@-4" which
491 means the forth row above this one. These row references are
492 not allowed to cross horizontal separator lines (hlines). So
493 far, when a row reference violates this policy, Org would
494 silently choose the field just next to the hline.
496 Tassilo Horn pointed out that this kind of hidden magic is
497 actually confusing and may cause incorrect formulas, and I do
498 agree. Therefore, trying to cross a hline with a relative
499 reference will now throw an error.
501 If you need the old behavior, customize the variable
502 `org-table-error-on-row-ref-crossing-hline'.
506 *** New relative timer to support timed notes
508 Org now supports taking timed notes, useful for example while
509 watching a video, or during a meeting which is also recorded.
512 Insert a relative time into the buffer. The first time
513 you use this, the timer will be started. When called
514 with a prefix argument, the timer is reset to 0.
517 Insert a description list item with the current relative
518 time. With a prefix argument, first reset the timer to 0.
521 Once the time list has been initiated, you can also use the
522 normal item-creating command to insert the next timer item.
525 Reset the timer without inserting anything into the buffer.
526 By default, the timer is reset to 0. When called with a
527 =C-u= prefix, reset the timer to specific starting
528 offset. The user is prompted for the offset, with a
529 default taken from a timer string at point, if any, So this
530 can be used to restart taking notes after a break in the
531 process. When called with a double prefix argument
532 =C-c C-u=, change all timer strings in the active
533 region by a certain amount. This can be used to fix timer
534 strings if the timer was not started at exactly the right
537 Thanks to Alan Dove, Adam Spiers, and Alan Davis for
538 contributions to this idea.
540 *** Special faces can be set for individual tags
542 You may now use the variable =org-tag-faces= to define the
543 face used for specific tags, much in the same way as you can
544 do for TODO keywords.
546 Thanks to Samuel Wales for this proposal.
548 *** The agenda shows now all tags, including inherited ones.
550 This request has come up often, most recently it was
551 formulated by Tassilo Horn.
553 If you prefer the old behavior of only showing the local
554 tags, customize the variable =org-agenda-show-inherited-tags=.
556 *** Exclude some tags from inheritance.
558 So far, the only way to select tags for inheritance was to
559 allow it for all tags, or to do a positive selection using
560 one of the more complex settings for
561 `org-use-tag-inheritance'. It may actually be better to
562 allow inheritance for all but a few tags, which was difficult
563 to achieve with this methodology.
565 A new option, `org-tags-exclude-from-inheritance', allows to
566 specify an exclusion list for inherited tags.
568 *** More special values for time comparisons in property searches
570 In addition to =<now>=, =<today>=, =<yesterday>=, and
571 =<tomorrow>=, there are more special values accepted now in
572 time comparisons in property searches: You may use strings
573 like =<+3d>= or =<-2w>=, with units d, w, m, and y for day,
574 week, month, and year, respectively
576 Thanks to Linday Todd for this proposal.
578 *** Control for exporting meta data
580 All the metadata in a headline, i.e. the TODO keyword, the
581 priority cookie, and the tags, can now be excluded from
582 export with appropriate options:
584 | Variable | Publishing property | OPTIONS switch |
585 |-------------------------------+---------------------+----------------|
586 | org-export-with-todo-keywords | :todo-keywords | todo: |
587 | org-export-with-tags | :tags | tags: |
588 | org-export-with-priority | :priority | pri: |
590 *** Cut and Paste with hot links from w3m to Org
592 You can now use the key =C-c C-x M-w= in a w3m buffer with
593 HTML content to copy either the region or the entire file in
594 a special way. When you yank this text back into an Org-mode
595 buffer, all links from the w3m buffer will continue to work
598 For this to work you need to load the new file /org-w3m.el./
599 Please check your org-modules variable to make sure that this
602 Thanks for Richard Riley for the idea and to Andy Stewart for
605 *** LOCATION can be inherited for iCalendar export
607 The LOCATION property can now be inherited during iCalendar
608 export if you configure =org-use-property-inheritance= like
611 #+begin_src emacs-lisp
612 (setq org-use-property-inheritance '("LOCATION"))
619 - Keybindings in Remember buffers can be configured
620 - Support for ido completion
621 - New face for date lines in agenda column view
622 - Invisible targets become now anchors in headlines.
623 - New contributed file /org-exp-blocks.el/
624 - New contributed file /org-eval-light.el/
626 - BBDB links may use regular expressions.
627 - Link abbreviations can use %h to insert a url-encoded target value
628 - Improved XHTML compliance
632 *** Keybindings in Remember buffers can be configured
634 The remember buffers created with Org's extensions are in
635 Org-mode, which is nice to prepare snippets that will
636 actually be stored in Org-mode files. However, this makes it
637 hard to configure key bindings without modifying the Org-mode
638 keymap. There is now a minor mode active in these buffers,
639 `org-remember-mode', and its keymap org-remember-mode-map can
640 be used for key bindings. By default, this map only contains
641 the bindings for =C-c C-c= to store the note, and =C-c C-k=
642 to abort it. Use `org-remember-mode-hook' to define your own
645 #+begin_src emacs-lisp
647 'org-remember-mode-hook
649 (define-key org-remember-mode-map
650 "\C-x\C-s" 'org-remember-finalize)))
653 If you wish, you can also use this to free the =C-c C-c=
654 binding (by binding this key to nil in the minor mode map),
655 so that you can use =C-c C-c= again to set tags.
657 This modification is based on a request by Tim O'Callaghan.
659 *** Support for ido completion
661 You can now get the completion interface from /ido.el/ for
662 many of Org's internal completion commands by turning on the
663 variable =org-completion-use-ido=. =ido-mode= must also be
664 active before you can use this.
666 This change is based upon a request by Samuel Wales.
668 *** New face for date lines in agenda column view
670 When column view is active in the agenda, and when you have
671 summarizing properties, the date lines become normal column
672 lines and the separation between different days becomes
673 harder to see. If this bothers you, you can now customize
674 the face =org-agenda-column-dateline=.
676 This is based on a request by George Pearson.
678 *** Invisible targets become now anchors in headlines.
680 These anchors can be used to jump to a directly with an HTML
681 link, just like the =sec-xxx= IDs. For example, the
682 following will make a http link
683 =//domain/path-to-my-file.html#dummy= work:
690 This is based on a request by Matt Lundin.
692 *** New contributed file /org-exp-blocks.el/
694 This new file implements special export behavior of
695 user-defined blocks. The currently supported blocks are
697 - comment :: Comment blocks with author-specific markup
698 - ditaa :: conversion of ASCII art into pretty png files
699 using Stathis Sideris' /ditaa.jar/ program
700 - dot :: creation of graphs in the /dot/ language
701 - R :: Sweave type exporting using the R program
703 For more details and examples, see the file commentary in
706 Kudos to Eric Schulte for this new functionality, after
707 /org-plot.el/ already his second major contribution. Thanks
708 to Stathis for this excellent program, and for allowing us to
709 bundle it with Org-mode.
711 *** New contributed file /org-eval-light.el/
713 This module gives control over execution Emacs Lisp code
714 blocks included in a file.
716 Thanks to Eric Schulte also for this file.
720 You can now configure Org to understand many links created
721 with the Emacs Planner package, so you can cut text from
722 planner pages and paste them into Org-mode files without
723 having to re-write the links. Among other things, this means
724 that the command =org-open-at-point-global= which follows
725 links not only in Org-mode, but in arbitrary files like
726 source code files etc, will work also with links created by
727 planner. The following customization is needed to make all of
730 #+begin_src emacs-lisp
731 (setq org-link-translation-function
732 'org-translate-link-from-planner)
735 I guess an inverse translator could be written and integrated
738 *** BBDB links may use regular expressions.
740 This did work all along, but only now I have documented it.
742 *** =yank-pop= works again after yanking an outline tree
744 Samuel Wales had noticed that =org-yank= did mess up this
745 functionality. Now you can use =yank-pop= again, the only
746 restriction is that the so-yanked text will not be
747 pro/demoted or folded.
749 *** Link abbreviations can use %h to insert a url-encoded target value
751 Thanks to Steve Purcell for a patch to this effect.
753 *** Improved XHTML compliance
755 Thanks to Sebastian Rose for pushing this.
757 *** Many bug fixes again.
762 - A region of entries can now be refiled with a single command
763 - Fine-tuning the behavior of `org-yank'
764 - Formulas for clocktables
765 - Better implementation of footnotes for HTML export
766 - More languages for HTML export.
770 *** A region of entries can now be refiled with a single command
772 With =transient-make-mode= active (=zmacs-regions= under
773 XEmacs), you can now select a region of entries and refile
774 them all with a single =C-c C-w= command.
776 Thanks to Samuel Wales for this useful proposal.
778 *** Fine-tuning the behavior of =org-yank=
780 The behavior of Org's yanking command has been further
781 fine-tuned in order to avoid some of the small annoyances
784 - Calling =org-yank= with a prefix arg will stop any special
785 treatment and directly pass through to the normal =yank=
786 command. Therefore, you can now force a normal yank with
789 - Subtrees will only be folded after a yank if doing so will
790 now swallow any non-white characters after the yanked text.
791 This is, I think a really important change to make the
792 command work more sanely.
794 *** Formulas for clocktables
796 You can now add formulas to a clock table, either by hand, or
797 with a =:formula= parameter. These formulas can be used to
798 create additional columns with further analysis of the
801 Thanks to Jurgen Defurne for triggering this addition.
803 *** Better implementation of footnotes for HTML export
805 The footnote export in 6.11 really was not good enough. Now
806 it works fine. If you have customized
807 =footnote-section-tag=, make sure that your customization is
808 matched by =footnote-section-tag-regexp=.
810 Thanks to Sebastian Rose for pushing this change.
812 *** More languages for HTML export.
814 More languages are supported during HTML export. This is
815 only relevant for the few special words Org inserts, like
816 "Table of Contents", or "Footnotes". Also the encoding
817 issues with this feature seem to be solved now.
819 Thanks to Sebastian Rose for pushing me to fix the encoding
826 - Yanking subtree with =C-y= now adjusts the tree level
827 - State changes can now be shown in the log mode in the agenda
828 - Footnote in HTML export are now collected at the end of the document
829 - HTML export now validates again as XHTML
830 - The clock can now be resumed after exiting and re-starting Emacs
831 - Clock-related data can be saved and resumed across Emacs sessions
832 - Following file links can now use C-u C-u to force use of an external app
833 - Inserting absolute files names now abbreviates links with "~"
834 - Links to attachment files
835 - Completed repeated tasks listed briefly in agenda
836 - Remove buffers created during publishing are removed
840 *** Yanking subtree with =C-y= now adjusts the tree level
841 When yanking a cut/copied subtree or a series of trees, the
842 normal yank key =C-y= now adjusts the level of the tree to
843 make it fit into the current outline position, without losing
844 its identity, and without swallowing other subtrees.
846 This uses the command =org-past-subtree=. An additional
847 change in that command has been implemented: Normally, this
848 command picks the right outline level from the surrounding
849 *visible* headlines, and uses the smaller one. So if the
850 cursor is between a level 4 and a level 3 headline, the tree
851 will be pasted as level 3. If the cursor is actually *at*
852 the beginning of a headline, the level of that headline will
853 be used. For example, lets say you have a tree like this:
859 ,(2)* Level one again
862 with (1) and (2) indicating possible cursor positions for the
863 insertion. When at (1), the tree will be pasted as level 2.
864 When at (2), it will be pasted as level 1.
866 If you do not want =C-y= to behave like this, configure the
867 variable =org-yank-adjusted-subtrees=.
869 Thanks to Samuel Wales for this idea and a partial implementation.
871 *** State changes can now be shown in the log mode in the agenda
873 If you configure the variable =org-agenda-log-mode-items=,
874 you can now request that all logged state changes be included
875 in the agenda when log mode is active. If you find this too
876 much for normal applications, you can also temporarily
877 request the inclusion of state changes by pressing =C-u l= in
880 This was a request by Hsiu-Khuern Tang.
882 You can also press `C-u C-u l' to get *only* log items in the
883 agenda, withour any timestamps/deadlines etc.
885 *** Footnote in HTML export are now collected at the end of the document
886 Previously, footnotes would be left in the document where
887 they are defined, now they are all collected and put into a
888 special =<div>= at the end of the document.
890 Thanks to Sebastian Rose for this request.
892 *** HTML export now validates again as XHTML.
894 Thanks to Sebastian Rose for pushing this cleanup.
896 *** The clock can now be resumed after exiting and re-starting Emacs
898 If the option =org-clock-in-resume= is t, and the first clock
899 line in an entry is unclosed, clocking into that task resumes
900 the clock from that time.
902 Thanks to James TD Smith for a patch to this effect.
904 *** Clock-related data can be saved and resumed across Emacs sessions
906 The data saved include the contents of =org-clock-history=,
907 and the running clock, if there is one.
909 To use this, you will need to add to your .emacs
911 #+begin_src emacs-lisp
912 (setq org-clock-persist t)
913 (setq org-clock-in-resume t)
914 (org-clock-persistence-insinuate)
917 Thanks to James TD Smith for a patch to this effect.
919 *** Following file links can now use C-u C-u to force use of an external app.
921 So far you could only bypass your setup in `org-file-apps'
922 and force opening a file link in Emacs by using a =C-u= prefix arg
923 with =C-c C-o=. Now you can call =C-u C-u C-c C-o= to force
924 an external application. Which external application depends
925 on your system. On Mac OS X and Windows, =open= is used. On
926 a GNU/Linux system, the mailcap settings are used.
928 This was a proposal by Samuel Wales.
930 *** Inserting absolute files names now abbreviates links with "~".
932 Inserting file links with =C-u C-c C-l= was buggy if the
933 setting of `org-link-file-path-type' was `adaptive' (the
934 default). Absolute file paths were not abbreviated relative
935 to the users home directory. This bug has been fixed.
937 Thanks to Matt Lundin for the report.
939 *** Links to attachment files
941 Even though one of the purposes of entry attachments was to
942 reduce the number of links in an entry, one might still want
943 to have the occasional link to one of those files. You can
944 now use link abbreviations to set up a special link type that
945 points to attachments in the current entry. Note that such
946 links will only work from within the same entry that has the
947 attachment, because the directory path is entry specific.
948 Here is the setup you need:
950 #+begin_src emacs-lisp
951 (setq org-link-abbrev-alist '(("att" . org-attach-expand-link)))
954 After this, a link like this will work
957 [[att:some-attached-file.txt]]
959 This was a proposal by Lindsay Todd.
961 *** Completed repeated tasks listed briefly in agenda
963 When a repeating task, listed in the daily/weekly agenda under
964 today's date, is completed from the agenda, it is listed as
965 DONE in the agenda until the next update happens. After the
966 next update, the task will have disappeared, of course,
967 because the new date is no longer today.
969 *** Remove buffers created during publishing are removed
971 Buffers that are created during publishing are now deleted
972 when the publishing is over. At least I hope it works like this.
978 - Secondary agenda filtering is becoming a killer feature
979 - Setting tags has now its own binding, =C-c C-q=
980 - Todo state changes can trigger tag changes
981 - C-RET will now always insert a new headline, never an item.
982 - Customize org-mouse.el feature set to free up mouse events
983 - New commands for export all the way to PDF (through LaTeX)
984 - Some bug fixed for LaTeX export, more bugs remain.
988 *** Enhancements to secondary agenda filtering
990 This is, I believe, becoming a killer feature. It allows you
991 to define fewer and more general custom agenda commands, and
992 then to do the final narrowing to specific tasks you are
993 looking for very quickly, much faster than calling a new
996 If you have not tries this yet, you should!
998 **** You can now refining the current filter by an additional criterion
999 When filtering an existing agenda view with =/=, you can
1000 now narrow down the existing selection by an additional
1001 condition. Do do this, use =\= instead of =/= to add the
1002 additional criterion. You can also press =+= or =-= after
1003 =/= to add a positive or negative condition. A condition
1004 can be a TAG, or an effort estimate limit, see below.
1006 **** It is now possible to filter for effort estimates
1007 This means to filter the agenda for the value of the Effort
1008 property. For this you should best set up global allowed
1009 values for effort estimates, with
1011 #+begin_src emacs-lisp
1012 (setq org-global-properties
1013 '(("Effort_ALL" . "0 0:10 0:30 1:00 2:00 3:00 4:00")))
1016 You may then select effort limits with single keys in the
1017 filter. It works like this: After =/= or =\=, first select
1018 the operator which you want to use to compare effort
1021 : < Select entries with effort smaller than or equal to the limit
1022 : > Select entries with effort larger than or equal to the limit
1023 : = Select entries with effort equal to the limit
1025 After that, you can press a single digit number which is
1026 used as an index to the allowed effort estimates.
1028 If you do not use digits to fast-select tags, you can even
1029 skip the operator, which will then default to
1030 `org-agenda-filter-effort-default-operator', which is by
1033 Thanks to Manish for the great idea to include fast effort
1034 filtering into the agenda filtering process.
1036 **** The mode line will show the active filter
1037 For example, if there is a filter in place that does select
1038 for HOME tags, against EMAIL tags, and for tasks with an
1039 estimated effort smaller than 30 minutes, the mode-line with
1040 show =+HOME-EMAIL+<0:30=
1042 **** The filter now persists when the agenda view is refreshed
1043 All normal refresh commands, including those that move the
1044 weekly agenda from one week to the next, now keep the
1045 current filter in place.
1047 You need to press =/ /= to turn off the filter. However,
1048 when you run a new agenda command, for example going from
1049 the weekly agenda to the TODO list, the filter will be
1052 *** Setting tags has now its own binding, =C-c C-q=
1054 You can still use =C-c C-c= on a headline, but the new
1055 binding should be considered as the main binding for this
1056 command. The reasons for this change are:
1058 - Using =C-c C-c= for tags is really out of line with other
1061 - I hate it in Remember buffers when I try to set tags and I
1062 cannot, because =C-c C-c= exits the buffer :-(
1064 - =C-c C-q= will also work when the cursor is somewhere down
1065 in the entry, it does not have to be on the headline.
1067 *** Todo state changes can trigger tag changes
1069 The new option =org-todo-state-tags-triggers= can be used to
1070 define automatic changes to tags when a TODO state changes.
1071 For example, the setting
1073 : (setq org-todo-state-tags-triggers
1074 : '((done ("Today" . nil) ("NEXT" . nil))
1075 : ("WAITING" ("Today" . t))))
1077 will make sure that any change to any of the DONE states will
1078 remove tags "Today" and "NEXT", while switching to the
1079 "WAITING" state will trigger the tag "Today" to be added.
1081 I use this mostly to get rid of TODAY and NEXT tags which I
1082 apply to select an entry for execution in the near future,
1083 which I often prefer to specific time scheduling.
1085 *** C-RET will now always insert a new headline, never an item.
1086 The new headline is inserted after the current subtree.
1088 Thanks to Peter Jones for patches to fine-tune this behavior.
1090 *** Customize org-mouse.el feature set
1091 There is a new variable =org-mouse-features= which gives you
1092 some control about what features of org-mouse you want to
1093 use. Turning off some of the feature will free up the
1094 corresponding mouse events, or will avoid activating special
1095 regions for mouse clicks. By default I have urned off the
1096 feature to use drag mouse events to move or promote/demote
1097 entries. You can of course turn them back on if you wish.
1099 This variable may still change in the future, allowing more
1100 fine-grained control.
1102 *** New commands for export to PDF
1104 This is using LaTeX export, and then processes it to PDF
1107 : C-c C-e p process to PDF.
1108 : C-c C-e d process to PDF, and open the file.
1111 - \usepackage{graphicx} is now part of the standard class
1113 - Several bugs fixed, but definitely not all of them :-(
1115 *** New option `org-log-state-notes-insert-after-drawers'
1117 Set this to =t= if you want state change notes to be inserted
1118 after any initial drawers, i.e drawers the immediately follow
1119 the headline and the planning line (the one with
1120 DEADLINE/SCHEDULED/CLOSED information).
1124 *** =org-file-apps= now uses regular expressions, see [[*%20org%20file%20apps%20now%20uses%20regular%20repressions%20instead%20of%20extensions][below]]
1128 *** =org-file-apps= now uses regular repressions instead of extensions
1129 Just like in =auto-mode-alist=, car's in the variable
1130 =org-file-apps= that are strings are now interpreted as
1131 regular expressions that are matched against a file name. So
1132 instead of "txt", you should now write "\\.txt\\'" to make
1133 sure the matching is done correctly (even though "txt" will
1134 be recognized and still be interpreted as an extension).
1136 There is now a shortcut to get many file types visited by
1137 Emacs. If org-file-apps contains `(auto-mode . emacs)', then
1138 any files that are matched by `auto-mode-alist' will be
1141 *** Changes to the attachment system
1143 - The default method to attach a file is now to copy it
1144 instead of moving it.
1145 - You can modify the default method using the variable
1146 `org-attach-method'. I believe that most Unix people want
1147 to set it to `ln' to create hard links.
1148 - The keys =c=, =m=, and =l= specifically select =copy=,
1149 =move=, or =link=, respectively, as the attachment method
1150 for a file, overruling `org-attach-method'.
1151 - To create a new attachment as an Emacs buffer, you have not
1152 now use =n= instead of =c=.
1153 - The file list is now always retrieved from the directory
1154 itself, not from the "Attachments" property. We still
1155 keep this property by default, but you can turn it off, by
1156 customizing the variable =org-attach-file-list-property=.
1160 ** Incompatible changes
1162 - Changes in the structure of IDs, see [[*The%20default%20structure%20of%20IDs%20has%20changed][here]] for details.
1164 - C-c C-a has been redefined, see [[*%20C%20c%20C%20a%20no%20longer%20calls%20show%20all][here]] for details.
1168 *** The default structure of IDs has changed
1170 IDs created by Org have changed a bit:
1171 - By default, there is no prefix on the ID. There used to be
1172 an "Org" prefix, but I now think this is not necessary.
1173 - IDs use only lower-case letters, no upper-case letters
1174 anymore. The reason for this is that IDs are now also used
1175 as directory names for org-attach, and some systems do not
1176 distinguish upper and lower case in the file system.
1177 - The ID string derived from the current time is now
1178 /reversed/ to become an ID. This assures that the first
1179 two letters of the ID change fast, so hat it makes sense to
1180 split them off to create subdirectories to balance load.
1181 - You can now set the `org-id-method' to `uuidgen' on systems
1184 *** =C-c C-a= no longer calls `show-all'
1186 The reason for this is that =C-c C-a= is now used for the
1187 attachment system. On the rare occasions that this command
1188 is needed, use =M-x show-all=, or =C-u C-u C-u TAB=.
1190 *** New attachment system
1192 You can now attach files to each node in the outline tree.
1193 This works by creating special directories based on the ID of
1194 an entry, and storing files in these directories. Org can
1195 keep track of changes to the attachments by automatically
1196 committing changes to git. See the manual for more
1199 Thanks to John Wiegley who contributed this fantastic new
1200 concept and wrote org-attach.el to implement it.
1202 *** New remember template escapes
1204 : %^{prop}p to insert a property
1205 : %k the heading of the item currently being clocked
1206 : %K a link to the heading of the item currently being clocked
1208 Also, when you exit remember with =C-2 C-c C-c=, the item
1209 will be filed as a child of the item currently being
1210 clocked. So the idea is, if you are working on something and
1211 think of a new task related to this or a new note to be
1212 added, you can use this to quickly add information to that
1215 Thanks to James TD Smith for a patch to this effect.
1217 *** Clicking with mouse-2 on clock info in mode-line visits the clock.
1219 Thanks to James TD Smith for a patch to this effect.
1221 *** New file in contrib: lisp/org-checklist.el
1223 This module deals with repeated tasks that have checkbox
1226 Thanks to James TD Smith for this contribution.
1228 *** New in-buffer setting #+STYLE
1230 It can be used to locally set the variable
1231 `org-export-html-style-extra'. Several such lines are
1232 allowed-, they will all be concatenated. For an example on
1233 how to use it, see the [[http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php][publishing tutorial]].
1239 - Filtering existing agenda views with respect to a tag
1240 - Editing fixed-width regions with picture or artist mode
1241 - /org-plot.el/ is now part of Org
1242 - Tags can be used to select the export part of a document
1243 - Prefix interpretation when storing remember notes
1244 - Yanking inserts folded subtrees
1245 - Column view capture tables can have formulas, plotting info
1246 - In column view, date stamps can be changed with S-cursor keys
1247 - The note buffer for clocking out now mentions the task
1248 - Sorting entries alphabetically ignores TODO keyword and priority
1249 - Agenda views can sort entries by TODO state
1250 - New face =org-scheduled= for entries scheduled in the future.
1251 - Remember templates for gnus links can use the :to escape.
1252 - The file specification in a remember template may be a function
1253 - Categories in iCalendar export include local tags
1254 - It is possible to define filters for column view
1255 - Disabling integer increment during table Field copy
1256 - Capturing column view is on `C-c C-x i'
1257 - And tons of bugs fixed.
1260 ** Incompatible changes
1262 *** Prefix interpretation when storing remember notes has changed
1264 The prefix argument to the `C-c C-c' command that finishes a
1265 remember process is now interpreted differently:
1267 : C-c C-c Store the note to predefined file and headline
1268 : C-u C-c C-c Like C-c C-c, but immediately visit the note
1269 : in its new location.
1270 : C-1 C-c C-c Select the storage location interactively
1271 : C-0 C-c C-c Re-use the last used location
1273 This was requested by John Wiegley.
1275 *** Capturing column view is now on `C-c C-x i'
1277 The reason for this change was that `C-c C-x r' is also used
1278 as a tty key replacement.
1280 *** Categories in iCalendar export now include local tags
1282 The locally defined tags are now listed as categories when
1283 exporting to iCalendar format. Org's traditional file/tree
1284 category is now the last category in this list. Configure
1285 the variable =org-icalendar-categories= to modify or revert
1288 This was a request by Charles Philip Chan.
1292 *** Secondary filtering of agenda views.
1294 You can now easily and interactively filter an existing
1295 agenda view with respect to a tag. This command is executed
1296 with the =/= key in the agenda. You will be prompted for a
1297 tag selection key, and all entries that do not contain or
1298 inherit the corresponding tag will be hidden. With a prefix
1299 argument, the opposite filter is applied: entries that
1300 do have the tag will be hidden.
1302 This operation only /hides/ lines in the agenda buffer, it
1303 does not remove them. Changing the secondary filtering does
1304 not require a new search and is very fast.
1306 If you press TAB at the tag selection prompt, you will be
1307 switched to a completion interface to select a tag. This is
1308 useful when you want to select a tag that does not have a
1309 direct access character.
1311 A double =/ /= will restore the original agenda view by
1312 unhiding any hidden lines.
1314 This functionality was John Wiegley's idea. It is a simpler
1315 implementation of some of the query-editing features proposed
1316 and implemented some time ago by Christopher League (see the
1317 file contrib/lisp/org-interactive-query.el).
1319 *** Editing fixed-width regions with picture or artist mode
1321 The command @<code>C-c '@</code> (that is =C-c= followed by a
1322 single quote) can now also be used to switch to a special
1323 editing mode for fixed-width sections. The default mode is
1324 =artist-mode= which allows you to create ASCII drawings.
1326 It works like this: Enter the editing mode with
1327 @<code>C-c '@</code>. An indirect buffer will be created and
1328 narrowed to the fixed-width region. Edit the drawing, and
1329 press @<code>C-c '@</code> again to exit.
1331 Lines in a fixed-width region should be preceded by a colon
1332 followed by at least one space. These will be removed during
1333 editing, and then added back when you exit the editing mode.
1335 Using the command in an empty line will create a new
1338 This new feature arose from a discussion involving Scott
1339 Otterson, Sebastian Rose and Will Henney.
1341 *** /org-plot.el/ is now part of Org.
1343 You can run it by simple calling org-plot/gnuplot.
1344 Documentation is not yet included with Org, please refer to
1345 http://github.com/eschulte/org-plot/tree/master until we have
1346 moved the docs into Org or Worg.
1348 Thanks to Eric Schulte for this great contribution.
1350 *** Tags can be used to select the export part of a document
1352 You may now use tags to select parts of a document for
1353 inclusion into the export, and to exclude other parts. This
1354 behavior is governed by two new variables:
1355 =org-export-select-tags= and =org-export-exclude-tags=.
1356 These default to =("export")= and =("noexport")=, but can be
1357 changed, even to include a list of several tags.
1359 Org first checks if any of the /select/ tags is present in
1360 the buffer. If yes, all trees that do not carry one of these
1361 tags will be excluded. If a selected tree is a subtree, the
1362 heading hierarchy above it will also be selected for export,
1363 but not the text below those headings. If none of the select
1364 tags is found anywhere in the buffer, the whole buffer will
1365 be selected for export. Finally, all subtrees that are
1366 marked by any of the /exclude/ tags will be removed from the
1369 You may set these tags with in-buffer options
1370 =EXPORT_SELECT_TAGS= and =EXPORT_EXCLUDE_TAGS=.
1372 I love this feature. Thanks to Richard G Riley for coming
1375 *** Prefix interpretation when storing remember notes
1377 The prefix argument to the `C-c C-c' command that finishes a
1378 remember process is now interpreted differently:
1380 : C-c C-c Store the note to predefined file and headline
1381 : C-u C-c C-c Like C-c C-c, but immediately visit the note
1382 : in its new location.
1383 : C-1 C-c C-c Select the storage location interactively
1384 : C-0 C-c C-c Re-use the last used location
1386 This was requested by John Wiegley.
1388 *** Yanking inserts folded subtrees
1390 If the kill is a subtree or a sequence of subtrees, yanking
1391 them with =C-y= will leave all the subtrees in a folded
1392 state. This basically means, that kill and yank are now
1393 much more useful in moving stuff around in your outline. If
1394 you do not like this, customize the variable
1395 =org-yank-folded-subtrees=.
1397 Right now, I am only binding =C-y= to this new function,
1398 should I modify all bindings of yank? Do we need to amend
1401 This feature was requested by John Wiegley.
1403 *** Column view capture tables can have formulas, plotting info
1405 If you attach formulas and plotting instructions to a table
1406 capturing column view, these extra lines will now survive an
1407 update of the column view capture, and any formulas will be
1408 re-applied to the captured table. This works by keeping any
1409 continuous block of comments before and after the actual
1412 *** In column view, date stamps can be changed with S-cursor keys
1414 If a property value is a time stamp, S-left and S-right can
1415 now be used to shift this date around while in column view.
1417 This was a request by Chris Randle.
1419 *** The note buffer for clocking out now mentions the task
1421 This was a request by Peter Frings.
1423 *** Sorting entries alphabetically ignores TODO keyword and priority
1425 Numerical and alphanumerical sorting now skips any TODO
1426 keyword or priority cookie when constructing the comparison
1427 string. This was a request by Wanrong Lin.
1429 *** Agenda views can sort entries by TODO state
1431 You can now define a sorting strategy for agenda entries that
1432 does look at the TODO state of the entries. Sorting by TODO
1433 entry does first separate the non-done from the done states.
1434 Within each class, the entries are sorted not alphabetically,
1435 but in definition order. So if you have a sequence of TODO
1436 entries defined, the entries will be sorted according to the
1437 position of the keyword in this sequence.
1439 This follows an idea and sample implementation by Christian
1442 *** New face =org-scheduled= for entries scheduled in the future.
1444 This was a request by Richard G Riley.
1446 *** Remember templates for gnus links can now use the :to escape.
1448 Thanks to Tommy Lindgren for a patch to this effect.
1449 *** The file specification in a remember template may now be a function
1451 Thanks to Gregory Sullivan for a patch to this effect.
1453 *** Categories in iCalendar export now include local tags
1455 The locally defined tags are now listed as categories when
1456 exporting to iCalendar format. Org's traditional file/tree
1457 category is now the last category in this list. Configure
1458 the variable =org-icalendar-categories= to modify or revert
1461 This was a request by Charles Philip Chan.
1463 *** It is now possible to define filters for column view
1465 The filter can modify the value that will be displayed in a
1466 column, for example it can cut out a part of a time stamp.
1467 For more information, look at the variable
1468 =org-columns-modify-value-for-display-function=.
1470 *** Disabling integer increment during table field copy
1472 Prefix arg 0 to S-RET does the trick.
1474 This was a request by Chris Randle.
1479 For older Changes, see [[file:Changes_old.org]]