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.18 (in preparation)
18 ** Incompatible changes
20 *** Short examples must have a space after the colon
22 Short literal examples can be created by preceeding 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.
29 *** Examples can be exported to HTML as text areas
31 You can now specify a =-t= switch to an example or src block,
32 to make it export to HTML as a text area. To change the
33 defaults for height (number of lines in the example) and
34 width of this area (80), use the =-h= and =-w= switches.
36 Thanks to Ulf Stegemann for driving this development.
38 *** The attachment directory may now be chosen by the user
40 Instead of using the automatic, unique directory related to
41 the entry ID, you can also use a chosen directory for the
42 attachments of an entry. This directory is specified by the
43 ATTACH_DIR property. You can use `C-c C-a s' to set this
46 *** You can use a single attachment directory for a subtree
48 By setting the property ATTACH_DIR_INHERIT, you can now tell
49 Org that children of the entry should use the same directory
50 for attachments, unless a child explicitly defines its own
51 directory with the ATTACH_DIR property. You can use the
52 command `C-c C-a i' to set this property in an entry.
54 *** Better handling of inlined images in different backends
56 Two new variables govern which kind of files can be inlined
57 during export. These are
58 =org-export-html-inline-image-extensions= and
59 =org-export-latex-inline-image-extensions=. Remember that
60 links are turned into an inline image if they are a pure link
61 with no description. HTML files can inline /.png/, /.jpg/,
62 and /.gif/ files, while LaTeX files, when processed with
63 /pdflatex/, can inline /.png/, /.jpg/, and /.pdf/ files.
64 These also represent the default settings for the new
65 variables. Note that this means that pure links to /.pdf/
66 files will be inlined - to avoid this for a particular link,
67 make sure that the link has a description part which is not
68 equal to the link part.
70 *** The relative timer can be paused
72 The new command `C-c C-x ,' will pause the relative timer.
73 When the relative timer is running, its value will be shown
74 in the mode line. To get rid of this display, you need to
75 really stop the timer with `C-u C-c C-x ,'.
77 Thanks to Alan Davis for driving this change.
79 *** Include files can now also process switches
81 The example and src switches like =-n= can now also be added
82 to inlcude file statements:
84 : #+INCLUDE "~/.emacs" src emacs-lisp -n -r
86 Thanks to Manish for pointing out that this was not yet
89 *** Links by ID now continue to work in HTML exported files
91 If you make links by ID, these links will now still work in
92 HTML exported files, provided that you keep the relative path
93 from link to target file the same.
95 Thanks to Friedrich Delgado Friedrichs for pushing this over
103 - Line numbers and references in literal examples
104 - New hooks for export preprocessing
105 - Capture column view into a different file
111 Org-mode now directly supports the creation of footnotes. In
112 contrast to the /footnote.el/ package, Org-mode's footnotes are
113 designed for work on a larger document, not only for one-off
114 documents like emails. The basic syntax is similar to the one
115 used by /footnote.el/, i.e. a footnote is defined in a paragraph
116 that is started by a footnote marker in square brackets in column
117 0, no indentation allowed. The footnote reference is simply the
118 marker in square brackets inside text. For example:
121 The Org homepage[fn:1] now looks a lot better than it used to.
123 [fn:1] The link is: http://orgmode.org
126 Org-mode extends the number-based syntax to /named/ footnotes and
127 optional inline definition. Using plain numbers as markers is
128 supported for backward compatibility, but not encouraged because
129 of possible conflicts with LaTeX syntax. Here are the valid
132 - [1] :: A plain numeric footnote marker.
134 - [fn:name] :: A named footnote reference, where `name' is a
135 unique label word or, for simplicity of automatic creation,
138 - [fn:: This is the inline definition of this footnote] :: A
139 LaTeX-like anonymous footnote where the definition is given
140 directly at the reference point.
142 - [fn:name: a definition] :: An inline definition of a footnote,
143 which also specifies a name for the note. Since Org allows
144 multiple references to the same note, you can then use use
145 `[fn:name]' to create additional references.
147 Footnote labels can be created automatically, or you create names
148 yourself. This is handled by the variable
149 =org-footnote-auto-label= and its corresponding =#+STARTUP=
150 keywords, see the docstring of that variable for details.
152 The following command handles footnotes:
154 - C-c C-x f :: The footnote action command. When the cursor is
155 on a footnote reference, jump to the definition. When it is
156 at a definition, jump to the (first) reference. Otherwise,
157 create a new footnote. Depending on the variable
158 `org-footnote-define-inline' (with associated =#+STARTUP=
159 options =fninline= and =nofninline=), the definitions will
160 be placed right into the text as part of the reference, or
161 separately into the location determined by the variable
162 =org-footnote-section=.
163 When this command is called with a prefix argument, a menu
164 of additional options is offered:
165 - s :: Sort the footnote definitions by reference sequence.
166 During editing, Org makes no effort to sort footnote
167 definitions into a particular sequence. If you want
168 them sorted, use this command, which will also move
169 entries according to =org-footnote-section=.
170 - n :: Normalize the footnotes by collecting all
171 definitions (including inline definitions) into a
172 special section, and then numbering them in
173 sequence. The references will then also be
174 numbers. This is meant to be the final step before
175 finishing a document (e.g. sending off an email).
176 The exporters do this automatically, and so could
177 something like `message-send-hook'.
178 - d :: Delete the footnote at point, and all references to it.
180 - C-c C-c :: If the cursor is on a footnote reference, jump to
181 the definition. If it is a the definition, jump back to the
182 reference. When called with a prefix argument at either
183 location, offer the same menu as `C-u C-c C-x f'.
185 - C-c C-o or mouse-1/2 :: Footnote labels are also links to the
186 corresponding definition/reference, and you can use the
187 usual commands to follow these links.
189 Org-mode's footnote support is designed so that it should also
190 work in buffers that are not in Org-mode, for example in email
191 messages. Just bind =org-footnote-action= to a global key like
194 The main trigger for this development came from a hook function
195 written by Paul Rivier, to implement named footnotes and to
196 convert them to numbered ones before export. Thanks, Paul!
198 Thanks also to Scot Becker for a thoughtful post bringing this
199 subject back onto the discussion table, and to Matt Lundin for
200 the idea of named footnotes and his prompt testing of the new
203 *** Line numbers and references in literal examples
205 Literal examples introduced with =#+BEGIN_EXAMPLE= or =#+BEGIN_SRC=
206 do now allow optional line numbering in the example.
207 Furthermore, links to specific code lines are supported, greatly
208 increasing Org-mode's utility for writing tutorials and other
211 Code references use special labels embedded directly into the
212 source code. Such labels look like "(ref:name)" and must be
213 unique within a document. Org-mode links with "(name)" in the
214 link part will be correctly interpreted, both while working with
215 an Org file (internal links), and while exporting to the
216 different backends. Line numbering and code references are
217 supported for all three major backends, HTML, LaTeX, and ASCII.
218 In the HTML backend, hovering the mouse over a link to a source
219 line will remote-highlight the referenced code line.
221 The options for the BEGIN lines are:
223 - -n :: Number the lines in the example
224 - +n :: Like -n, but continue numbering from where the previous
226 - -r :: Remove the coderef cookies from the example, and replace
227 links to this reference with line numbers. This option
228 takes only effect if either -n or +n are given as well.
229 If -r is not given, coderefs simply use the label name.
230 - -l "fmt" :: Define a local format for coderef labels, see the
231 variable =org-coderef-label-format= for details. Use this
232 of the default syntax causes conflicts with the code in the
233 code snippet you are using.
238 #+begin_src emacs-lisp -n -r
239 (defmacro org-unmodified (&rest body) (ref:def)
240 "Execute body without changing `buffer-modified-p'."
241 `(set-buffer-modified-p (ref:back)
242 (prog1 (buffer-modified-p) ,@body)))
244 [[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
248 When exported, this is translated to:
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)]],
258 Thanks to Ilya Shlyakhter for proposing this feature set. Thanks
259 to Sebastian Rose for the key Javascript element that made the
260 remote highlighting possible.
262 *** New hooks for export preprocessing
263 The export preprocessor now runs more hooks, to allow
264 better-timed tweaking by user functions:
266 - =org-export-preprocess-hook= ::
267 Pretty much the first thing in the preprocessor. But org-mode
268 is already active in the preprocessing buffer.
270 - =org-export-preprocess-after-include-files-hook= ::
271 This is run after the contents of included files have been inserted.
273 - =org-export-preprocess-after-tree-selection-hook= ::
274 This is run after selection of trees to be exported has
275 happened. This selection includes tags-based selection, as
276 well as removal of commented and archived trees.
278 - =org-export-preprocess-before-backend-specifics-hook= ::
279 Hook run before backend-specific functions are called during preprocessing.
281 - =org-export-preprocess-final-hook= ::
282 Hook for preprocessing an export buffer. This is run as the
283 last thing in the preprocessing buffer, just before returning
284 the buffer string to the backend.
286 *** Capture column view into a different file
288 The :id parameter for the dynamic block capturing column view
289 can now truly be an ID that will also be found in a
290 different file. Also, it can be like =file:path/to/file=, to
291 capture the global column view from a different file.
293 Thanks to Francois Lagarde for his report that IDs outside
294 the current file would not work.
297 Cleanup of many small bugs, and one new feature.
301 *** References to last table row with special names
303 Fields in the last row of a table can now be referenced with
304 $LR1, $LR2, etc. These references can appear both on the
305 left hand side and right hand side of a formula.
309 This version reverses the introduction of @0 as a reference to
310 the last rwo in a table, because of a conflict with the use of
311 @0 for the current row.
316 - All known LaTeX export issues fixed
317 - Captions and attributes for figures and tables.
318 - Better implementation for entry IDs
319 - Spreadsheet references to the last table line.
320 - Old syntax for link attributes abandoned
322 ** Incompatible changes
323 *** Old syntax for link attributes abandoned
325 There used to be a syntax for setting link attributes for
326 HTML export by enclosing the attributes into double braces
327 and adding them to the link itself, like
330 [[./img/a.jpg{{alt="an image"}}] ]
333 This syntax is not longer supported, use instead
336 ,#+ATTR_HTML: alt="an image"
342 *** All known LaTeX export issues fixed
344 All the remaining issues with the LaTeX exporter have hopefully
345 been addressed in this release. In particular, this covers
346 quoting of special characters in tables and problems with
347 exporting files where the headline is in the first line, or with
350 *** Captions and attributes for figures and tables.
352 Tables, and Hyperlinks that represent inlined images, can now be
353 equipped with additional information that will be used during
354 export. The information will be taken from the following special
355 lines in the buffer and apply to the first following table or
358 - #+CAPTION: :: The caption of the image or table. This string
359 should be processed according to the export backend, but
360 this is not yet done.
362 - #+LABEL: :: A label to identify the figure/table for cross
363 references. For HTML export, this string will become the
364 ID for the ~<div class="figure">~ element that encapsulates
365 the image tag and the caption. For LaTeX export, this
366 string will be used as the argument of a ~\label{...}~
367 macro. These labels will be available for internal links
368 like ~[[label][Table] ]~.
370 - #+ATTR_HTML: :: Attributes for HTML export of image, to be
371 added as attributes into the ~<img...>~ tag. This string
372 will not be processed, so it should have immediately the
375 - #+ATTR_LaTeX: :: Attributes for LaTeX export of images and
377 For /images/, this string is directly inserted into
378 the optional argument of the ~\includegraphics[...]{file}~
379 command, to specify scaling, clipping and other options.
380 This string will not be processed, so it should have
381 immediately the right format, like =width=5cm,angle=90=.\\
382 For /tables/, this can currently contain the keyword
383 =longtable=, to request typesetting of the table using the
384 longtable package, which automatically distributes the table
385 over several pages if needed. Also, the attributes line may
386 contain an alignment string for the tabular environment, like
387 =longtable,align=l|lrl=
389 For LaTeX export, if either a caption or a label is given, the element
390 will be exported as a float, i.e. wrapped into a figure or table
393 *** Better implementation for entry IDs
395 Unique identifiers for entries can now be used more efficiently.
396 Internally, a hash array has replaced the alist used so far to
397 keep track of the files in which an ID is defined. This makes it
398 quite fast to find an entry by ID.
400 There is a new link type which looks like this:
403 id:GLOBALLY-UNIQUE-IDENTIFIER
406 This link points to a specific entry. When you move the entry to
407 a different file, for example if you move it to an archive
408 file, the link will continue to work.
410 The file /org-id.el/ contains an API that can be used to write
411 code using these identifiers, including creating IDs and finding
412 them wherever they are.
414 Org has its own method to create unique identifiers, but if the system
415 has /uuidgen/ command installed (Mac's and Linux systems generally
416 do), it will be used by default (a change compared to the earlier
417 implmentation, where you explicitdly had to opt for uuidgen). You can
418 also select the method by hand, using the variable =org-id-method=.
420 If the ID system ever gets confused about where a certain ID is, it
421 initiates a global scan of all agenda files with associated archives,
422 all files previously known containing any IDs, and all currently
423 visited Org-mode files to rebuild the hash. You can also initiate
424 this by hand: =M-x org-id-update-id-locations=. Running this command
425 will also dump into the =*Messages*= buffer information about any
426 duplicate IDs. These should not exist, and Org will never /make/ the
427 same ID twice, but if you /copy/ an entry with its properties,
428 duplicate IDs will inevitably be produced. Unfortunately, this is
429 unavoidable in a plain text system that allows you to edit the text in
430 arbitrary ways, and a portion of care on your side is needed to keep
433 The hash is stored in the file =~/.emacs.d/.org-id-locations=.
434 This is also a change from previous versions where the file was
435 =~/.org=id-locations=. Therefore, you can remove this old file
436 if you have it. I am not sure what will happen if the =.emacs.d=
437 directory does not exists in your setup, but in modern Emacsen, I
438 believe it should exist. If you do not want to use IDs across
439 files, you can avoid the overhead with tracking IDs by
440 customizing the variable =org-id-track-globally=. IDs can then
441 still be used for links inside a single file.
443 IDs will also be used when you create a new link to an Org-mode
444 buffer. If you use =org-store-link= (normally at =C-c l=) inside
445 en entry in an Org-mode buffer, and ID property will be created
446 if it does not exist, and the stored link will be an =id:= link.
447 If you prefer the much less secure linking to headline text, you
448 can configure the variable =org-link-to-org-use-id=. The default
449 setting for this variable is =create-if-interactive=, meaning
450 that an ID will be created when you store a link interactively,
451 but not if you happen to be in an Org-mode file while you create
452 a remember note (which usually has a link to the place where you
453 were when starting remember).
455 *** Spreadsheet references to the last table line.
457 You may now use =@0= to reference the last dataline in a table
458 in a stable way. This is useful in particular for automatically
459 generated tables like the ones using /org-collector.el/ by Eric
465 - New relative timer to support timed notes
466 - Special faces can be set for individual tags
467 - The agenda shows now all tags, including inherited ones.
468 - Exclude some tags from inheritance.
469 - More special values for time comparisons in property searches
470 - Control for exporting meta data
471 - Cut and Paste with hot links from w3m to Org
472 - LOCATION can be inherited for iCalendar export
473 - Relative row references crossing hlines now throw an error
475 ** Incompatible Changes
477 *** Relative row references crossing hlines now throw an error
479 Relative row references in tables look like this: "@-4" which
480 means the forth row above this one. These row references are
481 not allowed to cross horizontal separator lines (hlines). So
482 far, when a row reference violates this policy, Org would
483 silently choose the field just next to the hline.
485 Tassilo Horn pointed out that this kind of hidden magic is
486 actually confusing and may cause incorrect formulas, and I do
487 agree. Therefore, trying to cross a hline with a relative
488 reference will now throw an error.
490 If you need the old behavior, customize the variable
491 `org-table-error-on-row-ref-crossing-hline'.
495 *** New relative timer to support timed notes
497 Org now supports taking timed notes, useful for example while
498 watching a video, or during a meeting which is also recorded.
501 Insert a relative time into the buffer. The first time
502 you use this, the timer will be started. When called
503 with a prefix argument, the timer is reset to 0.
506 Insert a description list item with the current relative
507 time. With a prefix argument, first reset the timer to 0.
510 Once the time list has been initiated, you can also use the
511 normal item-creating command to insert the next timer item.
514 Reset the timer without inserting anything into the buffer.
515 By default, the timer is reset to 0. When called with a
516 =C-u= prefix, reset the timer to specific starting
517 offset. The user is prompted for the offset, with a
518 default taken from a timer string at point, if any, So this
519 can be used to restart taking notes after a break in the
520 process. When called with a double prefix argument
521 =C-c C-u=, change all timer strings in the active
522 region by a certain amount. This can be used to fix timer
523 strings if the timer was not started at exactly the right
526 Thanks to Alan Dove, Adam Spiers, and Alan Davis for
527 contributions to this idea.
529 *** Special faces can be set for individual tags
531 You may now use the variable =org-tag-faces= to define the
532 face used for specific tags, much in the same way as you can
533 do for TODO keywords.
535 Thanks to Samuel Wales for this proposal.
537 *** The agenda shows now all tags, including inherited ones.
539 This request has come up often, most recently it was
540 formulated by Tassilo Horn.
542 If you prefer the old behavior of only showing the local
543 tags, customize the variable =org-agenda-show-inherited-tags=.
545 *** Exclude some tags from inheritance.
547 So far, the only way to select tags for inheritance was to
548 allow it for all tags, or to do a positive selection using
549 one of the more complex settings for
550 `org-use-tag-inheritance'. It may actually be better to
551 allow inheritance for all but a few tags, which was difficult
552 to achieve with this methodology.
554 A new option, `org-tags-exclude-from-inheritance', allows to
555 specify an exclusion list for inherited tags.
557 *** More special values for time comparisons in property searches
559 In addition to =<now>=, =<today>=, =<yesterday>=, and
560 =<tomorrow>=, there are more special values accepted now in
561 time comparisons in property searches: You may use strings
562 like =<+3d>= or =<-2w>=, with units d, w, m, and y for day,
563 week, month, and year, respectively
565 Thanks to Linday Todd for this proposal.
567 *** Control for exporting meta data
569 All the metadata in a headline, i.e. the TODO keyword, the
570 priority cookie, and the tags, can now be excluded from
571 export with appropriate options:
573 | Variable | Publishing property | OPTIONS switch |
574 |-------------------------------+---------------------+----------------|
575 | org-export-with-todo-keywords | :todo-keywords | todo: |
576 | org-export-with-tags | :tags | tags: |
577 | org-export-with-priority | :priority | pri: |
579 *** Cut and Paste with hot links from w3m to Org
581 You can now use the key =C-c C-x M-w= in a w3m buffer with
582 HTML content to copy either the region or the entire file in
583 a special way. When you yank this text back into an Org-mode
584 buffer, all links from the w3m buffer will continue to work
587 For this to work you need to load the new file /org-w3m.el./
588 Please check your org-modules variable to make sure that this
591 Thanks for Richard Riley for the idea and to Andy Stewart for
594 *** LOCATION can be inherited for iCalendar export
596 The LOCATION property can now be inherited during iCalendar
597 export if you configure =org-use-property-inheritance= like
600 #+begin_src emacs-lisp
601 (setq org-use-property-inheritance '("LOCATION"))
608 - Keybindings in Remember buffers can be configured
609 - Support for ido completion
610 - New face for date lines in agenda column view
611 - Invisible targets become now anchors in headlines.
612 - New contributed file /org-exp-blocks.el/
613 - New contributed file /org-eval-light.el/
615 - BBDB links may use regular expressions.
616 - Link abbreviations can use %h to insert a url-encoded target value
617 - Improved XHTML compliance
621 *** Keybindings in Remember buffers can be configured
623 The remember buffers created with Org's extensions are in
624 Org-mode, which is nice to prepare snippets that will
625 actually be stored in Org-mode files. However, this makes it
626 hard to configure key bindings without modifying the Org-mode
627 keymap. There is now a minor mode active in these buffers,
628 `org-remember-mode', and its keymap org-remember-mode-map can
629 be used for key bindings. By default, this map only contains
630 the bindings for =C-c C-c= to store the note, and =C-c C-k=
631 to abort it. Use `org-remember-mode-hook' to define your own
634 #+begin_src emacs-lisp
636 'org-remember-mode-hook
638 (define-key org-remember-mode-map
639 "\C-x\C-s" 'org-remember-finalize)))
642 If you wish, you can also use this to free the =C-c C-c=
643 binding (by binding this key to nil in the minor mode map),
644 so that you can use =C-c C-c= again to set tags.
646 This modification is based on a request by Tim O'Callaghan.
648 *** Support for ido completion
650 You can now get the completion interface from /ido.el/ for
651 many of Org's internal completion commands by turning on the
652 variable =org-completion-use-ido=. =ido-mode= must also be
653 active before you can use this.
655 This change is based upon a request by Samuel Wales.
657 *** New face for date lines in agenda column view
659 When column view is active in the agenda, and when you have
660 summarizing properties, the date lines become normal column
661 lines and the separation between different days becomes
662 harder to see. If this bothers you, you can now customize
663 the face =org-agenda-column-dateline=.
665 This is based on a request by George Pearson.
667 *** Invisible targets become now anchors in headlines.
669 These anchors can be used to jump to a directly with an HTML
670 link, just like the =sec-xxx= IDs. For example, the
671 following will make a http link
672 =//domain/path-to-my-file.html#dummy= work:
679 This is based on a request by Matt Lundin.
681 *** New contributed file /org-exp-blocks.el/
683 This new file implements special export behavior of
684 user-defined blocks. The currently supported blocks are
686 - comment :: Comment blocks with author-specific markup
687 - ditaa :: conversion of ASCII art into pretty png files
688 using Stathis Sideris' /ditaa.jar/ program
689 - dot :: creation of graphs in the /dot/ language
690 - R :: Sweave type exporting using the R program
692 For more details and examples, see the file commentary in
695 Kudos to Eric Schulte for this new functionality, after
696 /org-plot.el/ already his second major contribution. Thanks
697 to Stathis for this excellent program, and for allowing us to
698 bundle it with Org-mode.
700 *** New contributed file /org-eval-light.el/
702 This module gives control over execution Emacs Lisp code
703 blocks included in a file.
705 Thanks to Eric Schulte also for this file.
709 You can now configure Org to understand many links created
710 with the Emacs Planner package, so you can cut text from
711 planner pages and paste them into Org-mode files without
712 having to re-write the links. Among other things, this means
713 that the command =org-open-at-point-global= which follows
714 links not only in Org-mode, but in arbitrary files like
715 source code files etc, will work also with links created by
716 planner. The following customization is needed to make all of
719 #+begin_src emacs-lisp
720 (setq org-link-translation-function
721 'org-translate-link-from-planner)
724 I guess an inverse translator could be written and integrated
727 *** BBDB links may use regular expressions.
729 This did work all along, but only now I have documented it.
731 *** =yank-pop= works again after yanking an outline tree
733 Samuel Wales had noticed that =org-yank= did mess up this
734 functionality. Now you can use =yank-pop= again, the only
735 restriction is that the so-yanked text will not be
736 pro/demoted or folded.
738 *** Link abbreviations can use %h to insert a url-encoded target value
740 Thanks to Steve Purcell for a patch to this effect.
742 *** Improved XHTML compliance
744 Thanks to Sebastian Rose for pushing this.
746 *** Many bug fixes again.
751 - A region of entries can now be refiled with a single command
752 - Fine-tuning the behavior of `org-yank'
753 - Formulas for clocktables
754 - Better implementation of footnotes for HTML export
755 - More languages for HTML export.
759 *** A region of entries can now be refiled with a single command
761 With =transient-make-mode= active (=zmacs-regions= under
762 XEmacs), you can now select a region of entries and refile
763 them all with a single =C-c C-w= command.
765 Thanks to Samuel Wales for this useful proposal.
767 *** Fine-tuning the behavior of =org-yank=
769 The behavior of Org's yanking command has been further
770 fine-tuned in order to avoid some of the small annoyances
773 - Calling =org-yank= with a prefix arg will stop any special
774 treatment and directly pass through to the normal =yank=
775 command. Therefore, you can now force a normal yank with
778 - Subtrees will only be folded after a yank if doing so will
779 now swallow any non-white characters after the yanked text.
780 This is, I think a really important change to make the
781 command work more sanely.
783 *** Formulas for clocktables
785 You can now add formulas to a clock table, either by hand, or
786 with a =:formula= parameter. These formulas can be used to
787 create additional columns with further analysis of the
790 Thanks to Jurgen Defurne for triggering this addition.
792 *** Better implementation of footnotes for HTML export
794 The footnote export in 6.11 really was not good enough. Now
795 it works fine. If you have customized
796 =footnote-section-tag=, make sure that your customization is
797 matched by =footnote-section-tag-regexp=.
799 Thanks to Sebastian Rose for pushing this change.
801 *** More languages for HTML export.
803 More languages are supported during HTML export. This is
804 only relevant for the few special words Org inserts, like
805 "Table of Contents", or "Footnotes". Also the encoding
806 issues with this feature seem to be solved now.
808 Thanks to Sebastian Rose for pushing me to fix the encoding
815 - Yanking subtree with =C-y= now adjusts the tree level
816 - State changes can now be shown in the log mode in the agenda
817 - Footnote in HTML export are now collected at the end of the document
818 - HTML export now validates again as XHTML
819 - The clock can now be resumed after exiting and re-starting Emacs
820 - Clock-related data can be saved and resumed across Emacs sessions
821 - Following file links can now use C-u C-u to force use of an external app
822 - Inserting absolute files names now abbreviates links with "~"
823 - Links to attachment files
824 - Completed repeated tasks listed briefly in agenda
825 - Remove buffers created during publishing are removed
829 *** Yanking subtree with =C-y= now adjusts the tree level
830 When yanking a cut/copied subtree or a series of trees, the
831 normal yank key =C-y= now adjusts the level of the tree to
832 make it fit into the current outline position, without losing
833 its identity, and without swallowing other subtrees.
835 This uses the command =org-past-subtree=. An additional
836 change in that command has been implemented: Normally, this
837 command picks the right outline level from the surrounding
838 *visible* headlines, and uses the smaller one. So if the
839 cursor is between a level 4 and a level 3 headline, the tree
840 will be pasted as level 3. If the cursor is actually *at*
841 the beginning of a headline, the level of that headline will
842 be used. For example, lets say you have a tree like this:
848 ,(2)* Level one again
851 with (1) and (2) indicating possible cursor positions for the
852 insertion. When at (1), the tree will be pasted as level 2.
853 When at (2), it will be pasted as level 1.
855 If you do not want =C-y= to behave like this, configure the
856 variable =org-yank-adjusted-subtrees=.
858 Thanks to Samuel Wales for this idea and a partial implementation.
860 *** State changes can now be shown in the log mode in the agenda
862 If you configure the variable =org-agenda-log-mode-items=,
863 you can now request that all logged state changes be included
864 in the agenda when log mode is active. If you find this too
865 much for normal applications, you can also temporarily
866 request the inclusion of state changes by pressing =C-u l= in
869 This was a request by Hsiu-Khuern Tang.
871 You can also press `C-u C-u l' to get *only* log items in the
872 agenda, withour any timestamps/deadlines etc.
874 *** Footnote in HTML export are now collected at the end of the document
875 Previously, footnotes would be left in the document where
876 they are defined, now they are all collected and put into a
877 special =<div>= at the end of the document.
879 Thanks to Sebastian Rose for this request.
881 *** HTML export now validates again as XHTML.
883 Thanks to Sebastian Rose for pushing this cleanup.
885 *** The clock can now be resumed after exiting and re-starting Emacs
887 If the option =org-clock-in-resume= is t, and the first clock
888 line in an entry is unclosed, clocking into that task resumes
889 the clock from that time.
891 Thanks to James TD Smith for a patch to this effect.
893 *** Clock-related data can be saved and resumed across Emacs sessions
895 The data saved include the contents of =org-clock-history=,
896 and the running clock, if there is one.
898 To use this, you will need to add to your .emacs
900 #+begin_src emacs-lisp
901 (setq org-clock-persist t)
902 (setq org-clock-in-resume t)
903 (org-clock-persistence-insinuate)
906 Thanks to James TD Smith for a patch to this effect.
908 *** Following file links can now use C-u C-u to force use of an external app.
910 So far you could only bypass your setup in `org-file-apps'
911 and force opening a file link in Emacs by using a =C-u= prefix arg
912 with =C-c C-o=. Now you can call =C-u C-u C-c C-o= to force
913 an external application. Which external application depends
914 on your system. On Mac OS X and Windows, =open= is used. On
915 a GNU/Linux system, the mailcap settings are used.
917 This was a proposal by Samuel Wales.
919 *** Inserting absolute files names now abbreviates links with "~".
921 Inserting file links with =C-u C-c C-l= was buggy if the
922 setting of `org-link-file-path-type' was `adaptive' (the
923 default). Absolute file paths were not abbreviated relative
924 to the users home directory. This bug has been fixed.
926 Thanks to Matt Lundin for the report.
928 *** Links to attachment files
930 Even though one of the purposes of entry attachments was to
931 reduce the number of links in an entry, one might still want
932 to have the occasional link to one of those files. You can
933 now use link abbreviations to set up a special link type that
934 points to attachments in the current entry. Note that such
935 links will only work from within the same entry that has the
936 attachment, because the directory path is entry specific.
937 Here is the setup you need:
939 #+begin_src emacs-lisp
940 (setq org-link-abbrev-alist '(("att" . org-attach-expand-link)))
943 After this, a link like this will work
946 [[att:some-attached-file.txt]]
948 This was a proposal by Lindsay Todd.
950 *** Completed repeated tasks listed briefly in agenda
952 When a repeating task, listed in the daily/weekly agenda under
953 today's date, is completed from the agenda, it is listed as
954 DONE in the agenda until the next update happens. After the
955 next update, the task will have disappeared, of course,
956 because the new date is no longer today.
958 *** Remove buffers created during publishing are removed
960 Buffers that are created during publishing are now deleted
961 when the publishing is over. At least I hope it works like this.
967 - Secondary agenda filtering is becoming a killer feature
968 - Setting tags has now its own binding, =C-c C-q=
969 - Todo state changes can trigger tag changes
970 - C-RET will now always insert a new headline, never an item.
971 - Customize org-mouse.el feature set to free up mouse events
972 - New commands for export all the way to PDF (through LaTeX)
973 - Some bug fixed for LaTeX export, more bugs remain.
977 *** Enhancements to secondary agenda filtering
979 This is, I believe, becoming a killer feature. It allows you
980 to define fewer and more general custom agenda commands, and
981 then to do the final narrowing to specific tasks you are
982 looking for very quickly, much faster than calling a new
985 If you have not tries this yet, you should!
987 **** You can now refining the current filter by an additional criterion
988 When filtering an existing agenda view with =/=, you can
989 now narrow down the existing selection by an additional
990 condition. Do do this, use =\= instead of =/= to add the
991 additional criterion. You can also press =+= or =-= after
992 =/= to add a positive or negative condition. A condition
993 can be a TAG, or an effort estimate limit, see below.
995 **** It is now possible to filter for effort estimates
996 This means to filter the agenda for the value of the Effort
997 property. For this you should best set up global allowed
998 values for effort estimates, with
1000 #+begin_src emacs-lisp
1001 (setq org-global-properties
1002 '(("Effort_ALL" . "0 0:10 0:30 1:00 2:00 3:00 4:00")))
1005 You may then select effort limits with single keys in the
1006 filter. It works like this: After =/= or =\=, first select
1007 the operator which you want to use to compare effort
1010 : < Select entries with effort smaller than or equal to the limit
1011 : > Select entries with effort larger than or equal to the limit
1012 : = Select entries with effort equal to the limit
1014 After that, you can press a single digit number which is
1015 used as an index to the allowed effort estimates.
1017 If you do not use digits to fast-select tags, you can even
1018 skip the operator, which will then default to
1019 `org-agenda-filter-effort-default-operator', which is by
1022 Thanks to Manish for the great idea to include fast effort
1023 filtering into the agenda filtering process.
1025 **** The mode line will show the active filter
1026 For example, if there is a filter in place that does select
1027 for HOME tags, against EMAIL tags, and for tasks with an
1028 estimated effort smaller than 30 minutes, the mode-line with
1029 show =+HOME-EMAIL+<0:30=
1031 **** The filter now persists when the agenda view is refreshed
1032 All normal refresh commands, including those that move the
1033 weekly agenda from one week to the next, now keep the
1034 current filter in place.
1036 You need to press =/ /= to turn off the filter. However,
1037 when you run a new agenda command, for example going from
1038 the weekly agenda to the TODO list, the filter will be
1041 *** Setting tags has now its own binding, =C-c C-q=
1043 You can still use =C-c C-c= on a headline, but the new
1044 binding should be considered as the main binding for this
1045 command. The reasons for this change are:
1047 - Using =C-c C-c= for tags is really out of line with other
1050 - I hate it in Remember buffers when I try to set tags and I
1051 cannot, because =C-c C-c= exits the buffer :-(
1053 - =C-c C-q= will also work when the cursor is somewhere down
1054 in the entry, it does not have to be on the headline.
1056 *** Todo state changes can trigger tag changes
1058 The new option =org-todo-state-tags-triggers= can be used to
1059 define automatic changes to tags when a TODO state changes.
1060 For example, the setting
1062 : (setq org-todo-state-tags-triggers
1063 : '((done ("Today" . nil) ("NEXT" . nil))
1064 : ("WAITING" ("Today" . t))))
1066 will make sure that any change to any of the DONE states will
1067 remove tags "Today" and "NEXT", while switching to the
1068 "WAITING" state will trigger the tag "Today" to be added.
1070 I use this mostly to get rid of TODAY and NEXT tags which I
1071 apply to select an entry for execution in the near future,
1072 which I often prefer to specific time scheduling.
1074 *** C-RET will now always insert a new headline, never an item.
1075 The new headline is inserted after the current subtree.
1077 Thanks to Peter Jones for patches to fine-tune this behavior.
1079 *** Customize org-mouse.el feature set
1080 There is a new variable =org-mouse-features= which gives you
1081 some control about what features of org-mouse you want to
1082 use. Turning off some of the feature will free up the
1083 corresponding mouse events, or will avoid activating special
1084 regions for mouse clicks. By default I have urned off the
1085 feature to use drag mouse events to move or promote/demote
1086 entries. You can of course turn them back on if you wish.
1088 This variable may still change in the future, allowing more
1089 fine-grained control.
1091 *** New commands for export to PDF
1093 This is using LaTeX export, and then processes it to PDF
1096 : C-c C-e p process to PDF.
1097 : C-c C-e d process to PDF, and open the file.
1100 - \usepackage{graphicx} is now part of the standard class
1102 - Several bugs fixed, but definitely not all of them :-(
1104 *** New option `org-log-state-notes-insert-after-drawers'
1106 Set this to =t= if you want state change notes to be inserted
1107 after any initial drawers, i.e drawers the immediately follow
1108 the headline and the planning line (the one with
1109 DEADLINE/SCHEDULED/CLOSED information).
1113 *** =org-file-apps= now uses regular expressions, see [[*%20org%20file%20apps%20now%20uses%20regular%20repressions%20instead%20of%20extensions][below]]
1117 *** =org-file-apps= now uses regular repressions instead of extensions
1118 Just like in =auto-mode-alist=, car's in the variable
1119 =org-file-apps= that are strings are now interpreted as
1120 regular expressions that are matched against a file name. So
1121 instead of "txt", you should now write "\\.txt\\'" to make
1122 sure the matching is done correctly (even though "txt" will
1123 be recognized and still be interpreted as an extension).
1125 There is now a shortcut to get many file types visited by
1126 Emacs. If org-file-apps contains `(auto-mode . emacs)', then
1127 any files that are matched by `auto-mode-alist' will be
1130 *** Changes to the attachment system
1132 - The default method to attach a file is now to copy it
1133 instead of moving it.
1134 - You can modify the default method using the variable
1135 `org-attach-method'. I believe that most Unix people want
1136 to set it to `ln' to create hard links.
1137 - The keys =c=, =m=, and =l= specifically select =copy=,
1138 =move=, or =link=, respectively, as the attachment method
1139 for a file, overruling `org-attach-method'.
1140 - To create a new attachment as an Emacs buffer, you have not
1141 now use =n= instead of =c=.
1142 - The file list is now always retrieved from the directory
1143 itself, not from the "Attachments" property. We still
1144 keep this property by default, but you can turn it off, by
1145 customizing the variable =org-attach-file-list-property=.
1149 ** Incompatible changes
1151 - Changes in the structure of IDs, see [[*The%20default%20structure%20of%20IDs%20has%20changed][here]] for details.
1153 - C-c C-a has been redefined, see [[*%20C%20c%20C%20a%20no%20longer%20calls%20show%20all][here]] for details.
1157 *** The default structure of IDs has changed
1159 IDs created by Org have changed a bit:
1160 - By default, there is no prefix on the ID. There used to be
1161 an "Org" prefix, but I now think this is not necessary.
1162 - IDs use only lower-case letters, no upper-case letters
1163 anymore. The reason for this is that IDs are now also used
1164 as directory names for org-attach, and some systems do not
1165 distinguish upper and lower case in the file system.
1166 - The ID string derived from the current time is now
1167 /reversed/ to become an ID. This assures that the first
1168 two letters of the ID change fast, so hat it makes sense to
1169 split them off to create subdirectories to balance load.
1170 - You can now set the `org-id-method' to `uuidgen' on systems
1173 *** =C-c C-a= no longer calls `show-all'
1175 The reason for this is that =C-c C-a= is now used for the
1176 attachment system. On the rare occasions that this command
1177 is needed, use =M-x show-all=, or =C-u C-u C-u TAB=.
1179 *** New attachment system
1181 You can now attach files to each node in the outline tree.
1182 This works by creating special directories based on the ID of
1183 an entry, and storing files in these directories. Org can
1184 keep track of changes to the attachments by automatically
1185 committing changes to git. See the manual for more
1188 Thanks to John Wiegley who contributed this fantastic new
1189 concept and wrote org-attach.el to implement it.
1191 *** New remember template escapes
1193 : %^{prop}p to insert a property
1194 : %k the heading of the item currently being clocked
1195 : %K a link to the heading of the item currently being clocked
1197 Also, when you exit remember with =C-2 C-c C-c=, the item
1198 will be filed as a child of the item currently being
1199 clocked. So the idea is, if you are working on something and
1200 think of a new task related to this or a new note to be
1201 added, you can use this to quickly add information to that
1204 Thanks to James TD Smith for a patch to this effect.
1206 *** Clicking with mouse-2 on clock info in mode-line visits the clock.
1208 Thanks to James TD Smith for a patch to this effect.
1210 *** New file in contrib: lisp/org-checklist.el
1212 This module deals with repeated tasks that have checkbox
1215 Thanks to James TD Smith for this contribution.
1217 *** New in-buffer setting #+STYLE
1219 It can be used to locally set the variable
1220 `org-export-html-style-extra'. Several such lines are
1221 allowed-, they will all be concatenated. For an example on
1222 how to use it, see the [[http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php][publishing tutorial]].
1228 - Filtering existing agenda views with respect to a tag
1229 - Editing fixed-width regions with picture or artist mode
1230 - /org-plot.el/ is now part of Org
1231 - Tags can be used to select the export part of a document
1232 - Prefix interpretation when storing remember notes
1233 - Yanking inserts folded subtrees
1234 - Column view capture tables can have formulas, plotting info
1235 - In column view, date stamps can be changed with S-cursor keys
1236 - The note buffer for clocking out now mentions the task
1237 - Sorting entries alphabetically ignores TODO keyword and priority
1238 - Agenda views can sort entries by TODO state
1239 - New face =org-scheduled= for entries scheduled in the future.
1240 - Remember templates for gnus links can use the :to escape.
1241 - The file specification in a remember template may be a function
1242 - Categories in iCalendar export include local tags
1243 - It is possible to define filters for column view
1244 - Disabling integer increment during table Field copy
1245 - Capturing column view is on `C-c C-x i'
1246 - And tons of bugs fixed.
1249 ** Incompatible changes
1251 *** Prefix interpretation when storing remember notes has changed
1253 The prefix argument to the `C-c C-c' command that finishes a
1254 remember process is now interpreted differently:
1256 : C-c C-c Store the note to predefined file and headline
1257 : C-u C-c C-c Like C-c C-c, but immediately visit the note
1258 : in its new location.
1259 : C-1 C-c C-c Select the storage location interactively
1260 : C-0 C-c C-c Re-use the last used location
1262 This was requested by John Wiegley.
1264 *** Capturing column view is now on `C-c C-x i'
1266 The reason for this change was that `C-c C-x r' is also used
1267 as a tty key replacement.
1269 *** Categories in iCalendar export now include local tags
1271 The locally defined tags are now listed as categories when
1272 exporting to iCalendar format. Org's traditional file/tree
1273 category is now the last category in this list. Configure
1274 the variable =org-icalendar-categories= to modify or revert
1277 This was a request by Charles Philip Chan.
1281 *** Secondary filtering of agenda views.
1283 You can now easily and interactively filter an existing
1284 agenda view with respect to a tag. This command is executed
1285 with the =/= key in the agenda. You will be prompted for a
1286 tag selection key, and all entries that do not contain or
1287 inherit the corresponding tag will be hidden. With a prefix
1288 argument, the opposite filter is applied: entries that
1289 do have the tag will be hidden.
1291 This operation only /hides/ lines in the agenda buffer, it
1292 does not remove them. Changing the secondary filtering does
1293 not require a new search and is very fast.
1295 If you press TAB at the tag selection prompt, you will be
1296 switched to a completion interface to select a tag. This is
1297 useful when you want to select a tag that does not have a
1298 direct access character.
1300 A double =/ /= will restore the original agenda view by
1301 unhiding any hidden lines.
1303 This functionality was John Wiegley's idea. It is a simpler
1304 implementation of some of the query-editing features proposed
1305 and implemented some time ago by Christopher League (see the
1306 file contrib/lisp/org-interactive-query.el).
1308 *** Editing fixed-width regions with picture or artist mode
1310 The command @<code>C-c '@</code> (that is =C-c= followed by a
1311 single quote) can now also be used to switch to a special
1312 editing mode for fixed-width sections. The default mode is
1313 =artist-mode= which allows you to create ASCII drawings.
1315 It works like this: Enter the editing mode with
1316 @<code>C-c '@</code>. An indirect buffer will be created and
1317 narrowed to the fixed-width region. Edit the drawing, and
1318 press @<code>C-c '@</code> again to exit.
1320 Lines in a fixed-width region should be preceded by a colon
1321 followed by at least one space. These will be removed during
1322 editing, and then added back when you exit the editing mode.
1324 Using the command in an empty line will create a new
1327 This new feature arose from a discussion involving Scott
1328 Otterson, Sebastian Rose and Will Henney.
1330 *** /org-plot.el/ is now part of Org.
1332 You can run it by simple calling org-plot/gnuplot.
1333 Documentation is not yet included with Org, please refer to
1334 http://github.com/eschulte/org-plot/tree/master until we have
1335 moved the docs into Org or Worg.
1337 Thanks to Eric Schulte for this great contribution.
1339 *** Tags can be used to select the export part of a document
1341 You may now use tags to select parts of a document for
1342 inclusion into the export, and to exclude other parts. This
1343 behavior is governed by two new variables:
1344 =org-export-select-tags= and =org-export-exclude-tags=.
1345 These default to =("export")= and =("noexport")=, but can be
1346 changed, even to include a list of several tags.
1348 Org first checks if any of the /select/ tags is present in
1349 the buffer. If yes, all trees that do not carry one of these
1350 tags will be excluded. If a selected tree is a subtree, the
1351 heading hierarchy above it will also be selected for export,
1352 but not the text below those headings. If none of the select
1353 tags is found anywhere in the buffer, the whole buffer will
1354 be selected for export. Finally, all subtrees that are
1355 marked by any of the /exclude/ tags will be removed from the
1358 You may set these tags with in-buffer options
1359 =EXPORT_SELECT_TAGS= and =EXPORT_EXCLUDE_TAGS=.
1361 I love this feature. Thanks to Richard G Riley for coming
1364 *** Prefix interpretation when storing remember notes
1366 The prefix argument to the `C-c C-c' command that finishes a
1367 remember process is now interpreted differently:
1369 : C-c C-c Store the note to predefined file and headline
1370 : C-u C-c C-c Like C-c C-c, but immediately visit the note
1371 : in its new location.
1372 : C-1 C-c C-c Select the storage location interactively
1373 : C-0 C-c C-c Re-use the last used location
1375 This was requested by John Wiegley.
1377 *** Yanking inserts folded subtrees
1379 If the kill is a subtree or a sequence of subtrees, yanking
1380 them with =C-y= will leave all the subtrees in a folded
1381 state. This basically means, that kill and yank are now
1382 much more useful in moving stuff around in your outline. If
1383 you do not like this, customize the variable
1384 =org-yank-folded-subtrees=.
1386 Right now, I am only binding =C-y= to this new function,
1387 should I modify all bindings of yank? Do we need to amend
1390 This feature was requested by John Wiegley.
1392 *** Column view capture tables can have formulas, plotting info
1394 If you attach formulas and plotting instructions to a table
1395 capturing column view, these extra lines will now survive an
1396 update of the column view capture, and any formulas will be
1397 re-applied to the captured table. This works by keeping any
1398 continuous block of comments before and after the actual
1401 *** In column view, date stamps can be changed with S-cursor keys
1403 If a property value is a time stamp, S-left and S-right can
1404 now be used to shift this date around while in column view.
1406 This was a request by Chris Randle.
1408 *** The note buffer for clocking out now mentions the task
1410 This was a request by Peter Frings.
1412 *** Sorting entries alphabetically ignores TODO keyword and priority
1414 Numerical and alphanumerical sorting now skips any TODO
1415 keyword or priority cookie when constructing the comparison
1416 string. This was a request by Wanrong Lin.
1418 *** Agenda views can sort entries by TODO state
1420 You can now define a sorting strategy for agenda entries that
1421 does look at the TODO state of the entries. Sorting by TODO
1422 entry does first separate the non-done from the done states.
1423 Within each class, the entries are sorted not alphabetically,
1424 but in definition order. So if you have a sequence of TODO
1425 entries defined, the entries will be sorted according to the
1426 position of the keyword in this sequence.
1428 This follows an idea and sample implementation by Christian
1431 *** New face =org-scheduled= for entries scheduled in the future.
1433 This was a request by Richard G Riley.
1435 *** Remember templates for gnus links can now use the :to escape.
1437 Thanks to Tommy Lindgren for a patch to this effect.
1438 *** The file specification in a remember template may now be a function
1440 Thanks to Gregory Sullivan for a patch to this effect.
1442 *** Categories in iCalendar export now include local tags
1444 The locally defined tags are now listed as categories when
1445 exporting to iCalendar format. Org's traditional file/tree
1446 category is now the last category in this list. Configure
1447 the variable =org-icalendar-categories= to modify or revert
1450 This was a request by Charles Philip Chan.
1452 *** It is now possible to define filters for column view
1454 The filter can modify the value that will be displayed in a
1455 column, for example it can cut out a part of a time stamp.
1456 For more information, look at the variable
1457 =org-columns-modify-value-for-display-function=.
1459 *** Disabling integer increment during table field copy
1461 Prefix arg 0 to S-RET does the trick.
1463 This was a request by Chris Randle.
1468 For older Changes, see [[file:Changes_old.org]]