Export: New hooks for preprocessing
[org-mode.git] / ORGWEBPAGE / Changes.org
blob03536cf9a9589da9f51d9cf0154b529ebed792cd
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.17 (in preparation)
15 ** Details
17 *** Built-in footnote support
19 Org-mode now supports the creation of footnotes.  In contrast to the
20 `footnote.el' package, Org-mode's footnotes are designed for work on a
21 larger document, not only for one-off documents like emails.  The basic
22 syntax is similar to the one used by `footnote.el', i.e. a footnote is
23 defined in a paragraph that is started by a footnote marker in square
24 brackets in column 0, no indentation allowed.  The footnote
25 reference is simply the marker in square brackets inside text.
26 For example:
28 #+begin_src org
29  The Org homepage[1] now looks a lot better than it used to.
30  ...
31  [1] The link is: http://orgmode.org
32 #+end_src
34    Org-mode extends the number-based syntax to _named_ footnotes and
35 optional inline definition.  Using numbers as markers is supported for
36 backward compatibility.  Here are the valid references:
38 - [1] ::  A numeric footnote marker.
39          
40 - [fn:name] :: A named footnote reference, where `name' is a
41      unique label word. 
42      
43 - [fn:: This is the inline definition of this footnote] ::
44      A LaTeX-like anonymous footnote where the definition is given
45      directly at the reference point.
47 - [fn:name: a definition] ::
48      An inline definition of a footnote, which also specifies a name
49      for the note.  Since Org allows multiple references to the same
50      note, you can then use use `[fn:name]' to create additional
51      references.
53 The following command handles footnotes:
55 - C-c C-x f ::
56      The footnote action command.  When the cursor is on a footnote
57      reference, jump to the definition.  When it is at a definition,
58      jump to the (first) reference.  Otherwise, create a new footnote.
59      Depending on the variable `org-footnote-define-inline' (with
60      associated #+STARTUP options fninline and nofninline), the
61      definitions will be placed locally, or into the nearest outline
62      section with the heading `Footnotes'.  If no such section is found
63      after the reference point, one will be created at the end of the
64      file.
65      When this command is called with a prefix argument, a menu of
66      additional options is offered:
67      - s :: Sort the footnote definitions by reference sequence.
68             During editing, Org makes no effort to sort
69             footnote definitions into a particular sequence.
70             If you want them sorted, use this command. 
71      - n :: Normalize the footnotes by collecting all
72             definitions (including inline definitions) into a
73             special section, and then numbering them in
74             sequence.  The references will then also be
75             numbers.  This is meant to be the final step before
76             finishing a document (e.g. sending off an email).
77             The exporters do this automatically, and so could 
78             something like `message-send-hook'.
79      - d :: Delete the footnote at point, and all references to it.
80      
81 - C-c C-c ::
82      If the cursor is on a footnote reference, jump to the definition.
83      If it is a the definition, jump back to the reference.  When
84      called with a prefix argument at either location, offer the
85      same menu as `C-u C-c C-x f'.
87 Org-mode's footnote support is designed so that it should also
88 work in buffers that are not in Org-mode, for example in email
89 messages.  Just bind =org-footnote-action= to a global key like
90 =C-c f=.
92 The main trigger for this development came from a hook function
93 written by Paul Rivier, to implement named footnotes and to
94 convert them to numbered ones before export.  Thanks, Paul!
96 *** Line numbers and references in literal examples
98 Literal examples introduced with =#+BEGIN_EXAMPLE= or =#+BEGIN_SRC=
99 do now allow optional line numbering in the example.
100 Furthermore, links to specific code lines are supported, greatly
101 increasing Org-mode utility for writing tutorials and other
102 similar documents.
104 Code references use special labels embedded directly into the
105 source code.  Such labels look like "((name))" and must be unique
106 within a document.  Org-mode links with the coderef cookie in the
107 link part will be correctly interpreted, both while working with
108 an Org file (internal links), and while exporting to the
109 different backends.  Line numbering and code references are
110 supported for all three major backends, HTML, LaTeX, and ASCII.
111 In the HTML backend, hovering the mouse over a link to a source
112 line will remote-highlight the referenced code line.
114 The options for the BEGIN lines are:
116  - -n :: Number the lines in the example
117  - +n :: Like -n, but continue numbering from where the previous
118          example left off.
119  - -r :: Remove the coderef cookies from the example, and replace
120          links to this reference with line numbers.  This option
121          takes only effect if either -n or +n are given as well.
122          If -r is not given, coderefs simply use the label name.
123          
124 Here is an example:
126 #+begin_example -k
127 #+begin_src emacs-lisp -n -r
128 (defmacro org-unmodified (&rest body)                   ((def))
129   "Execute body without changing `buffer-modified-p'."
130   `(set-buffer-modified-p                               ((back))
131     (prog1 (buffer-modified-p) ,@body)))
132 #+end_src
133 [[((def))][Line ((def))]] contains the macro name.  Later at line [[((back))]],
134 backquoting is used.
135 #+end_example
137 When exported, this is translated to:
138 #+begin_src emacs-lisp -n -r
139 (defmacro org-unmodified (&rest body)                   ((def))
140   "Execute body without changing `buffer-modified-p'."
141   `(set-buffer-modified-p                               ((back))
142     (prog1 (buffer-modified-p) ,@body)))
143 #+end_src
144 [[((def))][Line ((def))]] contains the macro name.  Later at line [[((back))]],
145 backquoting is used.
147 Thanks to Ilya Shlyakhter for proposing this feature set.  Thanks
148 to Sebastian Rose for the key Javascript element that made the
149 remote highlighting possible.
151 *** New hooks for export preprocessing
152     The export preprocessor now runs more hooks, to allow
153     better-timed tweaking by user functions:
155 - =org-export-preprocess-hook= ::
156   Pretty much the first thing in the preprocessor.  But org-mode
157   is already active in the preprocessing buffer.
159 - =org-export-preprocess-after-include-files-hook= ::
160   This is run after the contents of included files have been inserted.
162 - =org-export-preprocess-after-tree-selection-hook= ::
163   This is run after selection of trees to be exported has
164   happened.  This selection includes tags-based selection, as
165   well as removal of commented and archived trees.
167 - =org-export-preprocess-before-backend-specifics-hook= ::
168   Hook run before backend-specific functions are called during preprocessing.
170 - =org-export-preprocess-final-hook= ::
171   Hook for preprocessing an export buffer.  This is run as the
172   last thing in the preprocessing buffer, just before returning
173   the buffer string to the backend.
175 *** Capture column view into a different file.
177     The :id parameter for the dynamic block capturing column view
178     can now truly be an ID that will also be found in a
179     different file.  Also, it can be like =file:path/to/file=, to
180     capture the global column view from a different file.
182     Thanks to Francois Lagarde for his report that IDs outside
183     the current file would not work.
185 * Version 6.16
186   :PROPERTIES:
187   :VISIBILITY: content
188   :END:
189   Cleanup of many small bugs, and one new feature.
191 ** Details
193 *** References to last table row with special names
195     Fields in the last row of a table can now be referenced with
196     $LR1, $LR2, etc.  These references can appear both on the
197     left hand side and right hand side of a formula.
199 * Version 6.15f
201   This version reverses the introduction of @0 as a reference to
202   the last rwo in a table, because of a conflict with the use of
203   @0 for the current row.
205 * Version 6.15
206 ** Overview
208 - All known LaTeX export issues fixed 
209 - Captions and attributes for figures and tables. 
210 - Better implementation for entry IDs 
211 - Spreadsheet references to the last table line. 
212 - Old syntax for link attributes abandoned 
214 ** Incompatible changes
215 *** Old syntax for link attributes abandoned
217 There used to be a syntax for setting link attributes for
218 HTML export by enclosing the attributes into double braces
219 and adding them to the link itself, like
221 #+begin_example
222 [[./img/a.jpg{{alt="an image"}}] ]
223 #+end_example
225 This syntax is not longer supported, use instead
227 #+begin_src org
228 ,#+ATTR_HTML: alt="an image"
229 [[./img/a.jpg] ]
230 #+end_src
232 ** Details
234 *** All known LaTeX export issues fixed
236 All the remaining issues with the LaTeX exporter have hopefully
237 been addressed in this release.  In particular, this covers
238 quoting of special characters in tables and problems with
239 exporting files where the headline is in the first line, or with
240 an active region.
242 *** Captions and attributes for figures and tables.
244 Tables, and Hyperlinks that represent inlined images, can now be
245 equipped with additional information that will be used during
246 export.  The information will be taken from the following special
247 lines in the buffer and apply to the first following table or
248 link.
250 - #+CAPTION: :: The caption of the image or table.  This string
251      should be processed according to the export backend, but
252      this is not yet done.
254 - #+LABEL: :: A label to identify the figure/table for cross
255      references.  For HTML export, this string will become the
256      ID for the ~<div class="figure">~ element that encapsulates
257      the image tag and the caption.  For LaTeX export, this
258      string will be used as the argument of a ~\label{...}~
259      macro.  These labels will be available for internal links
260      like ~[[label][Table] ]~.
262 - #+ATTR_HTML: :: Attributes for HTML export of image, to be
263      added as attributes into the ~<img...>~ tag.  This string
264      will not be processed, so it should have immediately the
265      right format.
267 - #+ATTR_LaTeX: :: Attributes for LaTeX export of images and
268      tables.\\
269      For /images/, this string is directly inserted into
270      the optional argument of the ~\includegraphics[...]{file}~
271      command, to specify scaling, clipping and other options.
272      This string will not be processed, so it should have
273      immediately the right format, like =width=5cm,angle=90=.\\       
274      For /tables/, this can currently contain the keyword
275      =longtable=, to request typesetting of the table using the
276      longtable package, which automatically distributes the table
277      over several pages if needed.  Also, the attributes line may
278      contain an alignment string for the tabular environment, like
279      =longtable,align=l|lrl=
281 For LaTeX export, if either a caption or a label is given, the element
282 will be exported as a float, i.e. wrapped into a figure or table
283 environment.
285 *** Better implementation for entry IDs
286     
287 Unique identifiers for entries can now be used more efficiently.
288 Internally, a hash array has replaced the alist used so far to
289 keep track of the files in which an ID is defined.  This makes it
290 quite fast to find an entry by ID.
292 There is a new link type which looks like this:
294 #+begin_example
295 id:GLOBALLY-UNIQUE-IDENTIFIER
296 #+end_example
298 This link points to a specific entry.  When you move the entry to
299 a different file, for example if you move it to an archive
300 file, the link will continue to work.
302 The file /org-id.el/ contains an API that can be used to write
303 code using these identifiers, including creating IDs and finding
304 them wherever they are.
306 Org has its own method to create unique identifiers, but if the system
307 has /uuidgen/ command installed (Mac's and Linux systems generally
308 do), it will be used by default (a change compared to the earlier
309 implmentation, where you explicitdly had to opt for uuidgen).  You can
310 also select the method by hand, using the variable =org-id-method=.
312 If the ID system ever gets confused about where a certain ID is, it
313 initiates a global scan of all agenda files with associated archives,
314 all files previously known containing any IDs, and all currently
315 visited Org-mode files to rebuild the hash.  You can also initiate
316 this by hand: =M-x org-id-update-id-locations=.  Running this command
317 will also dump into the =*Messages*= buffer information about any
318 duplicate IDs.  These should not exist, and Org will never /make/ the
319 same ID twice, but if you /copy/ an entry with its properties,
320 duplicate IDs will inevitably be produced.  Unfortunately, this is
321 unavoidable in a plain text system that allows you to edit the text in
322 arbitrary ways, and a portion of care on your side is needed to keep
323 this system clean.
325 The hash is stored in the file =~/.emacs.d/.org-id-locations=.
326 This is also a change from previous versions where the file was
327 =~/.org=id-locations=.  Therefore, you can remove this old file
328 if you have it.  I am not sure what will happen if the =.emacs.d=
329 directory does not exists in your setup, but in modern Emacsen, I
330 believe it should exist.  If you do not want to use IDs across
331 files, you can avoid the overhead with tracking IDs by
332 customizing the variable =org-id-track-globally=.  IDs can then
333 still be used for links inside a single file.
335 IDs will also be used when you create a new link to an Org-mode
336 buffer.  If you use =org-store-link= (normally at =C-c l=) inside
337 en entry in an Org-mode buffer, and ID property will be created
338 if it does not exist, and the stored link will be an =id:= link.
339 If you prefer the much less secure linking to headline text, you
340 can configure the variable =org-link-to-org-use-id=.  The default
341 setting for this variable is =create-if-interactive=, meaning
342 that an ID will be created when you store a link interactively,
343 but not if you happen to be in an Org-mode file while you create
344 a remember note (which usually has a link to the place where you
345 were when starting remember).
347 *** Spreadsheet references to the last table line.
349 You may now use =@0= to reference the last dataline in a table
350 in a stable way.  This is useful in particular for automatically
351 generated tables like the ones using /org-collector.el/ by Eric
352 Schulte.
354 * Version 6.14
355 ** Overview
357    - New relative timer to support timed notes 
358    - Special faces can be set for individual tags 
359    - The agenda shows now all tags, including inherited ones. 
360    - Exclude some tags from inheritance. 
361    - More special values for time comparisons in property searches 
362    - Control for exporting meta data 
363    - Cut and Paste with hot links from w3m to Org 
364    - LOCATION can be inherited for iCalendar export 
365    - Relative row references crossing hlines now throw an error 
367 ** Incompatible Changes
369 *** Relative row references crossing hlines now throw an error
370     
371     Relative row references in tables look like this: "@-4" which
372     means the forth row above this one.  These row references are
373     not allowed to cross horizontal separator lines (hlines).  So
374     far, when a row reference violates this policy, Org would
375     silently choose the field just next to the hline.
377     Tassilo Horn pointed out that this kind of hidden magic is
378     actually confusing and may cause incorrect formulas, and I do
379     agree.  Therefore, trying to cross a hline with a relative
380     reference will now throw an error.
381     
382     If you need the old behavior, customize the variable
383     `org-table-error-on-row-ref-crossing-hline'.
385 ** Details
387 *** New relative timer to support timed notes
389     Org now supports taking timed notes, useful for example while
390     watching a video, or during a meeting which is also recorded.
392     - =C-c C-x .= :: 
393       Insert a relative time into the buffer.  The first time
394       you use this, the timer will be started.  When called
395       with a prefix argument, the timer is reset to 0.
397     - =C-c C-x -= :: 
398       Insert a description list item with the current relative
399       time.  With a prefix argument, first reset the timer to 0.
401     - =M-RET= ::
402       Once the time list has been initiated, you can also use the
403       normal item-creating command to insert the next timer item.
405     - =C-c C-x 0= :: 
406       Reset the timer without inserting anything into the buffer.
407       By default, the timer is reset to 0.  When called with a
408       =C-u= prefix, reset the timer to specific starting
409       offset.  The user is prompted for the offset, with a
410       default taken from a timer string at point, if any, So this
411       can be used to restart taking notes after a break in the
412       process.  When called with a double prefix argument
413       =C-c C-u=, change all timer strings in the active
414       region by a certain amount.  This can be used to fix timer
415       strings if the timer was not started at exactly the right
416       moment.
418     Thanks to Alan Dove, Adam Spiers, and Alan Davis for
419     contributions to this idea.
421 *** Special faces can be set for individual tags
423     You may now use the variable =org-tag-faces= to define the
424     face used for specific tags, much in the same way as you can
425     do for TODO keywords.
427     Thanks to Samuel Wales for this proposal.
429 *** The agenda shows now all tags, including inherited ones.
431     This request has come up often, most recently it was
432     formulated by Tassilo Horn.
434     If you prefer the old behavior of only showing the local
435     tags, customize the variable =org-agenda-show-inherited-tags=.
437 *** Exclude some tags from inheritance.
439     So far, the only way to select tags for inheritance was to
440     allow it for all tags, or to do a positive selection using
441     one of the more complex settings for
442     `org-use-tag-inheritance'.  It may actually be better to
443     allow inheritance for all but a few tags, which was difficult
444     to achieve with this methodology.
446     A new option, `org-tags-exclude-from-inheritance', allows to
447     specify an exclusion list for inherited tags.
449 *** More special values for time comparisons in property searches
451     In addition to =<now>=, =<today>=, =<yesterday>=, and
452     =<tomorrow>=, there are more special values accepted now in
453     time comparisons in property searches:  You may use strings
454     like =<+3d>= or =<-2w>=, with units d, w, m, and y for day,
455     week, month, and year, respectively
457     Thanks to Linday Todd for this proposal.
459 *** Control for exporting meta data
461     All the metadata in a headline, i.e. the TODO keyword, the
462     priority cookie, and the tags, can now be excluded from
463     export with appropriate options:
465     | Variable                      | Publishing property | OPTIONS switch |
466     |-------------------------------+---------------------+----------------|
467     | org-export-with-todo-keywords | :todo-keywords      | todo:          |
468     | org-export-with-tags          | :tags               | tags:          |
469     | org-export-with-priority      | :priority           | pri:           |
471 *** Cut and Paste with hot links from w3m to Org
473     You can now use the key =C-c C-x M-w= in a w3m buffer with
474     HTML content to copy either the region or the entire file in
475     a special way.  When you yank this text back into an Org-mode
476     buffer, all links from the w3m buffer will continue to work
477     under Org-mode.
479     For this to work you need to load the new file /org-w3m.el./
480     Please check your org-modules variable to make sure that this
481     is turned on.
483     Thanks for Richard Riley for the idea and to Andy Stewart for
484     the implementation.
486 *** LOCATION can be inherited for iCalendar export
488     The LOCATION property can now be inherited during iCalendar
489     export if you configure =org-use-property-inheritance= like
490     this:
492 #+begin_src emacs-lisp
493 (setq org-use-property-inheritance '("LOCATION"))
494 #+end_src
496 * Version 6.13
498 ** Overview
500    - Keybindings in Remember buffers can be configured
501    - Support for ido completion
502    - New face for date lines in agenda column view
503    - Invisible targets become now anchors in headlines.
504    - New contributed file /org-exp-blocks.el/
505    - New contributed file /org-eval-light.el/
506    - Link translation
507    - BBDB links may use regular expressions.
508    - Link abbreviations can use %h to insert a url-encoded target value
509    - Improved XHTML compliance
511 ** Details
513 *** Keybindings in Remember buffers can be configured
515     The remember buffers created with Org's extensions are in
516     Org-mode, which is nice to prepare snippets that will
517     actually be stored in Org-mode files.  However, this makes it
518     hard to configure key bindings without modifying the Org-mode
519     keymap.  There is now a minor mode active in these buffers,
520     `org-remember-mode', and its keymap org-remember-mode-map can
521     be used for key bindings.  By default, this map only contains
522     the bindings for =C-c C-c= to store the note, and =C-c C-k=
523     to abort it.  Use `org-remember-mode-hook' to define your own
524     bindings like
526 #+begin_src emacs-lisp
527 (add-hook
528  'org-remember-mode-hook
529  (lambda ()
530    (define-key org-remember-mode-map
531      "\C-x\C-s" 'org-remember-finalize)))
532 #+end_src
534     If you wish, you can also use this to free the =C-c C-c=
535     binding (by binding this key to nil in the minor mode map),
536     so that you can use =C-c C-c= again to set tags.
538     This modification is based on a request by Tim O'Callaghan.
540 *** Support for ido completion
542     You can now get the completion interface from /ido.el/ for
543     many of Org's internal completion commands by turning on the
544     variable =org-completion-use-ido=. =ido-mode= must also be
545     active before you can use this.
547     This change is based upon a request by Samuel Wales.
549 *** New face for date lines in agenda column view
551     When column view is active in the agenda, and when you have
552     summarizing properties, the date lines become normal column
553     lines and the separation between different days becomes
554     harder to see.  If this bothers you, you can now customize
555     the face =org-agenda-column-dateline=.
557     This is based on a request by George Pearson.
559 *** Invisible targets become now anchors in headlines.
561     These anchors can be used to jump to a directly with an HTML
562     link, just like the =sec-xxx= IDs.  For example, the
563     following will make a http link
564     =//domain/path-to-my-file.html#dummy= work:
566 #+begin_src org
567 ,# <<dummy>>
568 ,*** a headline
569 #+end_src
571     This is based on a request by Matt Lundin.
573 *** New contributed file /org-exp-blocks.el/
575     This new file implements special export behavior of
576     user-defined blocks.  The currently supported blocks are
578     - comment :: Comment blocks with author-specific markup
579     - ditaa ::  conversion of ASCII art into pretty png files
580          using Stathis  Sideris' /ditaa.jar/ program
581     - dot :: creation of graphs in the /dot/ language
582     - R :: Sweave type exporting using the R program
584     For more details and examples, see the file commentary in
585     /org-exp-blocks.el/.
587     Kudos to Eric Schulte for this new functionality, after
588     /org-plot.el/ already his second major contribution.  Thanks
589     to Stathis for this excellent program, and for allowing us to
590     bundle it with Org-mode.
592 *** New contributed file /org-eval-light.el/
594     This module gives control over execution Emacs Lisp code
595     blocks included in a file.
597     Thanks to Eric Schulte also for this file.
599 *** Link translation
601     You can now configure Org to understand many links created
602     with the Emacs Planner package, so you can cut text from
603     planner pages and paste them into Org-mode files without
604     having to re-write the links.  Among other things, this means
605     that the command =org-open-at-point-global= which follows
606     links not only in Org-mode, but in arbitrary files like
607     source code files etc, will work also with links created by
608     planner. The following customization is needed to make all of
609     this work
611 #+begin_src emacs-lisp
612 (setq org-link-translation-function
613       'org-translate-link-from-planner)
614 #+end_src
616    I guess an inverse translator could be written and integrated
617    into Planner.
619 *** BBDB links may use regular expressions.
621     This did work all along, but only now I have documented it.
623 *** =yank-pop= works again after yanking an outline tree
625     Samuel Wales had noticed that =org-yank= did mess up this
626     functionality.  Now you can use =yank-pop= again, the only
627     restriction is that the so-yanked text will not be
628     pro/demoted or folded.
630 *** Link abbreviations can use %h to insert a url-encoded target value
632     Thanks to Steve Purcell for a patch to this effect.
634 *** Improved XHTML compliance
636     Thanks to Sebastian Rose for pushing this.
638 *** Many bug fixes again.
639     
640 * Version 6.12
641 ** Overview
643    - A region of entries can now be refiled with a single command
644    - Fine-tuning the behavior of `org-yank'
645    - Formulas for clocktables
646    - Better implementation of footnotes for HTML export
647    - More languages for HTML export.
649 ** Details
651 *** A region of entries can now be refiled with a single command
652     
653     With =transient-make-mode= active (=zmacs-regions= under
654     XEmacs), you can now select a region of entries and refile
655     them all with a single =C-c C-w= command.
657     Thanks to Samuel Wales for this useful proposal.
659 *** Fine-tuning the behavior of =org-yank=
661     The behavior of Org's yanking command has been further
662     fine-tuned in order to avoid some of the small annoyances
663     this command caused.
665     - Calling =org-yank= with a prefix arg will stop any special
666       treatment and directly pass through to the normal =yank=
667       command.  Therefore, you can now force a normal yank with
668       =C-u C-y=.
670     - Subtrees will only be folded after a yank if doing so will
671       now swallow any non-white characters after the yanked text.
672       This is, I think a really important change to make the
673       command work more sanely.
675 *** Formulas for clocktables
677     You can now add formulas to a clock table, either by hand, or
678     with a =:formula= parameter.  These formulas can be used to
679     create additional columns with further analysis of the
680     measured times.
682     Thanks to Jurgen Defurne for triggering this addition.
684 *** Better implementation of footnotes for HTML export
685     
686     The footnote export in 6.11 really was not good enough.  Now
687     it works fine.  If you have customized
688     =footnote-section-tag=, make sure that your customization is
689     matched by =footnote-section-tag-regexp=.
691     Thanks to Sebastian Rose for pushing this change.
693 *** More languages for HTML export.
695     More languages are supported during HTML export.  This is
696     only relevant for the few special words Org inserts, like
697     "Table of Contents", or "Footnotes".  Also the encoding
698     issues with this feature seem to be solved now.
700     Thanks to Sebastian Rose for pushing me to fix the encoding
701     problems.
703 * Version 6.11
705 ** Overview
707    - Yanking subtree with =C-y= now adjusts the tree level
708    - State changes can now be shown in the log mode in the agenda
709    - Footnote in HTML export are now collected at the end of the document
710    - HTML export now validates again as XHTML
711    - The clock can now be resumed after exiting and re-starting Emacs
712    - Clock-related data can be saved and resumed across Emacs sessions
713    - Following file links can now use C-u C-u to force use of an external app
714    - Inserting absolute files names now abbreviates links with "~"
715    - Links to attachment files
716    - Completed repeated tasks listed briefly in agenda
717    - Remove buffers created during publishing are removed
719 ** Details
721 *** Yanking subtree with =C-y= now adjusts the tree level
722     When yanking a cut/copied subtree or a series of trees, the
723     normal yank key =C-y= now adjusts the level of the tree to
724     make it fit into the current outline position, without losing
725     its identity, and without swallowing other subtrees.
727     This uses the command =org-past-subtree=.  An additional
728     change in that command has been implemented: Normally, this
729     command picks the right outline level from the surrounding
730     *visible* headlines, and uses the smaller one.  So if the
731     cursor is between a level 4 and a level 3 headline, the tree
732     will be pasted as level 3.  If the cursor is actually *at*
733     the beginning of a headline, the level of that headline will
734     be used.  For example, lets say you have a tree like this:
736 #+begin_src org
737 ,* Level one
738 ,** Level two
739 ,(1)
740 ,(2)* Level one again
741 #+end_src
743     with (1) and (2) indicating possible cursor positions for the
744     insertion.  When at (1), the tree will be pasted as level 2.
745     When at (2), it will be pasted as level 1.
747     If you do not want =C-y= to behave like this, configure the
748     variable =org-yank-adjusted-subtrees=.
750     Thanks to Samuel Wales for this idea and a partial implementation.
752 *** State changes can now be shown in the log mode in the agenda
754     If you configure the variable =org-agenda-log-mode-items=,
755     you can now request that all logged state changes be included
756     in the agenda when log mode is active.  If you find this too
757     much for normal applications, you can also temporarily
758     request the inclusion of state changes by pressing =C-u l= in
759     the agenda.
761     This was a request by Hsiu-Khuern Tang.
763     You can also press `C-u C-u l' to get *only* log items in the
764     agenda, withour any timestamps/deadlines etc.
766 *** Footnote in HTML export are now collected at the end of the document
767     Previously, footnotes would be left in the document where
768     they are defined, now they are all collected and put into a
769     special =<div>= at the end of the document.
771     Thanks to Sebastian Rose for this request.
773 *** HTML export now validates again as XHTML.
775     Thanks to Sebastian Rose for pushing this cleanup.
777 *** The clock can now be resumed after exiting and re-starting Emacs
779     If the option =org-clock-in-resume= is t, and the first clock
780     line in an entry is unclosed, clocking into that task resumes
781     the clock from that time.
783     Thanks to James TD Smith for a patch to this effect.
785 *** Clock-related data can be saved and resumed across Emacs sessions
786     
787     The data saved include the contents of =org-clock-history=,
788     and the running clock, if there is one.
789     
790     To use this, you will need to add to your .emacs
792 #+begin_src emacs-lisp
793 (setq org-clock-persist t)
794 (setq org-clock-in-resume t)
795 (org-clock-persistence-insinuate)
796 #+end_src
798     Thanks to James TD Smith for a patch to this effect.
800 *** Following file links can now use C-u C-u to force use of an external app.
802     So far you could only bypass your setup in `org-file-apps'
803     and force opening a file link in Emacs by using a =C-u= prefix arg
804     with =C-c C-o=.  Now you can call =C-u C-u C-c C-o= to force
805     an external application.  Which external application depends
806     on your system.  On Mac OS X and Windows, =open= is used.  On
807     a GNU/Linux system, the mailcap settings are used.
809     This was a proposal by Samuel Wales.
811 *** Inserting absolute files names now abbreviates links with "~".
813     Inserting file links with =C-u C-c C-l= was buggy if the
814     setting of `org-link-file-path-type' was `adaptive' (the
815     default).  Absolute file paths were not abbreviated relative
816     to the users home directory.  This bug has been fixed.
818     Thanks to Matt Lundin for the report.
820 *** Links to attachment files
822     Even though one of the purposes of entry attachments was to
823     reduce the number of links in an entry, one might still want
824     to have the occasional link to one of those files.  You can
825     now use link abbreviations to set up a special link type that
826     points to attachments in the current entry.  Note that such
827     links will only work from within the same entry that has the
828     attachment, because the directory path is entry specific.
829     Here is the setup you need:
831 #+begin_src emacs-lisp
832 (setq org-link-abbrev-alist '(("att" . org-attach-expand-link)))
833 #+end_src
835     After this, a link like this will work
837 #+BEGIN_EXAMPLE
838      [[att:some-attached-file.txt]]
839 #+END_EXAMPLE
840     This was a proposal by Lindsay Todd.
842 *** Completed repeated tasks listed briefly in agenda
844     When a repeating task, listed in the daily/weekly agenda under
845     today's date, is completed from the agenda, it is listed as
846     DONE in the agenda until the next update happens.  After the
847     next update, the task will have disappeared, of course,
848     because the new date is no longer today.
849     
850 *** Remove buffers created during publishing are removed
852     Buffers that are created during publishing are now deleted
853     when the publishing is over.  At least I hope it works like this.
855 * Version 6.10
857 ** Overview
859    - Secondary agenda filtering is becoming a killer feature
860    - Setting tags has now its own binding, =C-c C-q=
861    - Todo state changes can trigger tag changes
862    - C-RET will now always insert a new headline, never an item.
863    - Customize org-mouse.el feature set to free up mouse events
864    - New commands for export all the way to PDF (through LaTeX)
865    - Some bug fixed for LaTeX export, more bugs remain.
867 ** Details
869 *** Enhancements to secondary agenda filtering
871     This is, I believe, becoming a killer feature.  It allows you
872     to define fewer and more general custom agenda commands, and
873     then to do the final narrowing to specific tasks you are
874     looking for very quickly, much faster than calling a new
875     agenda command.
877     If you have not tries this yet, you should!
879 **** You can now refining the current filter by an additional criterion
880       When filtering an existing agenda view with =/=, you can
881       now narrow down the existing selection by an additional
882       condition.  Do do this, use =\= instead of =/= to add the
883       additional criterion.  You can also press =+= or =-= after
884       =/= to add a positive or negative condition.  A condition
885       can be a TAG, or an effort estimate limit, see below.
887 **** It is now possible to filter for effort estimates
888      This means to filter the agenda for the value of the Effort
889      property.  For this you should best set up global allowed
890      values for effort estimates, with
892 #+begin_src emacs-lisp
893 (setq org-global-properties
894       '(("Effort_ALL" . "0 0:10 0:30 1:00 2:00 3:00 4:00")))
895 #+end_src
896       
897      You may then select effort limits with single keys in the
898      filter.  It works like this:  After =/= or =\=, first select
899      the operator which you want to use to compare effort
900      estimates:
902      : <   Select entries with effort smaller than or equal to the limit
903      : >   Select entries with effort larger than or equal to the limit
904      : =   Select entries with effort equal to the limit
906      After that, you can press a single digit number which is
907      used as an index to the allowed effort estimates.
909      If you do not use digits to fast-select tags, you can even
910      skip the operator, which will then default to
911      `org-agenda-filter-effort-default-operator', which is by
912      default =<=.
914      Thanks to Manish for the great idea to include fast effort
915      filtering into the agenda filtering process.
917 **** The mode line will show the active filter
918      For example, if there is a filter in place that does select
919      for HOME tags, against EMAIL tags, and for tasks with an
920      estimated effort smaller than 30 minutes, the mode-line with
921      show =+HOME-EMAIL+<0:30=
923 **** The filter now persists when the agenda view is refreshed
924      All normal refresh commands, including those that move the
925      weekly agenda from one week to the next, now keep the
926      current filter in place.
928      You need to press =/ /= to turn off the filter.  However,
929      when you run a new agenda command, for example going from
930      the weekly agenda to the TODO list, the filter will be
931      switched off.
932    
933 *** Setting tags has now its own binding, =C-c C-q=
935     You can still use =C-c C-c= on a headline, but the new
936     binding should be considered as the main binding for this
937     command.  The reasons for this change are:
939     - Using =C-c C-c= for tags is really out of line with other
940       uses of =C-c C-c=.
942     - I hate it in Remember buffers when I try to set tags and I
943       cannot, because =C-c C-c= exits the buffer :-(
945     - =C-c C-q= will also work when the cursor is somewhere down
946       in the entry, it does not have to be on the headline.
948 *** Todo state changes can trigger tag changes
950     The new option =org-todo-state-tags-triggers= can be used to
951     define automatic changes to tags when a TODO state changes.
952     For example, the setting
954     : (setq org-todo-state-tags-triggers
955     :       '((done ("Today" . nil) ("NEXT" . nil))
956     :         ("WAITING" ("Today" . t))))    
958     will make sure that any change to any of the DONE states will
959     remove tags "Today" and "NEXT", while switching to the
960     "WAITING" state will trigger the tag "Today" to be added.
962     I use this mostly to get rid of TODAY and NEXT tags which I
963     apply to select an entry for execution in the near future,
964     which I often prefer to specific time scheduling.
966 *** C-RET will now always insert a new headline, never an item.
967     The new headline is inserted after the current subtree.
969     Thanks to Peter Jones for patches to fine-tune this behavior.
971 *** Customize org-mouse.el feature set
972     There is a new variable =org-mouse-features= which gives you
973     some control about what features of org-mouse you want to
974     use.  Turning off some of the feature will free up the
975     corresponding mouse events, or will avoid activating special
976     regions for mouse clicks.  By default I have urned off the
977     feature to use drag mouse events to move or promote/demote
978     entries.  You can of course turn them back on if you wish.
980     This variable may still change in the future, allowing more
981     fine-grained control.
983 *** New commands for export to PDF
985     This is using LaTeX export, and then processes it to PDF
986     using pdflatex.
988     : C-c C-e p     process to PDF.
989     : C-c C-e d     process to PDF, and open the file.
991 *** LaTeX export
992     - \usepackage{graphicx} is now part of the standard class
993       definitions.
994     - Several bugs fixed, but definitely not all of them :-(
996 *** New option `org-log-state-notes-insert-after-drawers'
998     Set this to =t= if you want state change notes to be inserted
999     after any initial drawers, i.e drawers the immediately follow
1000     the headline and the planning line (the one with
1001     DEADLINE/SCHEDULED/CLOSED information).
1003 * Version 6.09
1004 ** Incompatible
1005 *** =org-file-apps= now uses regular expressions, see [[*%20org%20file%20apps%20now%20uses%20regular%20repressions%20instead%20of%20extensions][below]]
1007 ** Details
1009 *** =org-file-apps= now uses regular repressions instead of extensions
1010     Just like in =auto-mode-alist=, car's in the variable
1011     =org-file-apps= that are strings are now interpreted as
1012     regular expressions that are matched against a file name.  So
1013     instead of "txt", you should now write "\\.txt\\'" to make
1014     sure the matching is done correctly (even though "txt" will
1015     be recognized and still be interpreted as an extension).
1017     There is now a shortcut to get many file types visited by
1018     Emacs.  If org-file-apps contains `(auto-mode . emacs)', then
1019     any files that are matched by `auto-mode-alist' will be
1020     visited in emacs.
1022 *** Changes to the attachment system
1024     - The default method to attach a file is now to copy it
1025       instead of moving it.
1026     - You can modify the default method using the variable
1027       `org-attach-method'.  I believe that most Unix people want
1028       to set it to `ln' to create hard links.
1029     - The keys =c=, =m=, and =l= specifically select =copy=,
1030       =move=, or =link=, respectively, as the attachment method
1031       for a file, overruling  `org-attach-method'.
1032     - To create a new attachment as an Emacs buffer, you have not
1033       now use =n= instead of =c=.
1034     - The file list is now always retrieved from the directory
1035       itself, not from the "Attachments" property.  We still
1036       keep this property by default, but you can turn it off, by
1037       customizing the variable =org-attach-file-list-property=.
1039 * Version 6.08
1041 ** Incompatible changes
1043    - Changes in the structure of IDs, see [[*The%20default%20structure%20of%20IDs%20has%20changed][here]] for details.
1045    - C-c C-a has been redefined, see [[*%20C%20c%20C%20a%20no%20longer%20calls%20show%20all][here]] for details.
1047 ** Details
1049 *** The default structure of IDs has changed
1051     IDs created by Org have changed a bit:
1052     - By default, there is no prefix on the ID.  There used to be
1053       an "Org" prefix, but I now think this is not necessary.
1054     - IDs use only lower-case letters, no upper-case letters
1055       anymore.  The reason for this is that IDs are now also used
1056       as directory names for org-attach, and some systems do not
1057       distinguish upper and lower case in the file system.
1058     - The ID string derived from the current time is now
1059       /reversed/ to become an ID.  This assures that the first
1060       two letters of the ID change fast, so hat it makes sense to
1061       split them off to create subdirectories to balance load.
1062     - You can now set the `org-id-method' to `uuidgen' on systems
1063       which support it.
1065 *** =C-c C-a= no longer calls `show-all'
1067     The reason for this is that =C-c C-a= is now used for the
1068     attachment system.  On the rare occasions that this command
1069     is needed, use =M-x show-all=, or =C-u C-u C-u TAB=.
1071 *** New attachment system
1073     You can now attach files to each node in the outline tree.
1074     This works by creating special directories based on the ID of
1075     an entry, and storing files in these directories.  Org can
1076     keep track of changes to the attachments by automatically
1077     committing changes to git.  See the manual for more
1078     information.
1080     Thanks to John Wiegley who contributed this fantastic new
1081     concept and wrote org-attach.el to implement it.
1083 *** New remember template escapes
1085     : %^{prop}p   to insert a property
1086     : %k          the heading of the item currently being clocked
1087     : %K          a link to the heading of the item currently being clocked
1089     Also, when you exit remember with =C-2 C-c C-c=, the item
1090     will be filed as a child of the item currently being
1091     clocked.  So the idea is, if you are working on something and
1092     think of a new task related to this or a new note to be
1093     added, you can use this to quickly add information to that
1094     task.
1096     Thanks to James TD Smith for a patch to this effect.
1098 *** Clicking with mouse-2 on clock info in mode-line visits the clock.
1099     
1100     Thanks to James TD Smith for a patch to this effect.
1102 *** New file in contrib: lisp/org-checklist.el
1104     This module deals with repeated tasks that have checkbox
1105     lists below them.
1107     Thanks to James TD Smith for this contribution.
1109 *** New in-buffer setting #+STYLE
1111     It can be used to locally set the variable
1112     `org-export-html-style-extra'.  Several such lines are
1113     allowed-, they will all be concatenated.  For an example on
1114     how to use it, see the [[http://orgmode.org/worg/org-tutorials/org-publish-html-tutorial.php][publishing tutorial]].
1116 * Version 6.07
1118 ** Overview
1120    - Filtering existing agenda views with respect to a tag
1121    - Editing fixed-width regions with picture or artist mode
1122    - /org-plot.el/ is now part of Org
1123    - Tags can be used to select the export part of a document
1124    - Prefix interpretation when storing remember notes
1125    - Yanking inserts folded subtrees
1126    - Column view capture tables can have formulas, plotting info
1127    - In column view, date stamps can be changed with S-cursor keys
1128    - The note buffer for clocking out now mentions the task
1129    - Sorting entries alphabetically ignores TODO keyword and priority
1130    - Agenda views can sort entries by TODO state
1131    - New face =org-scheduled= for entries scheduled in the future.
1132    - Remember templates for gnus links can use the :to escape.
1133    - The file specification in a remember template may be a function
1134    - Categories in iCalendar export include local tags
1135    - It is possible to define filters for column view
1136    - Disabling integer increment during table Field copy
1137    - Capturing column view is on `C-c C-x i'
1138    - And tons of bugs fixed.  
1141 ** Incompatible changes
1143 *** Prefix interpretation when storing remember notes has changed
1145     The prefix argument to the `C-c C-c' command that finishes a
1146     remember process is now interpreted differently:
1148     : C-c C-c       Store the note to predefined file and headline
1149     : C-u C-c C-c   Like C-c C-c, but immediately visit the note
1150     :               in its new location.
1151     : C-1 C-c C-c   Select the storage location interactively
1152     : C-0 C-c C-c   Re-use the last used location
1154     This was requested by John Wiegley.
1156 *** Capturing column view is now on `C-c C-x i'
1158     The reason for this change was that `C-c C-x r' is also used
1159     as a tty key replacement.
1161 *** Categories in iCalendar export now include local tags
1163     The locally defined tags are now listed as categories when
1164     exporting to iCalendar format.  Org's traditional file/tree
1165     category is now the last category in this list.  Configure
1166     the variable =org-icalendar-categories= to modify or revert
1167     this behavior.
1169     This was a request by Charles Philip Chan.
1171 ** Details
1173 *** Secondary filtering of agenda views.
1175     You can now easily and interactively filter an existing
1176     agenda view with respect to a tag.  This command is executed
1177     with the =/= key in the agenda.  You will be prompted for a
1178     tag selection key, and all entries that do not contain or
1179     inherit the corresponding tag will be hidden.  With a prefix
1180     argument, the opposite filter is applied: entries that
1181     do have the tag will be hidden.
1183     This operation only /hides/ lines in the agenda buffer, it
1184     does not remove them.  Changing the secondary filtering does
1185     not require a new search and is very fast.
1187     If you press TAB at the tag selection prompt, you will be
1188     switched to a completion interface to select a tag.  This is
1189     useful when you want to select a tag that does not have a
1190     direct access character.
1192     A double =/ /= will restore the original agenda view by
1193     unhiding any hidden lines.
1195     This functionality was John Wiegley's idea.  It is a simpler
1196     implementation of some of the query-editing features proposed
1197     and implemented some time ago by Christopher League (see the
1198     file contrib/lisp/org-interactive-query.el).
1200 *** Editing fixed-width regions with picture or artist mode
1202     The command @<code>C-c '@</code> (that is =C-c= followed by a
1203     single quote) can now also be used to switch to a special
1204     editing mode for fixed-width sections.  The default mode is
1205     =artist-mode= which allows you to create ASCII drawings.
1207     It works like this: Enter the editing mode with
1208     @<code>C-c '@</code>.  An indirect buffer will be created and
1209     narrowed to the fixed-width region.  Edit the drawing, and
1210     press @<code>C-c '@</code> again to exit.
1212     Lines in a fixed-width region should be preceded by a colon
1213     followed by at least one space.  These will be removed during
1214     editing, and then added back when you exit the editing mode.
1216     Using the command in an empty line will create a new
1217     fixed-width region.
1219     This new feature arose from a discussion involving Scott
1220     Otterson, Sebastian Rose and Will Henney.
1222 *** /org-plot.el/ is now part of Org.
1224     You can run it by simple calling org-plot/gnuplot.
1225     Documentation is not yet included with Org, please refer to
1226     http://github.com/eschulte/org-plot/tree/master until we have
1227     moved the docs into Org or Worg.
1229     Thanks to Eric Schulte for this great contribution.
1231 *** Tags can be used to select the export part of a document
1233     You may now use tags to select parts of a document for
1234     inclusion into the export, and to exclude other parts.  This
1235     behavior is governed by two new variables:
1236     =org-export-select-tags= and =org-export-exclude-tags=.
1237     These default to =("export")= and =("noexport")=, but can be
1238     changed, even to include a list of several tags.
1240     Org first checks if any of the /select/ tags is present in
1241     the buffer.  If yes, all trees that do not carry one of these
1242     tags will be excluded.  If a selected tree is a subtree, the
1243     heading hierarchy above it will also be selected for export,
1244     but not the text below those headings.  If none of the select
1245     tags is found anywhere in the buffer, the whole buffer will
1246     be selected for export.  Finally, all subtrees that are
1247     marked by any of the /exclude/ tags will be removed from the
1248     export buffer.
1250     You may set these tags with in-buffer options
1251     =EXPORT_SELECT_TAGS= and =EXPORT_EXCLUDE_TAGS=.
1253     I love this feature.  Thanks to Richard G Riley for coming
1254     up with the idea.
1256 *** Prefix interpretation when storing remember notes
1258     The prefix argument to the `C-c C-c' command that finishes a
1259     remember process is now interpreted differently:
1261     : C-c C-c       Store the note to predefined file and headline
1262     : C-u C-c C-c   Like C-c C-c, but immediately visit the note
1263     :               in its new location.
1264     : C-1 C-c C-c   Select the storage location interactively
1265     : C-0 C-c C-c   Re-use the last used location
1267     This was requested by John Wiegley.
1269 *** Yanking inserts folded subtrees
1271     If the kill is a subtree or a sequence of subtrees, yanking
1272     them with =C-y= will leave all the subtrees in a folded
1273     state.  This basically means, that kill and yank are now
1274     much more useful in moving stuff around in your outline.  If
1275     you do not like this, customize the variable
1276     =org-yank-folded-subtrees=.
1278     Right now, I am only binding =C-y= to this new function,
1279     should I modify all bindings of yank?  Do we need to amend
1280     =yank-pop= as well?
1282     This feature was requested by John Wiegley.
1284 *** Column view capture tables can have formulas, plotting info
1286     If you attach formulas and plotting instructions to a table
1287     capturing column view, these extra lines will now survive an
1288     update of the column view capture, and any formulas will be
1289     re-applied to the captured table.  This works by keeping any
1290     continuous block of comments before and after the actual
1291     table.
1293 *** In column view, date stamps can be changed with S-cursor keys
1295     If a property value is a time stamp, S-left and S-right can
1296     now be used to shift this date around while in column view.
1298     This was a request by Chris Randle.
1300 *** The note buffer for clocking out now mentions the task
1301     
1302     This was a request by Peter Frings.
1304 *** Sorting entries alphabetically ignores TODO keyword and priority
1306     Numerical and alphanumerical sorting now skips any TODO
1307     keyword or priority cookie when constructing the comparison
1308     string.  This was a request by Wanrong Lin.
1310 *** Agenda views can sort entries by TODO state
1312     You can now define a sorting strategy for agenda entries that
1313     does look at the TODO state of the entries.  Sorting by TODO
1314     entry does first separate the non-done from the done states.
1315     Within each class, the entries are sorted not alphabetically,
1316     but in definition order.  So if you have a sequence of TODO
1317     entries defined, the entries will be sorted according to the
1318     position of the keyword in this sequence.
1320     This follows an idea and sample implementation by Christian
1321     Egli.
1323 *** New face =org-scheduled= for entries scheduled in the future.
1325     This was a request by Richard G Riley.
1327 *** Remember templates for gnus links can now use the :to escape.
1329     Thanks to Tommy Lindgren for a patch to this effect.
1330 *** The file specification in a remember template may now be a function
1332     Thanks to Gregory Sullivan for a patch to this effect.
1334 *** Categories in iCalendar export now include local tags
1336     The locally defined tags are now listed as categories when
1337     exporting to iCalendar format.  Org's traditional file/tree
1338     category is now the last category in this list.  Configure
1339     the variable =org-icalendar-categories= to modify or revert
1340     this behavior.
1342     This was a request by Charles Philip Chan.
1344 *** It is now possible to define filters for column view
1346     The filter can modify the value that will be displayed in a
1347     column, for example it can cut out a part of a time stamp.
1348     For more information, look at the variable
1349     =org-columns-modify-value-for-display-function=.
1351 *** Disabling integer increment during table field copy
1353     Prefix arg 0 to S-RET does the trick.
1355     This was a request by Chris Randle.
1358 * Older changes
1360   For older Changes, see [[file:Changes_old.org]]
1363