Document addition of org-exp-bibtex.el
[org-mode.git] / ORGWEBPAGE / Changes.org
blobbc214b0003de89d1d813fefa24c28d0402950a9c
1 #   -*- mode: org; fill-column: 65 -*-
3 #+STARTUP: showstars
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
10 #+LINK_UP: index.html
11 #+LINK_HOME: http://orgmode.org
13 * Version 6.24 (in preparation)
14  :PROPERTIES:
15  :VISIBILITY: content
16  :END:
18 ** Details
20 *** PDF export of agenda views
22 Agenda views can now be exported to PDF files by writing them to
23 a file with extension ".pdf".  Internally this works by first
24 producing the postscript version and then converting that to PDF
25 using the ghostview utility =ps2pdf=.  Make sure that this
26 utility is installed on your system.
28 The postscript version will not be removed, it will stay around.
30 *** Inline some entry text for Agenda View export
32 When exporting an agenda view to HTML or PDF for printing or
33 remote access, one of the problems can be that information stored
34 in entries below the headline is not accessible in that format.
36 You can now copy some of that information to the agenda view
37 before exporting it.  For this you need set the variable 
38 =org-agenda-add-entry-text-maxlines= to a number greater than 0.
40 #+begin_src emacs-lisp
41 (setq org-agenda-add-entry-text-maxlines 20)
42 #+end_src
44 Or you can to this with the settings in a special agenda view,
45 for example
47 #+begin_src emacs-lisp
48 ("A" "" agenda ""
49  ((org-agenda-ndays 1)
50   (org-agenda-add-entry-text-maxlines 5))
51  ("agenda-today.pdf"))
52 #+end_src
54 *** Exporting of citations to LaTeX and HTML, using BibTeX
55     
56     Citations can now me made using BibTeX, and will be exported
57     to LaTeX and HTML.  This is implemented in a contributed
58     package by Taru Karttunen, /org-exp-bibtex.el/.  Kudos to
59     Taru for this really nice addition.
61 *** Update of org2rem.el
63 /org2rem.el/ has been updated significantly and now does a more
64 comprehensive job of exporting Org events to remind.
66 Thanks to Sharad Pratap for this update.
68 *** Improved ASCII export of links
70 ASCII export of links works now much better.  If a link has a
71 link and a description part which are different, then the
72 description will remain in the text while the link part will be
73 moved to the end of the current section, before the next heading,
74 as a footnote-like construct.
76 Configure the variable =org-export-ascii-links-to-notes= if you
77 prefer the links to be shown in the text.  In this case, Org will
78 make an attempt to wrap the line which may have become
79 significantly longer by showing the link.
81 *** Turning off time-of-day search in headline
83 Some people like to put a creation time stamp into a headline and
84 then get confused if the time-of-day found in there shows up as
85 the time-of-day of the deadline/scheduling entry for this
86 headline.  The reason for this is that Org searches the headline
87 for a free-format time when trying to sort the entry into the
88 agenda, and that search accidentally finds the time in the
89 creation time stamp or something else that happens to look like a
90 time.  If this is more painful than useful for you, configure the
91 new variable =org-agenda-search-headline-for-time=.
93 *** Clustering characters for undo
95 When typing in Org-mode, undo will now remove up to 20 characters
96 at a time with a single undo command.  This is how things work
97 normally in Emacs, but the special binding of characters in
98 Org-mode made this impossible until now.
100 Thanks to Martin Pohlack for a patch which mimicks the behavior
101 of the Emacs command loop for the Org version of self-insert.
102 Note that this will not work in headlines and tables because
103 typing there will do a lot of extra work.
105 There might be a small typing performance hit resulting from this
106 change - please report in the mailing list if this is noticeable
107 and annoying. 
109 *** New reload command, with keyboard access
111 There is now a special command to reload all Org Lisp files, so
112 that you can stay in your Emacs session while pulling and
113 compiling changes to Org.  The command to reload the compiled
114 files (if available) is =C-c C-x r=.  If no compiled files are
115 found, uncompiled ones will be loaded.  If you want to force
116 loading of uncompiled code (great for producing backtraces), use
117 a prefix arg: =C-u C-c C-x o=.  Both commands are available in
118 the menu as well.
120 This new command was inspired by one written earlier by Bernt
121 Hansen.
123 *** Macro replacement
125 A string like ={{{ title }}}= will be replaced by the title of
126 the document, ={{{ email }}}= by the email setting of the author
127 and similarly for other export settings given in =#+...= lines.
128 In addition to that, you can define an arbitrary number of
129 macros, for example:
131 #+begin_src org
132 ,#+MACRO: myaddress 41 Onestreet, 12345 New York, NY
134 ,my address is {{{myaddress}}}, see you there.
135 #+end_src
137 Macro replacement is the very first thing that happes during
138 export, and macros will be replaced even in source code and other
139 protected regions.
141 *** Separate settings for special C-a and C-e 
143 The variable `org-special-ctrl-a/e' now allows separate settings
144 for =C-a= and =C-e=.  For example
146 #+begin_src emacs-lisp
147 (setq org-special-ctrl-a/e '(reversed . t))
148 #+end_src
150 Thanks to Alan Davis for this proposal.
152 *** orgstruct++-mode improvements
154 In addition to =orgstruct-mode= which allows to use some Org-mode
155 structure commands in other major modes, there is now a more
156 invasive version of this mode: =orgstruct++-mode=.  This mode
157 will import all paragraph and line wrapping variables into the
158 major mode, so that, for example, during typing the auto-fill
159 wrapping of items will work just like in Org-mode.  This change
160 is not reversible, so turning off orgstruct++-mode will not
161 remove these settings again. =orgstruct++-mode= is most useful in
162 text modes like message-mode or =magit-log-edit-mode=.
163 Furthermore, =orgstruct++-mode= will recognize plain list context
164 not only in the first line of an item, but also further down, so
165 that =M-RET= will correctly insert new items.
167 Thanks to Austin Frank for requesting some of these changes.
169 *** Promotion and demotion works for regions now
171 =M-right= and =M-left= now do demote and promote all headlines in
172 an active region.
174 * Version 6.23
175 ** Overview
177 - Capture state change notes into a drawer
178 - Clock lines are now captured into the LOGBOOK drawer as well
179 - Added org-R.el to contrib directory
180 - Allow individual formatting of each TODO keyword in HTML export
181 - New hooks for add-ons to tap into context-sensitive commands
182 - Publishing files irrespective of extension
183 - New variable index in the manual
184 - The ORDERED property also influences checkboxes
185 - The ORDERED property can be tracked with a tag
186 - You may now specify line breaks in the fast tags interface
187 - When a TODO is blocked by checkboxes, keep it visible in agenda
188 - LaTeX can import Org's in-buffer definitions for TITLE, EMAIL etc.
190 ** Incompatible changes
192 - CLOCK lines will now be captured into the LOGBOOK drawer.
193   See below for details.
195 ** Details
197 *** Capture state change notes into a drawer
199 State change notes can now be captured into a drawer =LOGBOOK=,
200 to keep the entry tidy.  If this is what you want, you will need
201 this configuration:
203 #+begin_src emacs-lisp
204 (setq org-log-into-drawer "LOGBOOK")
205 #+end_src
207 Thanks to Wanrong Lin for this proposal.
209 *** Clock lines are now captured into the LOGBOOK drawer as well
211 The =CLOCK= drawer will be abandoned, clock lines will now also
212 end up in a drawer =LOGBOOK=.  The reason for this is that it's a
213 bit useless to have two different drawers for state change notes
214 and clock lines.  If you wish to keep the old way, use
216 #+begin_src emacs-lisp
217 (setq org-clock-into-drawer "CLOCK")
218 #+end_src
220 *** Added org-R.el to contrib directory
222 Dan Davison has contributed /org-R.el/ which is now in the
223 contrib directory.  Org-R performs numerical computations and
224 generates graphics.  Data can come from org tables, or from csv
225 files; numerical output can be stored in the org buffer as org
226 tables, and links are created to files containing graphical
227 output.  Although, behind the scenes, it uses R, you do not need
228 to know anything about R.  Common operations, such as tabulating
229 discrete values in a column of an org table, are available "off
230 the shelf" by specifying options on lines starting with =#+R:=.
231 However, you can also provide raw R code to be evaluated.  The
232 documentation is currently the worg tutorial at
233 http://orgmode.org/worg/org-tutorials/org-R/org-R.php
235 Thanks to Dan for this great contribution.
237 *** Allow individual formatting of TODO keyword and tags in HTML export
239 TODO keywords in HTML export have the CSS class =todo= or =done=.
240 Tags have the CSS class =tag=.  In addition to this, each keyword
241 has now itself as class, so you could do this in your CSS file:
243 #+begin_src css
244 .todo { font-weight:bold; }
245 .done { font-weight:bold; }
246 .TODO { color:red; }
247 .WAITING { color:orange; }
248 .DONE { color:green; }
249 #+end_src
251 If any of your keywords causes conflicts with CSS classes used
252 for different purposes (for example a tag "title" would cause a
253 conflict with the class used for formatting the document title),
254 then you can use the variables =org-export-html-tag-class-prefix=
255 and =org-export-html-todo-kwd-class-prefix= to define prefixes
256 for the class names for keywords, for example "kwd-".
258 Thanks to Wanrong Lin for this request, and to Sebastian Rose for
259 help with the implementation.
261 *** New hooks for add-ons to tap into context-sensitive commands
263 Some commands in Org are context-sensitive, they will execute
264 different functions depending on context.  The most important
265 example is of course =C-c C-c=, but also the =M-cursor= keys fall
266 into this category.
268 Org has now a system of hooks that can be used by add-on packages
269 to install their own functionality into these keys.  See the
270 docstring of =org-ctrl-c-ctrl-c-hook= for details.  The other
271 hooks are named like =org-metaleft-hook= or
272 =org-shiftmetaright-hook=.
274 *** Publishing files irrespective of extension
276 If you set the =:base-extension= property for a publishing
277 project to the symbol =any=, all files in the directory will be
278 published, irrespective of extension.
280 Thanks to Richard Klinda for a patch to this effect.
282 *** New variable index in the manual
284 A new index in the manual lists all variables mentioned in the
285 manual, about 200 variables in total.
287 *** The ORDERED property also influences checkboxes
289 When an entry has the ORDERED property set, checkboxes in
290 the entry must be completed in order.  This was already the case
291 for children TODO items, now it also applies for checkboxes.
293 Thanks to Rainer Stengele for this proposal.
295 *** The ORDERED property can be tracked with a tag
297 The =ORDERED= property is used to flag an entry so that subtasks
298 (both children TODO items and checkboxes) must be completed in
299 order.  This property is most easily toggled with the command
300 =C-c C-x o=.  A property was chosen for this functionality,
301 because this should be a behavior local to the current task, not
302 inherited like tags.  However, properties are normally
303 invisible.  If you would like visual feedback on the state of
304 this property, configure the variable
305 =org-track-ordered-property-with-tag=.  If you then use =C-c C-x
306 o= to toggle the property, a tag will be toggled as well, for
307 visual feedback.
309 Note that the tag itself has no meaning for the behavior of TODO
310 items and checkboxes, and that changing the tag with the usual
311 tag commands will not influence the property and therefore the
312 behavior of TODO and checkbox commands.
314 *** You may now specify line breaks in the fast tags interface
316 Up to now, the fast tags interface tried to lump as many tags as
317 possible into a single line, with the exception that groups would
318 always be on a line by themselves.
320 Now, if you use several lines to define your tags, like
322 #+begin_src org
323 ,#+TAGS: aa(a) bb(b) cc(c)
324 ,#+TAGS: dd(d) ee(e) ff(f)
325 #+end_src
327 then there will also be a line break after the "cc" tag in the
328 fast tag selection interface.  You may also write
330 #+begin_src org
331 ,#+TAGS: aa(a) bb(b) cc(c) \n dd(d) ee(e) ff(f)
332 #+end_src
334 to achieve the same effect, and you can use =\n= several times in
335 order to produce empty lines.  In =org-tag-alist=, newlines are
336 represented as =(:newline)=.
338 Thanks to Christopher Suckling for a patch to this effect.
340 *** When a TODO is blocked by checkboxes, keep it visible in agenda
342 When the variable =org-agenda-dim-blocked-tasks= is set to
343 =invisible=, tasks that are blocked will not be visible in the
344 agenda.  If the blocking is due to child TODO entries, this does
345 make sense because the children themselves will show up in the
346 TODO list.
348 However, as John Rakestraw has [[http://thread.gmane.org/gmane.emacs.orgmode/10939][pointed out]], if the blocking is
349 done by checkboxes, no trace of these subtasks is left.
350 Therefore, when the blocking is done by checkboxes, we now
351 overrule the =invisible= setting and replace it with mere dimming
352 of the task.
354 *** LaTeX can import Org's in-buffer definitions for TITLE, EMAIL etc.
356 If you configure =org-export-latex-import-inbuffer-stuff=,
357 in-buffer definitions like #+TITLE will be made available in the
358 LaTeX file as =\orgTITLE=.
360 This was a request by Russel Adams.
362 * Version 6.22
363 ** Details
365 *** org-choose.el by Tom Breton is now included
367 Org-choose helps documenting a decision-making process by using
368 TODO keywords for different degrees of /chosenness/, and by
369 automatically keeping a set of alternatives in a consistent state.
371 Documentation for /org-choose.el/ is available [[http://orgmode.org/worg/org-contrib/org-choose.php][here]].
373 This package inserts itself into Org using hooks, so if other
374 people would like to do interesting stuff with TODO keywords for
375 special purposes, looking at Tom's code might be a good way to
376 start.
378 Thanks to Tom for this interesting contribution!
380 *** orgmode.org and Worg css works now better on IE
382 Thanks to Sebastian Rose for making these changes.
384 *** When exporting a subtree, headline levels are now relative to parent
386 This was reported as a bug by William Henney and is fixed now.
388 *** Inactive dates in tables can be used for sorting.
390 When sorting table fields or entries by date, Org first tries to
391 find an active date, and, if none exist, uses a passive date if
392 present.
394 This was a request by Hsui-Khuen Tang
396 *** The default for =org-return-follows-link= is back to =nil=
398 Setting it to =t= violates Emacs rules to some extent.  The
399 internal implementation of this has been improved, so setting it
400 to =t= should now be pretty stable.
402 *** Automatic scheduling of siblings with org-depend.el
404 The sibling of a DONE task can now automatically be scheduled.
406 This was a patch by Andrew Hyatt.
408 *** New skipping conditions
410 The functions =org-agenda-skip-entry-if= and
411 =org-agenda-skip-subtree-if= now accept =timestamp= and
412 =nottimestamp= as additional conditions.
414 This was in response to a request by Saurabh Agrawal.
416 * Version 6.21
418 ** Details
420 *** Changes to some default values of variables:
422 Here are the new default values:
424 #+begin_example
425 (setq org-return-follows-link t)
427 (setq org-use-fast-todo-selection t)
429 (setq org-yank-adjusted-subtrees nil)
431 (setq org-tags-column -77)
433 (setq org-agenda-sorting-strategy
434      '((agenda time-up priority-down category-keep)
435         (todo time-up priority-down category-keep)
436         (tags time-up priority-down category-keep)
437         (search category-keep)))
438 #+end_example
440 *** Final cleanup for Emacs 21.1 pretest
442 * Version 6.20
444 ** Details
446 *** Support for simple TODO dependencies
448 John Wiegley's code for enforcing simple TODO dependencies has
449 been integrated into Org-mode.  Thanks John!
451 The structure of Org files (hierarchy and lists) makes it easy to
452 define TODO dependencies.  A parent TODO task should not be
453 marked DONE until all subtasks (defined as children tasks) are
454 marked as DONE.  And sometimes there is a logical sequence to a
455 number of (sub)tasks, so that one task cannot be acted upon
456 before all siblings above it are done.  If you customize the
457 variable =org-enforce-todo-dependencies=, Org will block entries
458 from changing state while they have children that are not DONE.
459 Furthermore, if an entry has a property =ORDERED=, each of its
460 children will be blocked until all earlier siblings are marked
461 DONE.  Here is an example:
463 #+begin_src org
464 ,* TODO Blocked until (two) is done
465 ,** DONE one
466 ,** TODO two
468 ,* Parent
469 ,  :PROPERTIES:
470 ,    :ORDERED: t
471 ,  :END:
472 ,** TODO a
473 ,** TODO b, needs to wait for (a)
474 ,** TODO c, needs to wait for (a) and (b)
475 #+end_src
477 The command =C-c C-x o= toggles the value of the =ORDERED=
478 property.
480 The variable =org-agenda-dim-blocked-tasks= controls how blocked
481 entries should appear in the agenda, where they can be dimmed or
482 even made invisible.
484 Furthermore, you can use the variable
485 =org-enforce-todo-checkbox-dependencies= to block TODO entries
486 from switching to DONE while any checkboxes are unchecked in the entry.
488 *** Support for shift-selection in Emacs 23
490 Customize the variable =org-support-shift-select= to use S-cursor
491 key for selecting text.  Make sure that you carefully read the
492 docstring of that variable first.
494 *** Adding and removing checkboxes from many lines
496 The command =C-c C-x C-b= normally toggles checkbox status in the
497 current line, or in all lines in the region.  With prefix
498 argument it now either adds or removes the checkbox.
500 This was a requested by Daniel Clemente.
502 * Version 6.19
504 ** Overview
505    
506 - Improved behavior of conversion commands =C-c -= and =C-c *=
507 - Table formulas may now reference fields in other tables
508 - A final hline is imagined in each table, for the sake of references
509 - A tags-todo search can now ignore timestamped items
510 - =\par= can be used to force a paragraph break, also in footnotes
512 ** Details
513    
515 *** Improved behavior of conversion commands =C-c -= and =C-c *=
517     The conversion commands =C-c -= and =C-c *= are now better
518     behaved and therefore more useful, I hope.
520     If there is an active region, these commands will act on the
521     region, otherwise on the current line.
523     - C-c - :: This command turns headings or normal lines into
524          items, or items into normal lines.  When there is a
525          region, everything depends on the first line of the
526          region:
527          - if it is a item, turn all items in the region into
528            normal lines.
529          - if it is a headline, turn all headlines in the region
530            into items. 
531          - if it is a normal line, turn all lines into items.
532          - special case: if there is no active region and the
533            current line is an item, cycle the bullet type of the
534            current list.
535     - C-c * :: This command turns items and normal lines into
536          headings, or headings into normal lines.  When there is
537          a region, everything depends on the first line of the
538          region:
539          - if it is a item, turn all items in the region into
540            headlines.
541          - if it is a headline, turn all headlines in the region
542            into normal lines. 
543          - if it is a normal line, turn all lines into headlines.
545 *** Table formulas may now reference fields in other tables
547 You may now reference constants, fields and ranges from a
548 different table, either in the current file or even in a
549 different file.  The syntax is
551 : remote(NAME-OR-ID,REF)
553 where /NAME/ can be the name of a table in the current file as
554 set by a =#+TBLNAME: NAME= line before the table.  It can also be
555 the ID of an entry, even in a different file, and the reference
556 then refers to the first table in that entry.  /REF/ is an
557 absolute field or range reference, valid in the referenced table.
558 Note that since there is no "current filed" for the remote table,
559 all row and column references must be absolute, not relative.
561 *** A final hline is imagined in each table, for the sake of references
563 Even if a table does not end with a hline (mine never do because I
564 think it is not pretty), for the sake of references you can
565 assume there is one.  So in the following table
567 #+begin_src org
568 | a | b |
569 |---+---|
570 | 1 | 2 |
571 | 3 | 4 |
572 #+end_src
574 a reference like =@I$1..@II$2= will now work.
576 *** A tags-todo search can now ignore timestamped items
577     The variables =org-agenda-todo-ignore-with-date=,
578     =org-agenda-todo-ignore-with-date=, and
579     =org-agenda-todo-ignore-with-date= make it possible to
580     exclude TODO entries which have this kind of planning info
581     associated with them.  This is most useful for people who
582     schedule everything, and who use the TODO list mainly to find
583     things that are not yet scheduled.  Thomas Morgan pointed out
584     that also the tags-todo search may serve exactly this
585     purpose, and that it might be good to have a way to make
586     these variables also apply to the tags-todo search.  I can
587     see that, but could not convince myself to make this the
588     default.  A new variable must be set to make this happen:
589     =org-agenda-tags-todo-honor-ignore-options=.
591 *** =\par= can be used to force a paragraph break, also in footnotes
593 The LaTeX idiom =\par= will insert a paragraph break at that
594 location.  Normally you would simply leave an empty line to get
595 such a break, but this is useful for footnotes whose
596 definitions may not contain empty lines.
598 * Version 6.18
599 ** Incompatible changes
601 *** Short examples must have a space after the colon
603     Short literal examples can be created by preceding lines
604     with a colon.  Such lines must now have a space after the
605     colon.  I believe this is already general practice, but now
606     it must be like this.  The only exception are lines that are
607     empty except for the colon.    
609 ** Details
611 *** Include files can now also process switches
613     The example and src switches like =-n= can now also be added
614     to include file statements:
616 : #+INCLUDE "~/.emacs" src emacs-lisp -n -r
618     Thanks to Manish for pointing out that this was not yet
619     supported.
621 *** Examples can be exported to HTML as text areas
622     
623     You can now specify a =-t= switch to an example or src block,
624     to make it export to HTML as a text area.  To change the
625     defaults for height (number of lines in the example) and
626     width of this area (80), use the =-h= and =-w= switches.
628     Thanks to Ulf Stegemann for driving this development.
630 *** LaTeX_CLASS can be given as a property
632     When exporting a single subtree by selecting it as a region
633     before export, the LaTeX class for the export will be taken
634     from the =LaTeX_CLASS= property of the entry if present.
636     Thanks to Robert Goldman for this request.
638 *** Better handling of inlined images in different backends
640     Two new variables govern which kind of files can be inlined
641     during export.  These are
642     =org-export-html-inline-image-extensions= and
643     =org-export-latex-inline-image-extensions=.  Remember that
644     links are turned into an inline image if they are a pure link
645     with no description.  HTML files can inline /.png/, /.jpg/,
646     and /.gif/ files, while LaTeX files, when processed with
647     /pdflatex/, can inline /.png/, /.jpg/, and /.pdf/ files.
648     These also represent the default settings for the new
649     variables.  Note that this means that pure links to /.pdf/
650     files will be inlined - to avoid this for a particular link,
651     make sure that the link has a description part which is not
652     equal to the link part.
654 *** Links by ID now continue to work in HTML exported files
656     If you make links by ID, these links will now still work in
657     HTML exported files, provided that you keep the relative path
658     from link to target file the same.
660     Thanks to Friedrich Delgado Friedrichs for pushing this over
661     the line.
663 *** The relative timer can be paused
665     The new command `C-c C-x ,' will pause the relative timer.
666     When the relative timer is running, its value will be shown
667     in the mode line.  To get rid of this display, you need to
668     really stop the timer with `C-u C-c C-x ,'.
670     Thanks to Alan Davis for driving this change.
672 *** The attachment directory may now be chosen by the user
674     Instead of using the automatic, unique directory related to
675     the entry ID, you can also use a chosen directory for the
676     attachments of an entry.  This directory is specified by the
677     ATTACH_DIR property.  You can use `C-c C-a s' to set this
678     property.
680     Thanks to Jason Jackson for this proposal.
682 *** You can use a single attachment directory for a subtree
684     By setting the property ATTACH_DIR_INHERIT, you can now tell
685     Org that children of the entry should use the same directory
686     for attachments, unless a child explicitly defines its own
687     directory with the ATTACH_DIR property.  You can use the
688     command `C-c C-a i' to set this property in an entry.
690 * Version 6.17
692 ** Overview
694 - Footnote support
695 - Line numbers and references in literal examples 
696 - New hooks for export preprocessing 
697 - Capture column view into a different file
699 ** Details
701 *** Footnote support
703 Org-mode now directly supports the creation of footnotes.  In
704 contrast to the /footnote.el/ package, Org-mode's footnotes are
705 designed for work on a larger document, not only for one-off
706 documents like emails.  The basic syntax is similar to the one
707 used by /footnote.el/, i.e. a footnote is defined in a paragraph
708 that is started by a footnote marker in square brackets in column
709 0, no indentation allowed.  The footnote reference is simply the
710 marker in square brackets inside text.  For example:
712 #+begin_src org
713 The Org homepage[fn:1] now looks a lot better than it used to.
715 [fn:1] The link is: http://orgmode.org
716 #+end_src
718 Org-mode extends the number-based syntax to /named/ footnotes and
719 optional inline definition.  Using plain numbers as markers is
720 supported for backward compatibility, but not encouraged because
721 of possible conflicts with LaTeX syntax.  Here are the valid
722 references:
724 - [1] ::  A plain numeric footnote marker.
725          
726 - [fn:name] :: A named footnote reference, where `name' is a
727      unique label word or, for simplicity of automatic creation,
728      a number. 
729      
730 - [fn:: This is the inline definition of this footnote] :: A
731      LaTeX-like anonymous footnote where the definition is given
732      directly at the reference point.
734 - [fn:name: a definition] :: An inline definition of a footnote,
735      which also specifies a name for the note.  Since Org allows
736      multiple references to the same note, you can then use use
737      `[fn:name]' to create additional references.
739 Footnote labels can be created automatically, or you create names
740 yourself.  This is handled by the variable
741 =org-footnote-auto-label= and its corresponding =#+STARTUP=
742 keywords, see the docstring of that variable for details.
744 The following command handles footnotes:
746 - C-c C-x f :: The footnote action command.  When the cursor is
747      on a footnote reference, jump to the definition.  When it is
748      at a definition, jump to the (first) reference.  Otherwise,
749      create a new footnote.  Depending on the variable
750      `org-footnote-define-inline' (with associated =#+STARTUP=
751      options =fninline= and =nofninline=), the definitions will
752      be placed right into the text as part of the reference, or
753      separately into the location determined by the variable
754      =org-footnote-section=.
755      When this command is called with a prefix argument, a menu
756      of additional options is offered:
757      - s :: Sort the footnote definitions by reference sequence.
758             During editing, Org makes no effort to sort footnote
759             definitions into a particular sequence.  If you want
760             them sorted, use this command, which will also move
761             entries according to =org-footnote-section=.
762      - n :: Normalize the footnotes by collecting all
763             definitions (including inline definitions) into a
764             special section, and then numbering them in
765             sequence.  The references will then also be
766             numbers.  This is meant to be the final step before
767             finishing a document (e.g. sending off an email).
768             The exporters do this automatically, and so could 
769             something like `message-send-hook'.
770      - d :: Delete the footnote at point, and all references to it.
771             
772 - C-c C-c :: If the cursor is on a footnote reference, jump to
773      the definition.  If it is a the definition, jump back to the
774      reference.  When called with a prefix argument at either
775      location, offer the same menu as `C-u C-c C-x f'.
777 - C-c C-o or mouse-1/2 :: Footnote labels are also links to the
778      corresponding definition/reference, and you can use the
779      usual commands to follow these links.
781 Org-mode's footnote support is designed so that it should also
782 work in buffers that are not in Org-mode, for example in email
783 messages.  Just bind =org-footnote-action= to a global key like
784 =C-c f=.
786 The main trigger for this development came from a hook function
787 written by Paul Rivier, to implement named footnotes and to
788 convert them to numbered ones before export.  Thanks, Paul!
790 Thanks also to Scot Becker for a thoughtful post bringing this
791 subject back onto the discussion table, and to Matt Lundin for
792 the idea of named footnotes and his prompt testing of the new
793 features.
795 *** Line numbers and references in literal examples
797 Literal examples introduced with =#+BEGIN_EXAMPLE= or =#+BEGIN_SRC=
798 do now allow optional line numbering in the example.
799 Furthermore, links to specific code lines are supported, greatly
800 increasing Org-mode's utility for writing tutorials and other
801 similar documents.
803 Code references use special labels embedded directly into the
804 source code.  Such labels look like "(ref:name)" and must be
805 unique within a document.  Org-mode links with "(name)" in the
806 link part will be correctly interpreted, both while working with
807 an Org file (internal links), and while exporting to the
808 different backends.  Line numbering and code references are
809 supported for all three major backends, HTML, LaTeX, and ASCII.
810 In the HTML backend, hovering the mouse over a link to a source
811 line will remote-highlight the referenced code line.
813 The options for the BEGIN lines are:
815  - -n :: Number the lines in the example
816  - +n :: Like -n, but continue numbering from where the previous
817          example left off.
818  - -r :: Remove the coderef cookies from the example, and replace
819          links to this reference with line numbers.  This option
820          takes only effect if either -n or +n are given as well.
821          If -r is not given, coderefs simply use the label name.
822  - -l "fmt" :: Define a local format for coderef labels, see the
823       variable =org-coderef-label-format= for details.  Use this
824       of the default syntax causes conflicts with the code in the
825       code snippet you are using.
827 Here is an example:
829 #+begin_example -k
830 #+begin_src emacs-lisp -n -r
831 (defmacro org-unmodified (&rest body)                   (ref:def)
832   "Execute body without changing `buffer-modified-p'."
833   `(set-buffer-modified-p                              (ref:back)
834     (prog1 (buffer-modified-p) ,@body)))
835 #+end_src
836 [[(def)][Line (def)]] contains the macro name.  Later at line [[(back)]],
837 backquoting is used.
838 #+end_example
840 When exported, this is translated to:
841 #+begin_src emacs-lisp -n -r
842 (defmacro org-unmodified (&rest body)                   (ref:def)
843   "Execute body without changing `buffer-modified-p'."
844   `(set-buffer-modified-p                              (ref:back)
845     (prog1 (buffer-modified-p) ,@body)))
846 #+end_src
847 [[(def)][Line (def)]] contains the macro name.  Later at line [[(back)]],
848 backquoting is used.
850 Thanks to Ilya Shlyakhter for proposing this feature set.  Thanks
851 to Sebastian Rose for the key Javascript element that made the
852 remote highlighting possible.
854 *** New hooks for export preprocessing
855     The export preprocessor now runs more hooks, to allow
856     better-timed tweaking by user functions:
858 - =org-export-preprocess-hook= ::
859   Pretty much the first thing in the preprocessor.  But org-mode
860   is already active in the preprocessing buffer.
862 - =org-export-preprocess-after-include-files-hook= ::
863   This is run after the contents of included files have been inserted.
865 - =org-export-preprocess-after-tree-selection-hook= ::
866   This is run after selection of trees to be exported has
867   happened.  This selection includes tags-based selection, as
868   well as removal of commented and archived trees.
870 - =org-export-preprocess-before-backend-specifics-hook= ::
871   Hook run before backend-specific functions are called during preprocessing.
873 - =org-export-preprocess-final-hook= ::
874   Hook for preprocessing an export buffer.  This is run as the
875   last thing in the preprocessing buffer, just before returning
876   the buffer string to the backend.
878 *** Capture column view into a different file
880     The :id parameter for the dynamic block capturing column view
881     can now truly be an ID that will also be found in a
882     different file.  Also, it can be like =file:path/to/file=, to
883     capture the global column view from a different file.
885     Thanks to Francois Lagarde for his report that IDs outside
886     the current file would not work.
888 * Version 6.16
889   Cleanup of many small bugs, and one new feature.
891 ** Details
893 *** References to last table row with special names
895     Fields in the last row of a table can now be referenced with
896     $LR1, $LR2, etc.  These references can appear both on the
897     left hand side and right hand side of a formula.
899 * Version 6.15f
901   This version reverses the introduction of @0 as a reference to
902   the last rwo in a table, because of a conflict with the use of
903   @0 for the current row.
905 * Version 6.15
906 ** Overview
908 - All known LaTeX export issues fixed 
909 - Captions and attributes for figures and tables. 
910 - Better implementation for entry IDs 
911 - Spreadsheet references to the last table line. 
912 - Old syntax for link attributes abandoned 
914 ** Incompatible changes
915 *** Old syntax for link attributes abandoned
917 There used to be a syntax for setting link attributes for
918 HTML export by enclosing the attributes into double braces
919 and adding them to the link itself, like
921 #+begin_example
922 [[./img/a.jpg{{alt="an image"}}] ]
923 #+end_example
925 This syntax is not longer supported, use instead
927 #+begin_src org
928 ,#+ATTR_HTML: alt="an image"
929 [[./img/a.jpg] ]
930 #+end_src
932 ** Details
934 *** All known LaTeX export issues fixed
936 All the remaining issues with the LaTeX exporter have hopefully
937 been addressed in this release.  In particular, this covers
938 quoting of special characters in tables and problems with
939 exporting files where the headline is in the first line, or with
940 an active region.
942 *** Captions and attributes for figures and tables.
944 Tables, and Hyperlinks that represent inlined images, can now be
945 equipped with additional information that will be used during
946 export.  The information will be taken from the following special
947 lines in the buffer and apply to the first following table or
948 link.
950 - #+CAPTION: :: The caption of the image or table.  This string
951      should be processed according to the export backend, but
952      this is not yet done.
954 - #+LABEL: :: A label to identify the figure/table for cross
955      references.  For HTML export, this string will become the
956      ID for the ~<div class="figure">~ element that encapsulates
957      the image tag and the caption.  For LaTeX export, this
958      string will be used as the argument of a ~\label{...}~
959      macro.  These labels will be available for internal links
960      like ~[[label][Table] ]~.
962 - #+ATTR_HTML: :: Attributes for HTML export of image, to be
963      added as attributes into the ~<img...>~ tag.  This string
964      will not be processed, so it should have immediately the
965      right format.
967 - #+ATTR_LaTeX: :: Attributes for LaTeX export of images and
968      tables.\\
969      For /images/, this string is directly inserted into
970      the optional argument of the ~\includegraphics[...]{file}~
971      command, to specify scaling, clipping and other options.
972      This string will not be processed, so it should have
973      immediately the right format, like =width=5cm,angle=90=.\\       
974      For /tables/, this can currently contain the keyword
975      =longtable=, to request typesetting of the table using the
976      longtable package, which automatically distributes the table
977      over several pages if needed.  Also, the attributes line may
978      contain an alignment string for the tabular environment, like
979      =longtable,align=l|lrl=
981 For LaTeX export, if either a caption or a label is given, the element
982 will be exported as a float, i.e. wrapped into a figure or table
983 environment.
985 *** Better implementation for entry IDs
986     
987 Unique identifiers for entries can now be used more efficiently.
988 Internally, a hash array has replaced the alist used so far to
989 keep track of the files in which an ID is defined.  This makes it
990 quite fast to find an entry by ID.
992 There is a new link type which looks like this:
994 #+begin_example
995 id:GLOBALLY-UNIQUE-IDENTIFIER
996 #+end_example
998 This link points to a specific entry.  When you move the entry to
999 a different file, for example if you move it to an archive
1000 file, the link will continue to work.
1002 The file /org-id.el/ contains an API that can be used to write
1003 code using these identifiers, including creating IDs and finding
1004 them wherever they are.
1006 Org has its own method to create unique identifiers, but if the system
1007 has /uuidgen/ command installed (Mac's and Linux systems generally
1008 do), it will be used by default (a change compared to the earlier
1009 implmentation, where you explicitdly had to opt for uuidgen).  You can
1010 also select the method by hand, using the variable =org-id-method=.
1012 If the ID system ever gets confused about where a certain ID is, it
1013 initiates a global scan of all agenda files with associated archives,
1014 all files previously known containing any IDs, and all currently
1015 visited Org-mode files to rebuild the hash.  You can also initiate
1016 this by hand: =M-x org-id-update-id-locations=.  Running this command
1017 will also dump into the =*Messages*= buffer information about any
1018 duplicate IDs.  These should not exist, and Org will never /make/ the
1019 same ID twice, but if you /copy/ an entry with its properties,
1020 duplicate IDs will inevitably be produced.  Unfortunately, this is
1021 unavoidable in a plain text system that allows you to edit the text in
1022 arbitrary ways, and a portion of care on your side is needed to keep
1023 this system clean.
1025 The hash is stored in the file =~/.emacs.d/.org-id-locations=.
1026 This is also a change from previous versions where the file was
1027 =~/.org=id-locations=.  Therefore, you can remove this old file
1028 if you have it.  I am not sure what will happen if the =.emacs.d=
1029 directory does not exists in your setup, but in modern Emacsen, I
1030 believe it should exist.  If you do not want to use IDs across
1031 files, you can avoid the overhead with tracking IDs by
1032 customizing the variable =org-id-track-globally=.  IDs can then
1033 still be used for links inside a single file.
1035 IDs will also be used when you create a new link to an Org-mode
1036 buffer.  If you use =org-store-link= (normally at =C-c l=) inside
1037 en entry in an Org-mode buffer, and ID property will be created
1038 if it does not exist, and the stored link will be an =id:= link.
1039 If you prefer the much less secure linking to headline text, you
1040 can configure the variable =org-link-to-org-use-id=.  The default
1041 setting for this variable is =create-if-interactive=, meaning
1042 that an ID will be created when you store a link interactively,
1043 but not if you happen to be in an Org-mode file while you create
1044 a remember note (which usually has a link to the place where you
1045 were when starting remember).
1047 *** Spreadsheet references to the last table line.
1049 You may now use =@0= to reference the last dataline in a table
1050 in a stable way.  This is useful in particular for automatically
1051 generated tables like the ones using /org-collector.el/ by Eric
1052 Schulte.
1054 * Version 6.14
1055 ** Overview
1057    - New relative timer to support timed notes 
1058    - Special faces can be set for individual tags 
1059    - The agenda shows now all tags, including inherited ones. 
1060    - Exclude some tags from inheritance. 
1061    - More special values for time comparisons in property searches 
1062    - Control for exporting meta data 
1063    - Cut and Paste with hot links from w3m to Org 
1064    - LOCATION can be inherited for iCalendar export 
1065    - Relative row references crossing hlines now throw an error 
1067 ** Incompatible Changes
1069 *** Relative row references crossing hlines now throw an error
1070     
1071     Relative row references in tables look like this: "@-4" which
1072     means the forth row above this one.  These row references are
1073     not allowed to cross horizontal separator lines (hlines).  So
1074     far, when a row reference violates this policy, Org would
1075     silently choose the field just next to the hline.
1077     Tassilo Horn pointed out that this kind of hidden magic is
1078     actually confusing and may cause incorrect formulas, and I do
1079     agree.  Therefore, trying to cross a hline with a relative
1080     reference will now throw an error.
1081     
1082     If you need the old behavior, customize the variable
1083     `org-table-error-on-row-ref-crossing-hline'.
1085 ** Details
1087 *** New relative timer to support timed notes
1089     Org now supports taking timed notes, useful for example while
1090     watching a video, or during a meeting which is also recorded.
1092     - =C-c C-x .= :: 
1093       Insert a relative time into the buffer.  The first time
1094       you use this, the timer will be started.  When called
1095       with a prefix argument, the timer is reset to 0.
1097     - =C-c C-x -= :: 
1098       Insert a description list item with the current relative
1099       time.  With a prefix argument, first reset the timer to 0.
1101     - =M-RET= ::
1102       Once the time list has been initiated, you can also use the
1103       normal item-creating command to insert the next timer item.
1105     - =C-c C-x 0= :: 
1106       Reset the timer without inserting anything into the buffer.
1107       By default, the timer is reset to 0.  When called with a
1108       =C-u= prefix, reset the timer to specific starting
1109       offset.  The user is prompted for the offset, with a
1110       default taken from a timer string at point, if any, So this
1111       can be used to restart taking notes after a break in the
1112       process.  When called with a double prefix argument
1113       =C-c C-u=, change all timer strings in the active
1114       region by a certain amount.  This can be used to fix timer
1115       strings if the timer was not started at exactly the right
1116       moment.
1118     Thanks to Alan Dove, Adam Spiers, and Alan Davis for
1119     contributions to this idea.
1121 *** Special faces can be set for individual tags
1123     You may now use the variable =org-tag-faces= to define the
1124     face used for specific tags, much in the same way as you can
1125     do for TODO keywords.
1127     Thanks to Samuel Wales for this proposal.
1129 *** The agenda shows now all tags, including inherited ones.
1131     This request has come up often, most recently it was
1132     formulated by Tassilo Horn.
1134     If you prefer the old behavior of only showing the local
1135     tags, customize the variable =org-agenda-show-inherited-tags=.
1137 *** Exclude some tags from inheritance.
1139     So far, the only way to select tags for inheritance was to
1140     allow it for all tags, or to do a positive selection using
1141     one of the more complex settings for
1142     `org-use-tag-inheritance'.  It may actually be better to
1143     allow inheritance for all but a few tags, which was difficult
1144     to achieve with this methodology.
1146     A new option, `org-tags-exclude-from-inheritance', allows to
1147     specify an exclusion list for inherited tags.
1149 *** More special values for time comparisons in property searches
1151     In addition to =<now>=, =<today>=, =<yesterday>=, and
1152     =<tomorrow>=, there are more special values accepted now in
1153     time comparisons in property searches:  You may use strings
1154     like =<+3d>= or =<-2w>=, with units d, w, m, and y for day,
1155     week, month, and year, respectively
1157     Thanks to Linday Todd for this proposal.
1159 *** Control for exporting meta data
1161     All the metadata in a headline, i.e. the TODO keyword, the
1162     priority cookie, and the tags, can now be excluded from
1163     export with appropriate options:
1165     | Variable                      | Publishing property | OPTIONS switch |
1166     |-------------------------------+---------------------+----------------|
1167     | org-export-with-todo-keywords | :todo-keywords      | todo:          |
1168     | org-export-with-tags          | :tags               | tags:          |
1169     | org-export-with-priority      | :priority           | pri:           |
1171 *** Cut and Paste with hot links from w3m to Org
1173     You can now use the key =C-c C-x M-w= in a w3m buffer with
1174     HTML content to copy either the region or the entire file in
1175     a special way.  When you yank this text back into an Org-mode
1176     buffer, all links from the w3m buffer will continue to work
1177     under Org-mode.
1179     For this to work you need to load the new file /org-w3m.el./
1180     Please check your org-modules variable to make sure that this
1181     is turned on.
1183     Thanks for Richard Riley for the idea and to Andy Stewart for
1184     the implementation.
1186 *** LOCATION can be inherited for iCalendar export
1188     The LOCATION property can now be inherited during iCalendar
1189     export if you configure =org-use-property-inheritance= like
1190     this:
1192 #+begin_src emacs-lisp
1193 (setq org-use-property-inheritance '("LOCATION"))
1194 #+end_src
1196 * Version 6.13
1198 ** Overview
1200    - Keybindings in Remember buffers can be configured
1201    - Support for ido completion
1202    - New face for date lines in agenda column view
1203    - Invisible targets become now anchors in headlines.
1204    - New contributed file /org-exp-blocks.el/
1205    - New contributed file /org-eval-light.el/
1206    - Link translation
1207    - BBDB links may use regular expressions.
1208    - Link abbreviations can use %h to insert a url-encoded target value
1209    - Improved XHTML compliance
1211 ** Details
1213 *** Keybindings in Remember buffers can be configured
1215     The remember buffers created with Org's extensions are in
1216     Org-mode, which is nice to prepare snippets that will
1217     actually be stored in Org-mode files.  However, this makes it
1218     hard to configure key bindings without modifying the Org-mode
1219     keymap.  There is now a minor mode active in these buffers,
1220     `org-remember-mode', and its keymap org-remember-mode-map can
1221     be used for key bindings.  By default, this map only contains
1222     the bindings for =C-c C-c= to store the note, and =C-c C-k=
1223     to abort it.  Use `org-remember-mode-hook' to define your own
1224     bindings like
1226 #+begin_src emacs-lisp
1227 (add-hook
1228  'org-remember-mode-hook
1229  (lambda ()
1230    (define-key org-remember-mode-map
1231      "\C-x\C-s" 'org-remember-finalize)))
1232 #+end_src
1234     If you wish, you can also use this to free the =C-c C-c=
1235     binding (by binding this key to nil in the minor mode map),
1236     so that you can use =C-c C-c= again to set tags.
1238     This modification is based on a request by Tim O'Callaghan.
1240 *** Support for ido completion
1242     You can now get the completion interface from /ido.el/ for
1243     many of Org's internal completion commands by turning on the
1244     variable =org-completion-use-ido=. =ido-mode= must also be
1245     active before you can use this.
1247     This change is based upon a request by Samuel Wales.
1249 *** New face for date lines in agenda column view
1251     When column view is active in the agenda, and when you have
1252     summarizing properties, the date lines become normal column
1253     lines and the separation between different days becomes
1254     harder to see.  If this bothers you, you can now customize
1255     the face =org-agenda-column-dateline=.
1257     This is based on a request by George Pearson.
1259 *** Invisible targets become now anchors in headlines.
1261     These anchors can be used to jump to a directly with an HTML
1262     link, just like the =sec-xxx= IDs.  For example, the
1263     following will make a http link
1264     =//domain/path-to-my-file.html#dummy= work:
1266 #+begin_src org
1267 ,# <<dummy>>
1268 ,*** a headline
1269 #+end_src
1271     This is based on a request by Matt Lundin.
1273 *** New contributed file /org-exp-blocks.el/
1275     This new file implements special export behavior of
1276     user-defined blocks.  The currently supported blocks are
1278     - comment :: Comment blocks with author-specific markup
1279     - ditaa ::  conversion of ASCII art into pretty png files
1280          using Stathis  Sideris' /ditaa.jar/ program
1281     - dot :: creation of graphs in the /dot/ language
1282     - R :: Sweave type exporting using the R program
1284     For more details and examples, see the file commentary in
1285     /org-exp-blocks.el/.
1287     Kudos to Eric Schulte for this new functionality, after
1288     /org-plot.el/ already his second major contribution.  Thanks
1289     to Stathis for this excellent program, and for allowing us to
1290     bundle it with Org-mode.
1292 *** New contributed file /org-eval-light.el/
1294     This module gives control over execution Emacs Lisp code
1295     blocks included in a file.
1297     Thanks to Eric Schulte also for this file.
1299 *** Link translation
1301     You can now configure Org to understand many links created
1302     with the Emacs Planner package, so you can cut text from
1303     planner pages and paste them into Org-mode files without
1304     having to re-write the links.  Among other things, this means
1305     that the command =org-open-at-point-global= which follows
1306     links not only in Org-mode, but in arbitrary files like
1307     source code files etc, will work also with links created by
1308     planner. The following customization is needed to make all of
1309     this work
1311 #+begin_src emacs-lisp
1312 (setq org-link-translation-function
1313       'org-translate-link-from-planner)
1314 #+end_src
1316    I guess an inverse translator could be written and integrated
1317    into Planner.
1319 *** BBDB links may use regular expressions.
1321     This did work all along, but only now I have documented it.
1323 *** =yank-pop= works again after yanking an outline tree
1325     Samuel Wales had noticed that =org-yank= did mess up this
1326     functionality.  Now you can use =yank-pop= again, the only
1327     restriction is that the so-yanked text will not be
1328     pro/demoted or folded.
1330 *** Link abbreviations can use %h to insert a url-encoded target value
1332     Thanks to Steve Purcell for a patch to this effect.
1334 *** Improved XHTML compliance
1336     Thanks to Sebastian Rose for pushing this.
1338 *** Many bug fixes again.
1339     
1340 * Version 6.12
1341 ** Overview
1343    - A region of entries can now be refiled with a single command
1344    - Fine-tuning the behavior of `org-yank'
1345    - Formulas for clocktables
1346    - Better implementation of footnotes for HTML export
1347    - More languages for HTML export.
1349 ** Details
1351 *** A region of entries can now be refiled with a single command
1352     
1353     With =transient-make-mode= active (=zmacs-regions= under
1354     XEmacs), you can now select a region of entries and refile
1355     them all with a single =C-c C-w= command.
1357     Thanks to Samuel Wales for this useful proposal.
1359 *** Fine-tuning the behavior of =org-yank=
1361     The behavior of Org's yanking command has been further
1362     fine-tuned in order to avoid some of the small annoyances
1363     this command caused.
1365     - Calling =org-yank= with a prefix arg will stop any special
1366       treatment and directly pass through to the normal =yank=
1367       command.  Therefore, you can now force a normal yank with
1368       =C-u C-y=.
1370     - Subtrees will only be folded after a yank if doing so will
1371       now swallow any non-white characters after the yanked text.
1372       This is, I think a really important change to make the
1373       command work more sanely.
1375 *** Formulas for clocktables
1377     You can now add formulas to a clock table, either by hand, or
1378     with a =:formula= parameter.  These formulas can be used to
1379     create additional columns with further analysis of the
1380     measured times.
1382     Thanks to Jurgen Defurne for triggering this addition.
1384 *** Better implementation of footnotes for HTML export
1385     
1386     The footnote export in 6.11 really was not good enough.  Now
1387     it works fine.  If you have customized
1388     =footnote-section-tag=, make sure that your customization is
1389     matched by =footnote-section-tag-regexp=.
1391     Thanks to Sebastian Rose for pushing this change.
1393 *** More languages for HTML export.
1395     More languages are supported during HTML export.  This is
1396     only relevant for the few special words Org inserts, like
1397     "Table of Contents", or "Footnotes".  Also the encoding
1398     issues with this feature seem to be solved now.
1400     Thanks to Sebastian Rose for pushing me to fix the encoding
1401     problems.
1403 * Version 6.11
1405 ** Overview
1407    - Yanking subtree with =C-y= now adjusts the tree level
1408    - State changes can now be shown in the log mode in the agenda
1409    - Footnote in HTML export are now collected at the end of the document
1410    - HTML export now validates again as XHTML
1411    - The clock can now be resumed after exiting and re-starting Emacs
1412    - Clock-related data can be saved and resumed across Emacs sessions
1413    - Following file links can now use C-u C-u to force use of an external app
1414    - Inserting absolute files names now abbreviates links with "~"
1415    - Links to attachment files
1416    - Completed repeated tasks listed briefly in agenda
1417    - Remove buffers created during publishing are removed
1419 ** Details
1421 *** Yanking subtree with =C-y= now adjusts the tree level
1422     When yanking a cut/copied subtree or a series of trees, the
1423     normal yank key =C-y= now adjusts the level of the tree to
1424     make it fit into the current outline position, without losing
1425     its identity, and without swallowing other subtrees.
1427     This uses the command =org-past-subtree=.  An additional
1428     change in that command has been implemented: Normally, this
1429     command picks the right outline level from the surrounding
1430     *visible* headlines, and uses the smaller one.  So if the
1431     cursor is between a level 4 and a level 3 headline, the tree
1432     will be pasted as level 3.  If the cursor is actually *at*
1433     the beginning of a headline, the level of that headline will
1434     be used.  For example, lets say you have a tree like this:
1436 #+begin_src org
1437 ,* Level one
1438 ,** Level two
1439 ,(1)
1440 ,(2)* Level one again
1441 #+end_src
1443     with (1) and (2) indicating possible cursor positions for the
1444     insertion.  When at (1), the tree will be pasted as level 2.
1445     When at (2), it will be pasted as level 1.
1447     If you do not want =C-y= to behave like this, configure the
1448     variable =org-yank-adjusted-subtrees=.
1450     Thanks to Samuel Wales for this idea and a partial implementation.
1452 *** State changes can now be shown in the log mode in the agenda
1454     If you configure the variable =org-agenda-log-mode-items=,
1455     you can now request that all logged state changes be included
1456     in the agenda when log mode is active.  If you find this too
1457     much for normal applications, you can also temporarily
1458     request the inclusion of state changes by pressing =C-u l= in
1459     the agenda.
1461     This was a request by Hsiu-Khuern Tang.
1463     You can also press `C-u C-u l' to get *only* log items in the
1464     agenda, withour any timestamps/deadlines etc.
1466 *** Footnote in HTML export are now collected at the end of the document
1467     Previously, footnotes would be left in the document where
1468     they are defined, now they are all collected and put into a
1469     special =<div>= at the end of the document.
1471     Thanks to Sebastian Rose for this request.
1473 *** HTML export now validates again as XHTML.
1475     Thanks to Sebastian Rose for pushing this cleanup.
1477 *** The clock can now be resumed after exiting and re-starting Emacs
1479     If the option =org-clock-in-resume= is t, and the first clock
1480     line in an entry is unclosed, clocking into that task resumes
1481     the clock from that time.
1483     Thanks to James TD Smith for a patch to this effect.
1485 *** Clock-related data can be saved and resumed across Emacs sessions
1486     
1487     The data saved include the contents of =org-clock-history=,
1488     and the running clock, if there is one.
1489     
1490     To use this, you will need to add to your .emacs
1492 #+begin_src emacs-lisp
1493 (setq org-clock-persist t)
1494 (setq org-clock-in-resume t)
1495 (org-clock-persistence-insinuate)
1496 #+end_src
1498     Thanks to James TD Smith for a patch to this effect.
1500 *** Following file links can now use C-u C-u to force use of an external app.
1502     So far you could only bypass your setup in `org-file-apps'
1503     and force opening a file link in Emacs by using a =C-u= prefix arg
1504     with =C-c C-o=.  Now you can call =C-u C-u C-c C-o= to force
1505     an external application.  Which external application depends
1506     on your system.  On Mac OS X and Windows, =open= is used.  On
1507     a GNU/Linux system, the mailcap settings are used.
1509     This was a proposal by Samuel Wales.
1511 *** Inserting absolute files names now abbreviates links with "~".
1513     Inserting file links with =C-u C-c C-l= was buggy if the
1514     setting of `org-link-file-path-type' was `adaptive' (the
1515     default).  Absolute file paths were not abbreviated relative
1516     to the users home directory.  This bug has been fixed.
1518     Thanks to Matt Lundin for the report.
1520 *** Links to attachment files
1522     Even though one of the purposes of entry attachments was to
1523     reduce the number of links in an entry, one might still want
1524     to have the occasional link to one of those files.  You can
1525     now use link abbreviations to set up a special link type that
1526     points to attachments in the current entry.  Note that such
1527     links will only work from within the same entry that has the
1528     attachment, because the directory path is entry specific.
1529     Here is the setup you need:
1531 #+begin_src emacs-lisp
1532 (setq org-link-abbrev-alist '(("att" . org-attach-expand-link)))
1533 #+end_src
1535     After this, a link like this will work
1537 #+BEGIN_EXAMPLE
1538      [[att:some-attached-file.txt]]
1539 #+END_EXAMPLE
1540     This was a proposal by Lindsay Todd.
1542 *** Completed repeated tasks listed briefly in agenda
1544     When a repeating task, listed in the daily/weekly agenda under
1545     today's date, is completed from the agenda, it is listed as
1546     DONE in the agenda until the next update happens.  After the
1547     next update, the task will have disappeared, of course,
1548     because the new date is no longer today.
1549     
1550 *** Remove buffers created during publishing are removed
1552     Buffers that are created during publishing are now deleted
1553     when the publishing is over.  At least I hope it works like this.
1555 * Version 6.10
1557 ** Overview
1559    - Secondary agenda filtering is becoming a killer feature
1560    - Setting tags has now its own binding, =C-c C-q=
1561    - Todo state changes can trigger tag changes
1562    - C-RET will now always insert a new headline, never an item.
1563    - Customize org-mouse.el feature set to free up mouse events
1564    - New commands for export all the way to PDF (through LaTeX)
1565    - Some bug fixed for LaTeX export, more bugs remain.
1567 ** Details
1569 *** Enhancements to secondary agenda filtering
1571     This is, I believe, becoming a killer feature.  It allows you
1572     to define fewer and more general custom agenda commands, and
1573     then to do the final narrowing to specific tasks you are
1574     looking for very quickly, much faster than calling a new
1575     agenda command.
1577     If you have not tries this yet, you should!
1579 **** You can now refining the current filter by an additional criterion
1580       When filtering an existing agenda view with =/=, you can
1581       now narrow down the existing selection by an additional
1582       condition.  Do do this, use =\= instead of =/= to add the
1583       additional criterion.  You can also press =+= or =-= after
1584       =/= to add a positive or negative condition.  A condition
1585       can be a TAG, or an effort estimate limit, see below.
1587 **** It is now possible to filter for effort estimates
1588      This means to filter the agenda for the value of the Effort
1589      property.  For this you should best set up global allowed
1590      values for effort estimates, with
1592 #+begin_src emacs-lisp
1593 (setq org-global-properties
1594       '(("Effort_ALL" . "0 0:10 0:30 1:00 2:00 3:00 4:00")))
1595 #+end_src
1596       
1597      You may then select effort limits with single keys in the
1598      filter.  It works like this:  After =/= or =\=, first select
1599      the operator which you want to use to compare effort
1600      estimates:
1602      : <   Select entries with effort smaller than or equal to the limit
1603      : >   Select entries with effort larger than or equal to the limit
1604      : =   Select entries with effort equal to the limit
1606      After that, you can press a single digit number which is
1607      used as an index to the allowed effort estimates.
1609      If you do not use digits to fast-select tags, you can even
1610      skip the operator, which will then default to
1611      `org-agenda-filter-effort-default-operator', which is by
1612      default =<=.
1614      Thanks to Manish for the great idea to include fast effort
1615      filtering into the agenda filtering process.
1617 **** The mode line will show the active filter
1618      For example, if there is a filter in place that does select
1619      for HOME tags, against EMAIL tags, and for tasks with an
1620      estimated effort smaller than 30 minutes, the mode-line with
1621      show =+HOME-EMAIL+<0:30=
1623 **** The filter now persists when the agenda view is refreshed
1624      All normal refresh commands, including those that move the
1625      weekly agenda from one week to the next, now keep the
1626      current filter in place.
1628      You need to press =/ /= to turn off the filter.  However,
1629      when you run a new agenda command, for example going from
1630      the weekly agenda to the TODO list, the filter will be
1631      switched off.
1632    
1633 *** Setting tags has now its own binding, =C-c C-q=
1635     You can still use =C-c C-c= on a headline, but the new
1636     binding should be considered as the main binding for this
1637     command.  The reasons for this change are:
1639     - Using =C-c C-c= for tags is really out of line with other
1640       uses of =C-c C-c=.
1642     - I hate it in Remember buffers when I try to set tags and I
1643       cannot, because =C-c C-c= exits the buffer :-(
1645     - =C-c C-q= will also work when the cursor is somewhere down
1646       in the entry, it does not have to be on the headline.
1648 *** Todo state changes can trigger tag changes
1650     The new option =org-todo-state-tags-triggers= can be used to
1651     define automatic changes to tags when a TODO state changes.
1652     For example, the setting
1654     : (setq org-todo-state-tags-triggers
1655     :       '((done ("Today" . nil) ("NEXT" . nil))
1656     :         ("WAITING" ("Today" . t))))    
1658     will make sure that any change to any of the DONE states will
1659     remove tags "Today" and "NEXT", while switching to the
1660     "WAITING" state will trigger the tag "Today" to be added.
1662     I use this mostly to get rid of TODAY and NEXT tags which I
1663     apply to select an entry for execution in the near future,
1664     which I often prefer to specific time scheduling.
1666 *** C-RET will now always insert a new headline, never an item.
1667     The new headline is inserted after the current subtree.
1669     Thanks to Peter Jones for patches to fine-tune this behavior.
1671 *** Customize org-mouse.el feature set
1672     There is a new variable =org-mouse-features= which gives you
1673     some control about what features of org-mouse you want to
1674     use.  Turning off some of the feature will free up the
1675     corresponding mouse events, or will avoid activating special
1676     regions for mouse clicks.  By default I have urned off the
1677     feature to use drag mouse events to move or promote/demote
1678     entries.  You can of course turn them back on if you wish.
1680     This variable may still change in the future, allowing more
1681     fine-grained control.
1683 *** New commands for export to PDF
1685     This is using LaTeX export, and then processes it to PDF
1686     using pdflatex.
1688     : C-c C-e p     process to PDF.
1689     : C-c C-e d     process to PDF, and open the file.
1691 *** LaTeX export
1692     - \usepackage{graphicx} is now part of the standard class
1693       definitions.
1694     - Several bugs fixed, but definitely not all of them :-(
1696 *** New option `org-log-state-notes-insert-after-drawers'
1698     Set this to =t= if you want state change notes to be inserted
1699     after any initial drawers, i.e drawers the immediately follow
1700     the headline and the planning line (the one with
1701     DEADLINE/SCHEDULED/CLOSED information).
1703 * Version 6.09
1704 ** Incompatible
1705 *** =org-file-apps= now uses regular expressions, see [[*%20org%20file%20apps%20now%20uses%20regular%20repressions%20instead%20of%20extensions][below]]
1707 ** Details
1709 *** =org-file-apps= now uses regular repressions instead of extensions
1710     Just like in =auto-mode-alist=, car's in the variable
1711     =org-file-apps= that are strings are now interpreted as
1712     regular expressions that are matched against a file name.  So
1713     instead of "txt", you should now write "\\.txt\\'" to make
1714     sure the matching is done correctly (even though "txt" will
1715     be recognized and still be interpreted as an extension).
1717     There is now a shortcut to get many file types visited by
1718     Emacs.  If org-file-apps contains `(auto-mode . emacs)', then
1719     any files that are matched by `auto-mode-alist' will be
1720     visited in emacs.
1722 *** Changes to the attachment system
1724     - The default method to attach a file is now to copy it
1725       instead of moving it.
1726     - You can modify the default method using the variable
1727       `org-attach-method'.  I believe that most Unix people want
1728       to set it to `ln' to create hard links.
1729     - The keys =c=, =m=, and =l= specifically select =copy=,
1730       =move=, or =link=, respectively, as the attachment method
1731       for a file, overruling  `org-attach-method'.
1732     - To create a new attachment as an Emacs buffer, you have not
1733       now use =n= instead of =c=.
1734     - The file list is now always retrieved from the directory
1735       itself, not from the "Attachments" property.  We still
1736       keep this property by default, but you can turn it off, by
1737       customizing the variable =org-attach-file-list-property=.
1739 * Version 6.08
1741 ** Incompatible changes
1743    - Changes in the structure of IDs, see [[*The%20default%20structure%20of%20IDs%20has%20changed][here]] for details.
1745    - C-c C-a has been redefined, see [[*%20C%20c%20C%20a%20no%20longer%20calls%20show%20all][here]] for details.
1747 ** Details
1749 *** The default structure of IDs has changed
1751     IDs created by Org have changed a bit:
1752     - By default, there is no prefix on the ID.  There used to be
1753       an "Org" prefix, but I now think this is not necessary.
1754     - IDs use only lower-case letters, no upper-case letters
1755       anymore.  The reason for this is that IDs are now also used
1756       as directory names for org-attach, and some systems do not
1757       distinguish upper and lower case in the file system.
1758     - The ID string derived from the current time is now
1759       /reversed/ to become an ID.  This assures that the first
1760       two letters of the ID change fast, so hat it makes sense to
1761       split them off to create subdirectories to balance load.
1762     - You can now set the `org-id-method' to `uuidgen' on systems
1763       which support it.
1765 *** =C-c C-a= no longer calls `show-all'
1767     The reason for this is that =C-c C-a= is now used for the
1768     attachment system.  On the rare occasions that this command
1769     is needed, use =M-x show-all=, or =C-u C-u C-u TAB=.
1771 *** New attachment system
1773     You can now attach files to each node in the outline tree.
1774     This works by creating special directories based on the ID of
1775     an entry, and storing files in these directories.  Org can
1776     keep track of changes to the attachments by automatically
1777     committing changes to git.  See the manual for more
1778     information.
1780     Thanks to John Wiegley who contributed this fantastic new
1781     concept and wrote org-attach.el to implement it.
1783 *** New remember template escapes
1785     : %^{prop}p   to insert a property
1786     : %k          the heading of the item currently being clocked
1787     : %K          a link to the heading of the item currently being clocked
1789     Also, when you exit remember with =C-2 C-c C-c=, the item
1790     will be filed as a child of the item currently being
1791     clocked.  So the idea is, if you are working on something and
1792     think of a new task related to this or a new note to be
1793     added, you can use this to quickly add information to that
1794     task.
1796     Thanks to James TD Smith for a patch to this effect.
1798 *** Clicking with mouse-2 on clock info in mode-line visits the clock.
1799     
1800     Thanks to James TD Smith for a patch to this effect.
1802 *** New file in contrib: lisp/org-checklist.el
1804     This module deals with repeated tasks that have checkbox
1805     lists below them.
1807     Thanks to James TD Smith for this contribution.
1809 *** New in-buffer setting #+STYLE
1811     It can be used to locally set the variable
1812     `org-export-html-style-extra'.  Several such lines are
1813     allowed-, they will all be concatenated.  For an example on
1814     how to use it, see the [[http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php][publishing tutorial]].
1816 * Version 6.07
1818 ** Overview
1820    - Filtering existing agenda views with respect to a tag
1821    - Editing fixed-width regions with picture or artist mode
1822    - /org-plot.el/ is now part of Org
1823    - Tags can be used to select the export part of a document
1824    - Prefix interpretation when storing remember notes
1825    - Yanking inserts folded subtrees
1826    - Column view capture tables can have formulas, plotting info
1827    - In column view, date stamps can be changed with S-cursor keys
1828    - The note buffer for clocking out now mentions the task
1829    - Sorting entries alphabetically ignores TODO keyword and priority
1830    - Agenda views can sort entries by TODO state
1831    - New face =org-scheduled= for entries scheduled in the future.
1832    - Remember templates for gnus links can use the :to escape.
1833    - The file specification in a remember template may be a function
1834    - Categories in iCalendar export include local tags
1835    - It is possible to define filters for column view
1836    - Disabling integer increment during table Field copy
1837    - Capturing column view is on `C-c C-x i'
1838    - And tons of bugs fixed.  
1841 ** Incompatible changes
1843 *** Prefix interpretation when storing remember notes has changed
1845     The prefix argument to the `C-c C-c' command that finishes a
1846     remember process is now interpreted differently:
1848     : C-c C-c       Store the note to predefined file and headline
1849     : C-u C-c C-c   Like C-c C-c, but immediately visit the note
1850     :               in its new location.
1851     : C-1 C-c C-c   Select the storage location interactively
1852     : C-0 C-c C-c   Re-use the last used location
1854     This was requested by John Wiegley.
1856 *** Capturing column view is now on `C-c C-x i'
1858     The reason for this change was that `C-c C-x r' is also used
1859     as a tty key replacement.
1861 *** Categories in iCalendar export now include local tags
1863     The locally defined tags are now listed as categories when
1864     exporting to iCalendar format.  Org's traditional file/tree
1865     category is now the last category in this list.  Configure
1866     the variable =org-icalendar-categories= to modify or revert
1867     this behavior.
1869     This was a request by Charles Philip Chan.
1871 ** Details
1873 *** Secondary filtering of agenda views.
1875     You can now easily and interactively filter an existing
1876     agenda view with respect to a tag.  This command is executed
1877     with the =/= key in the agenda.  You will be prompted for a
1878     tag selection key, and all entries that do not contain or
1879     inherit the corresponding tag will be hidden.  With a prefix
1880     argument, the opposite filter is applied: entries that
1881     do have the tag will be hidden.
1883     This operation only /hides/ lines in the agenda buffer, it
1884     does not remove them.  Changing the secondary filtering does
1885     not require a new search and is very fast.
1887     If you press TAB at the tag selection prompt, you will be
1888     switched to a completion interface to select a tag.  This is
1889     useful when you want to select a tag that does not have a
1890     direct access character.
1892     A double =/ /= will restore the original agenda view by
1893     unhiding any hidden lines.
1895     This functionality was John Wiegley's idea.  It is a simpler
1896     implementation of some of the query-editing features proposed
1897     and implemented some time ago by Christopher League (see the
1898     file contrib/lisp/org-interactive-query.el).
1900 *** Editing fixed-width regions with picture or artist mode
1902     The command @<code>C-c '@</code> (that is =C-c= followed by a
1903     single quote) can now also be used to switch to a special
1904     editing mode for fixed-width sections.  The default mode is
1905     =artist-mode= which allows you to create ASCII drawings.
1907     It works like this: Enter the editing mode with
1908     @<code>C-c '@</code>.  An indirect buffer will be created and
1909     narrowed to the fixed-width region.  Edit the drawing, and
1910     press @<code>C-c '@</code> again to exit.
1912     Lines in a fixed-width region should be preceded by a colon
1913     followed by at least one space.  These will be removed during
1914     editing, and then added back when you exit the editing mode.
1916     Using the command in an empty line will create a new
1917     fixed-width region.
1919     This new feature arose from a discussion involving Scott
1920     Otterson, Sebastian Rose and Will Henney.
1922 *** /org-plot.el/ is now part of Org.
1924     You can run it by simple calling org-plot/gnuplot.
1925     Documentation is not yet included with Org, please refer to
1926     http://github.com/eschulte/org-plot/tree/master until we have
1927     moved the docs into Org or Worg.
1929     Thanks to Eric Schulte for this great contribution.
1931 *** Tags can be used to select the export part of a document
1933     You may now use tags to select parts of a document for
1934     inclusion into the export, and to exclude other parts.  This
1935     behavior is governed by two new variables:
1936     =org-export-select-tags= and =org-export-exclude-tags=.
1937     These default to =("export")= and =("noexport")=, but can be
1938     changed, even to include a list of several tags.
1940     Org first checks if any of the /select/ tags is present in
1941     the buffer.  If yes, all trees that do not carry one of these
1942     tags will be excluded.  If a selected tree is a subtree, the
1943     heading hierarchy above it will also be selected for export,
1944     but not the text below those headings.  If none of the select
1945     tags is found anywhere in the buffer, the whole buffer will
1946     be selected for export.  Finally, all subtrees that are
1947     marked by any of the /exclude/ tags will be removed from the
1948     export buffer.
1950     You may set these tags with in-buffer options
1951     =EXPORT_SELECT_TAGS= and =EXPORT_EXCLUDE_TAGS=.
1953     I love this feature.  Thanks to Richard G Riley for coming
1954     up with the idea.
1956 *** Prefix interpretation when storing remember notes
1958     The prefix argument to the `C-c C-c' command that finishes a
1959     remember process is now interpreted differently:
1961     : C-c C-c       Store the note to predefined file and headline
1962     : C-u C-c C-c   Like C-c C-c, but immediately visit the note
1963     :               in its new location.
1964     : C-1 C-c C-c   Select the storage location interactively
1965     : C-0 C-c C-c   Re-use the last used location
1967     This was requested by John Wiegley.
1969 *** Yanking inserts folded subtrees
1971     If the kill is a subtree or a sequence of subtrees, yanking
1972     them with =C-y= will leave all the subtrees in a folded
1973     state.  This basically means, that kill and yank are now
1974     much more useful in moving stuff around in your outline.  If
1975     you do not like this, customize the variable
1976     =org-yank-folded-subtrees=.
1978     Right now, I am only binding =C-y= to this new function,
1979     should I modify all bindings of yank?  Do we need to amend
1980     =yank-pop= as well?
1982     This feature was requested by John Wiegley.
1984 *** Column view capture tables can have formulas, plotting info
1986     If you attach formulas and plotting instructions to a table
1987     capturing column view, these extra lines will now survive an
1988     update of the column view capture, and any formulas will be
1989     re-applied to the captured table.  This works by keeping any
1990     continuous block of comments before and after the actual
1991     table.
1993 *** In column view, date stamps can be changed with S-cursor keys
1995     If a property value is a time stamp, S-left and S-right can
1996     now be used to shift this date around while in column view.
1998     This was a request by Chris Randle.
2000 *** The note buffer for clocking out now mentions the task
2001     
2002     This was a request by Peter Frings.
2004 *** Sorting entries alphabetically ignores TODO keyword and priority
2006     Numerical and alphanumerical sorting now skips any TODO
2007     keyword or priority cookie when constructing the comparison
2008     string.  This was a request by Wanrong Lin.
2010 *** Agenda views can sort entries by TODO state
2012     You can now define a sorting strategy for agenda entries that
2013     does look at the TODO state of the entries.  Sorting by TODO
2014     entry does first separate the non-done from the done states.
2015     Within each class, the entries are sorted not alphabetically,
2016     but in definition order.  So if you have a sequence of TODO
2017     entries defined, the entries will be sorted according to the
2018     position of the keyword in this sequence.
2020     This follows an idea and sample implementation by Christian
2021     Egli.
2023 *** New face =org-scheduled= for entries scheduled in the future.
2025     This was a request by Richard G Riley.
2027 *** Remember templates for gnus links can now use the :to escape.
2029     Thanks to Tommy Lindgren for a patch to this effect.
2030 *** The file specification in a remember template may now be a function
2032     Thanks to Gregory Sullivan for a patch to this effect.
2034 *** Categories in iCalendar export now include local tags
2036     The locally defined tags are now listed as categories when
2037     exporting to iCalendar format.  Org's traditional file/tree
2038     category is now the last category in this list.  Configure
2039     the variable =org-icalendar-categories= to modify or revert
2040     this behavior.
2042     This was a request by Charles Philip Chan.
2044 *** It is now possible to define filters for column view
2046     The filter can modify the value that will be displayed in a
2047     column, for example it can cut out a part of a time stamp.
2048     For more information, look at the variable
2049     =org-columns-modify-value-for-display-function=.
2051 *** Disabling integer increment during table field copy
2053     Prefix arg 0 to S-RET does the trick.
2055     This was a request by Chris Randle.
2058 * Older changes
2060   For older Changes, see [[file:Changes_old.org]]
2063