# -*- mode: org; fill-column: 65 -*-
#+STARTUP: showstars
#+TITLE: Org-mode list of user-visible changes
#+AUTHOR: Carsten Dominik
#+EMAIL: carsten at orgmode dot org
#+OPTIONS: H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:{} *:t TeX:t LaTeX:nil f:nil
#+INFOJS_OPT: view:info toc:1 path:org-info.js tdepth:2 ftoc:t
#+LINK_UP: index.html
#+LINK_HOME: http://orgmode.org
* Version 6.27
:PROPERTIES:
:VISIBILITY: content
:CUSTOM_ID: v6.26
:END:
** Details
*** Macros for export
Macro processing for export has been enhanced:
- You can use arguments in a macro, for example
#+begin_src org
#+macro hello Greet the $1: Hello $1
#+end_src
which would turn ={{{hello(world)}}}= into =Greet the world: Hello world=
- The macro value can be an emacs-lisp for to be evaluated at the
time of export:
#+begin_src org
,#+macro: datetime (eval (format-time-string "$1"))
#+end_src
- More built-in default macros:
- date(FORMAT_TIME_STRING) :: Time/Date of export
- time(FORMAT_TIME_STRING) :: Same as date
- modification-time(FORMAT_TIME_STRING) :: Last modification of file
- input-file :: Name of the input file
The new built-in macros have been requested by Daniel Clemente.
*** Link completion for files and bbdb names
Org now has a general mechanism how modules can provide enhanced
support (for example through completion) when adding a link. For
example, when inserting a link with =C-c C-l=, you can now type
=file:= followed by =RET= to get completion support for inserting
a file. After entering =bbdb:= and =RET=, a completion interface
will allow to complete names in the BBDB database. These are the
only ones implemented right now, but modules that add a link type
=xyz:= can simple define =org-xyz-complete-link= that should
return the full link with prefix after aiding the used to create
the link. For example, if you have =http= links that you have to
insert very often, you could define a function
=org-http-complete-link= to help selecting the most common ones.
*** Source file publishing
It is now easy to publish the Org sources along with, for
example, HTML files. In your publishing project, replace
: :publishing-function org-publish-org-to-html
with
: :publishing-function (org-publish-org-to-html org-publish-org-to-org)
: :plain-source t
: :htmlized-source t
to get both the plain org file and an htmlized version that
looks like your editing buffer published along with the HTML
exported version.
*** Push exported stuff to kill ring
All exporters now push the produced material onto the kill-ring
in Emacs, and also to the external clipboard and the primary
selection to make it easy to paste this under many circumstances.
*** Tables in LaTeX without centering
Set the variable `org-export-latex-tables-centered' to nil if you
prefer tables not to be horizontally centered. Note that
longtable tables are always centered.
*** LaTeX export: TODO markup configurable
The markup for TODO keywords in LaTeX export is now configurable
using the variable =org-export-latex-todo-keyword-markup=.
*** ASCII export to buffer
ASCII export has now the same command variations as the other
export backends, for example exporting to a temporary buffer
instead of a file.
The was a request by Samuel Wales.
*** Accessibility improvements for HTTP tables
When exporting tables to HTML, Org now adds =scope= attributes to
all header fields, in order to support screen readers.
Setting the variable
=org-export-html-table-use-header-tags-for-first-column= will
request using =
= instead of = | = also in the entire first
column, so that also row information can be scoped. This was
triggered by a request by Jan Buchal, and as usually Sebastian
Rose came up with the right implementation.
*** Timezone information in iCalendar files
The timezone information in iCalendar files is now written in the
correct format, and can be set in the variable
=org-ical-timezone=. This variable is initialized from the =TZ=
environment variable.
*** New contributed package /org-special-blocks.el/
The package turns any "undefined" =#+begin_...= blocks into LaTeX
environments for LaTeX export, and into == tags for HTML
export.
Thanks to Chris Gray for this contribution.
*** More flexibility about placing logging notes.
Logging into a drawer can now also be set for individual
subtrees using the =LOG_INTO_DRAWER= property.
Requested by Daniel J. Sinder
*** New reload key
Reloading Org has moved to a new key, =C-c C-x !=, and is now
also available in the agenda.
*** Start Agenda with log mode active
Set the new option =org-agenda-start-with-log-mode= to have
log mode turned on from the start. Or set this option for
specific custom commands.
Thanks to Benjamin Andresen for a patch to this effect.
*** Agenda speed optimizations
Depending on circumstances, construction the agenda has become a
lot faster.
Triggered by Eric S Fraga's reports about using Org on a slow
computer like a netbook.
*** New face for today in agenda
The date that is today can now be highlighted in the agenda by
customizing the face =org-agenda-date-today=.
Thanks to Dmitri Minaev for a patch to this effect.
*** Properties to disambiguate statistics
When an entry has both check boxes and TODO children, it is not
clear what kind of statistics a cookie should show You can now use
the =COOKIE_DATA= property to disambiguate, by giving it a value
"todo" or "checkbox".
Thanks to Ulf Stegeman, who was persistent enough to push this
change past my initial resistance.
*** Checkboxes and TODO items: recursive statistics
Setting the variable =org-hierarchical-checkbox-statistics= to
=nil= will make statistics cookies count all checkboxes in the
lit hierarchy below it.
Setting the variable =org-hierarchical-todo-statistics= to
=nil= will do the same for TODO items.
To turn on recursive statistics only for a single subtree, add the
word "recursive" to the =COOKIE_DATA= property. Note that you
can have such a property containing both "todo" or "checkbox" for
disambiguation, and the word "recursive", separated by a space
character.
The change for checkboxes was a patch by Richard Klinda.
*** New operators for column view
Column view has new operators for computing the minimum,
maximum, and mean of property values.
Thanks to Mikael Fornius for a patch to this effect.
* Version 6.26
** Details
*** custom IDs
Entries can now define a =CUSTOM_ID= property. This property
must be a valid ID according to HTML rules, and it will be used
in HTML export as the main target ID for this entry. That means,
both the table of conents and other internal links will
automatically point to this ID instead of the automatic ID like
=sec-1.1=. This is useful to create humar-readable permanent
links to these location in a document.
The user is responsible to make sure that custom IDs are unique
within a file.
Links written like =[[#my-target-name] ]= can be used to target a
custom ID.
When using =C-c l= to store a link to a headline that has a
custom ID, Org will now create two links at the same time. One
link will be to the custom ID. The other will be to the globaly
unique ID property. When inserting the line with =C-c C-l=, you
need to decide which one you want to use. Use the ID links for
entries that are expected to move from one file to the next. Use
custom ID links publishing projects, when you are sure that te
entry will stay in that file. See also the variable
=org-link-to-org-use-id=.
*** Remember to non-org files
If the target headline part of a remember template definition
entry is =top= or =bottom=, the target file may now be a
non-Org-mode file. In this case, the content of the remember
buffer will be added to that file without enforcing an Org-like
headline. Sorry, Russel, that this took so long.
*** New property to turn off todo dependencies locally
Setting the property =NOBLOCKING= will turn off TODO dependency
checking for this entry.
*** Refile verify
A new function is called to verify tasks that are about to be
selected as remember targets. See the new variable
=org-refile-target-verify-function=.
*** New version org ditaa.jar
Thanks to Stathis Sideris.
*** htmlize.el is now in the contrib directory
The latest version of htmlize.el is now the in the contrib
directory of Org. Thanks to Hrvoje Niksic for allowing this.
* Version 6.25
:PROPERTIES:
:CUSTOM_ID: v6.25
:END:
** Major new features
*** DocBook export
We now do have a fully functional DocBook exporter, contributed by
Baoqiu Cui. Simple press =C-c e D= to export the current file to
DocBook format. You can also get direct conversion to PDF if you have
made the correct setup, please see the manual for details.
Kudos to Baoqiu for this fantastic addition, and my personal thanks
for doing this in a such a smooth way that I did not have to do
anything myself.
*** Protocols for external access to Emacs and Org
/org-protocol.el/ is a new module that supersedes both
/org-annotation-helper.el/ and /org-browser.el/ and replaces them
with a more abstracted interface. /org-protocol/ intercepts
calls from emacsclient to trigger custom actions without external
dependencies. Only one protocol has to be configured with your
external applications or the operating system, to trigger an
arbitrary number of custom actions. Just register your custom
sub-protocol and handler with the new variable
=org-protocol-protocol-alist=.
org-protocol comes the with three standard protocol handlers (in
parenthesis the name of the sub-protocol):
- =org-protocol-remember= (=remember=) :: Trigger remember
- =org-protocol-store-link= (=store-link=) :: Store a link
- =org-protocol-open-source= (=open-source=) :: Find the local
source of a remote web page.
Passing data to emacs is now as easy as calling
: emacsclient org-protocol://sub-protocol://data
For more information see the [[http://orgmode.org/worg/org-contrib/org-protocol.php][online documentation]]
Thanks to Sebastian Rose for this really beautiful module.
*** Inline tasks
Inline tasks are tasks that have all the properties of normal
outline nodes, including the ability to store meta data like
scheduling dates, TODO state, tags and properties. But these
tasks are not meant to introduce additional outline structure, at
least as far as visibility cycling and export is concerned. They
are useful for adding tasks in extensive pieces of text where
interruption of the flow or restructuring is unwanted.
This feature is not turned on by default, you need to configure
=org-modules= to turn it on, or simply add to you .emacs file:
: (require 'org-inlinetask)
After that, tasks with level 15 (30 stars when using
org-odd-levels-only) will be treated as inline tasks, and
fontification will make obvious which tasks are treated in this
way.
*** Input from RSS feeds
Org can now collect tasks from an RSS feed, a great method to get
stuff from online call and note-taking services into your trusted
system. You need to configure the feeds in the variable
=org-feed-alist=. The manual contains a short description, more
detailed information is [[http://orgmode.org/worg/org-contrib/org-feed.php][available on Worg]].
Full credit goes to Brad Bozarth who really [[http://thread.gmane.org/gmane.emacs.orgmode/12251][paved the way]] for this
exciting new feature.
** Export
*** Allow modification of table attributes in HTML export
The #+ATTR_HTML line can now be used to set attributes for a
table. Attributes listed in that line will replace existing
attributes in =org-export-html-table-tag=, or will add new ones.
For example
: #+ATTR_HTML: border="2" rules="all" frame="all"
: #+CAPTION: Finally a table with lines!
: | a | b |
: |---|---|
: | 1 | 2 |
*** LaTeX low levels are now exported as itemize lists
LaTeX export now treats hierarchy levels 4,5, etc as itemize
lists, not as description lists as before. This is more
consistent with the behavior of HTML export. You can configure
this behavior using the variable =org-export-latex-low-levels=.
*** Markup for centering.
Text can be exported centered with
#+begin_src org
,#+BEGIN_CENTER
,Everything should be made as simple as possible, \\
,but not any simpler
,#+END_CENTER
#+end_src
*** Sitemap file is now /sitemap.org/
Org-publish can produce a list of all files in a project.
Previously the file containing this list was called "index.org",
really a brain-dead default because during publication it would
overwrite the "index.html" file of the website.
The default file name is now "sitemap.org"
*** Protect explicit target links in HTML export
If a link is =[[#name] [desc]]=, the href produced when exporting
the file will be exactly href="#name". So starting a link target
with # will indicate that there will be an explicit target for
this.
*** HTML export: Allow "- ___" to explicitly terminate a list
If a list contains "- ___" (three underscores) as an item, this
terminates the list, ignoring this item. This is an experimental
feature, it may disappear again if we find other ways to deal
with literal examples right after lists.
See [[http://thread.gmane.org/gmane.emacs.orgmode/12299/focus%3D12312][this mailing list thread]] for context.
** Agenda
*** Changing the time of an entry from the agenda
We now have a way to change not only the date, but also the start
time of an entry from the agenda. The date is normally changed
with S-right/left. Now, if you add a C-u prefix, the hour will
be changed. If you immediately press S-right/left again, hours
will continue to be changed. A double prefix will do the same
for minutes. If the entry has a time range like 14:40-16:00,
then both times will change, preserving the length of the
appointment.
*** Show saved PDF agenda view with prefix arg
When writing an agenda view to a PDF file, supplying a a prefix
argument (=C-u C-x C-w=) will get the new file displayed
immediately.
This was a request by Alan E Davis.
*** Filter for entries with no effort defined
During secondary agenda filtering, pressing "?" now will install a
filter that selects entries which do not have an effort defined.
This new model was necessary because we needed to stop interpreting
entries with no effort defines as 0 effort. This was inconsistent,
because for normal agenda sorting, the treatment of these entries
depends on the variable =org-sort-agenda-noeffort-is-high=. Now this
variable is also respected during filtering.
This new feature resulted from a [[http://thread.gmane.org/gmane.emacs.orgmode/12493][discussion]] with Matt Lundin and
Bernt Hansen.
*** Introduce user-defined sorting operators
The new variable =org-agenda-cmp-user-defined= can contain a
function to test how two entries should be compared during
sorting. The symbols =user-defined-up= and =user-defined-down=
can then be part of any sorting strategy.
This was a request by Samuel Wales.
*** Indentation of subitems in the agenda
When a tags/property match does match an entry and it's
sublevels, the sublevels used to be indented by dots, to indicate
that the matches likely result from tag inheritance. This is now
no longer the default, so the subitems will not get special
indentation. You can get this behavior back with
: (setq org-tags-match-list-sublevels 'indented)
*** Stuck projects search now searches subtrees of unstuck projects
When, during a stuck-project search, a project tree is identified
as not stuck, so far the search would continue after the end of
the project tree. From now on, the search continues in the
subtree, so that stuck subprojects can still be identified.
** Miscellaneous
*** Citations: Use RefTeX to insert citations
RefTeX can now be used to create a citation in Org-mode buffers.
Setup the buffer with
#+begin_src org
,#+BIBLIOGRAPHY: bibbase style
#+end_src
and create citations with =C-c C-x [=.
Together with org-exp-bibtex.el by Taru Karttunen (available as a
contributed package), this provides a great environment for
including citations into HTML and LaTeX documents.
*** Changing time ranges as a block
When using the S-cursor keys to change the first time in a time
range like
: <2009-04-01 Wed 14:40-16:40>
then the end time will change along, so that the duration of the
event will stay the same.
This was a request by Anupam Sengupta.
*** New sparse tree command
A new sparse tree command shows entries with times after a certain
date. Keys are =C-c / a=, this command is for symmetry
with =C-c / b=.
*** Cloning tasks
A new command allows to create clone copies of the current entry,
with shifted dates in all stamps in the entry. This is useful to
create, for example, a series of entries for a limited time
period. I am using it to prepare lectures, for example.
*** New face for checkboxes
Checkboxes now have their own face, =org-checkbox=. This can be
used for nice effects, for example choosing a face with a box
around it:
#+begin_src emacs-lisp
(custom-set-faces
(org-checkbox ((t (:background "#444444" :foreground "white"
:box (:line-width 1 :style released-button)))))
#+end_src
*** M-a and M-e for navigation in a table field
In tables fields, the sentence commands =M-a= and =M-e= are
redefined to jump to the beginning or end of the field.
This was a request by Bastien Guerry.
*** Backup files for remember buffers
Sometimes users report that they lost data when not immediately
storing a new remember note, and then later exiting Emacs or
starting a new remember process.
Now you can set the variable =org-remember-backup-directory=.
Each remember buffer created will then get its own unique file
name in that directory, and the file will be removed only if the
storing of the note to an Org files was successful.
*** org-mac-message.el: New functions to access flagged mail
Christopher Suckling has added functionality to
/org-mac-message.el/. In particular, you can now select a number
of messages and easily get links to all of them with a single
command. For details, see the [[http://orgmode.org/worg/org-contrib/org-mac-message.php][online documentation]].
*** Read-date: New hook
The new hook =org-read-date-minibuffer-setup-hook= is called when
setting up the minibuffer for reading a date. If can be used to
install new keys into the temporary keymap used there.
* Version 6.24
:PROPERTIES:
:CUSTOM_ID: v6.24
:END:
** Incompatible changes
*** Tag searches are now case-sensitive
From this release on, tag searches will be case sensitive. While
I still think it would be nice to have them case-insensitive,
this was both an inconsistency (TODO keyword searches have always
been case-sensitive), and trouble for coding some efficient
algorithms. So please make sure that you give the tags with
correct casing when prompted for a match expression.
*** New key for creating tags/property sparse trees
The key to produce a sparse tree matching tags and properties is
now =C-c / m= instead of =C-c a T=. This is also more consistent
with the =C-c a m= key for the corresponding agenda view.
=C-c / T= will still work for now, but it is no longer advertised
in the documentation and may go away at any time in the future.
*** IDs in HTML have "ID-" prefix when generated by uuidgen
/uuidgen/ generates IDs that often start with a number, not a
latter. However, IDs and names in XHTML must start with a letter.
Therefore, IDs in HTML files will now get an "ID-" prefix if they
have been generated by uuidgen. This means that id links from one
file to another may stop working until all files have been
exported again.
*** In agenda, only priority cookies get the special face
So far, an entire task would get a special face when
=org-agenda-fontify-priorities= was set. Now, the default value
for this variable is the symbol =cookies=, which means that on
the cookie is fontified. Set it to =t= if you want the entire
task headline to be fontified.
** Details
*** PDF export of agenda views
Agenda views can now be exported to PDF files by writing them to
a file with extension ".pdf". Internally this works by first
producing the postscript version and then converting that to PDF
using the ghostview utility =ps2pdf=. Make sure that this
utility is installed on your system.
The postscript version will not be removed, it will stay around.
*** Inline some entry text for Agenda View export
When exporting an agenda view to HTML or PDF for printing or
remote access, one of the problems can be that information stored
in entries below the headline is not accessible in that format.
You can now copy some of that information to the agenda view
before exporting it. For this you need to set the variable
=org-agenda-add-entry-text-maxlines= to a number greater than 0.
#+begin_src emacs-lisp
(setq org-agenda-add-entry-text-maxlines 20)
#+end_src
Or you can do this with the settings in a custom agenda view,
for example
#+begin_src emacs-lisp
("A" "" agenda ""
((org-agenda-ndays 1)
(org-agenda-add-entry-text-maxlines 5))
("agenda-today.pdf"))
#+end_src
*** Improved ASCII export of links
ASCII export of links works now much better. If a link has a
link and a description part which are different, then the
description will remain in the text while the link part will be
moved to the end of the current section, before the next heading,
as a footnote-like construct.
Configure the variable =org-export-ascii-links-to-notes= if you
prefer the links to be shown in the text. In this case, Org will
make an attempt to wrap the line which may have become
significantly longer by showing the link.
Thanks to Samuel Wales for pointing out the bad state of ASCII
link export.
*** Custom agenda commands can specify a filter preset
If a custom agenda command specifies a value for
=org-agenda-filter-preset= in its options, the initial view of
the agenda will be filterd by the specified tags. Applying a
filter with =/= will then always add to that preset filter,
clearing the filter with =/ /= will set it back to the preset.
Here is an example of a custom agenda view that will display the
agenda, but hide all entries with tags =FLUFF= or =BLUFF=:
#+begin_src emacs-lisp
("A" "" agenda ""
((org-agenda-filter-preset '("-FLUFF" "-BLUFF"))))
#+end_src
This is in response to a [[http://thread.gmane.org/gmane.emacs.orgmode/11752][thread on the mailing list]], started by
Daniel Clemente and with great contributions by Bernt Hansen and
Matt Lundin.
*** Exporting of citations to LaTeX and HTML, using BibTeX
Citations can now me made using BibTeX, and will be exported to
LaTeX and HTML. This is implemented in a contributed package by
Taru Karttunen, /org-exp-bibtex.el/. Kudos to Taru for this
really nice addition.
*** Finally a way to specify keywords and description for HTML export
Use something like
#+begin_src org
#+DESCRIPTION: This page is all about ....
#+KEYWORDS: org-mode, indexing, publishing
#+end_src
To specify the content of the description and keywords meta tags
for HTML output.
*** org-collector.el is now a contributed package
/org-collector.el/ provides functions to create tables by
collecting and processing properties from entries in a specific
scope like the current tree or file, or even from all agenda
files. General lisp expressions can be used to manipulate the
property values before they are inserted into an org-mode table,
for example as a dynamic block that is easy to update.
Thanks to Eric Schulte for yet another great contribution to
Org.
*** Update of org2rem.el
/org2rem.el/ has been updated significantly and now does a more
comprehensive job of exporting Org events to remind.
Thanks to Sharad Pratap for this update.
*** New div around the entire page in HTMP export
A new = = is wrapped around the entire page,
everything that is inside ==.
This means that you need to update /org-info.js/ (if you have a
local copy). It will be safe todo so, because the new
org-info.js still handles older pages correctly. Thanks to
Sebastian Rose for making these changes so quicky.
*** Clustering characters for undo
When typing in Org-mode, undo will now remove up to 20 characters
at a time with a single undo command. This is how things work
normally in Emacs, but the special binding of characters in
Org-mode made this impossible until now.
Thanks to Martin Pohlack for a patch which mimicks the behavior
of the Emacs command loop for the Org version of
=self-insert-command=. Note that this will not work in headlines
and tables because typing there will do a lot of extra work.
There might be a small typing performance hit resulting from this
change - please report in the mailing list if this is noticeable
and annoying.
*** Separate settings for special C-a and C-e
The variable `org-special-ctrl-a/e' now allows separate settings
for =C-a= and =C-e=. For example
#+begin_src emacs-lisp
(setq org-special-ctrl-a/e '(reversed . t))
#+end_src
Thanks to Alan Davis for this proposal.
*** orgstruct++-mode improvements
In addition to =orgstruct-mode= which allows to use some Org-mode
structure commands in other major modes, there is a more invasive
version of this mode: =orgstruct++-mode=. This mode will import
all paragraph and line wrapping variables into the major mode, so
that, for example, during typing the auto-fill wrapping of items
will work just like in Org-mode. This change is not reversible,
so turning off =orgstruct++-mode= will not remove these settings
again. =orgstruct++-mode= is most useful in text modes like
message-mode or =magit-log-edit-mode=. Furthermore,
=orgstruct++-mode= will recognize plain list context not only in
the first line of an item, but also further down, so that =M-RET=
will correctly insert new items.
Thanks to Austin Frank for requesting some of these changes.
*** Promotion and demotion works for regions now
=M-right= and =M-left= now do demote and promote all headlines in
an active region.
*** Match syntax for tags/properties is now described in a single place
The manual chapters about tags and about properties now only
refer to the section about agenda views, where the general syntax
of tag/property matches is described.
*** Macro replacement
A string like ={{{ title }}}= will be replaced by the title of
the document, ={{{ email }}}= by the email setting of the author
and similarly for other export settings given in =#+...= lines.
In addition to that, you can define an arbitrary number of
macros, for example:
#+begin_src org
,#+MACRO: myaddress 41 Onestreet, 12345 New York, NY
...
,my address is {{{myaddress}}}, see you there.
#+end_src
Macro replacement is the very first thing that happens during
export, and macros will be replaced even in source code and other
protected regions.
*** New reload command, with keyboard access
There is now a special command to reload all Org Lisp files, so
that you can stay in your Emacs session while pulling and
compiling changes to Org. The command to reload the compiled
files (if available) is =C-c C-x r=. If no compiled files are
found, uncompiled ones will be loaded. If you want to force
loading of uncompiled code (great for producing backtraces), use
a prefix arg: =C-u C-c C-x r=. Both commands are available in
the menu as well.
This new command was inspired by one written earlier by Bernt
Hansen.
*** Faces for priority cookies can now be set freely
The new variable =org-priority-faces= can be used to set faces
for each priority.
*** New key for creating tags/property sparse trees
The key to produce a sparse tree matching tags and properties is
now =C-c / m= instead of =C-c a T=. This is more consistent with
the =C-c a m= key for the corresponding agenda view. =C-c / T=
will still work for now, but it is no longer advertised in the
documentation and may go away at any time in the future.
*** IDs in HTML have "ID-" prefix when generated by uuidgen
/uuidgen/ generates IDs that often start with a number, not a
letter. However, IDs and names in XHTML must start with a letter.
Therefore, IDs in HTML files will now get an "ID-" prefix if they
have been generated by /uuidgen/. This means that id links from one
file to another may stop working until all files have been
exported again, so that both links and targets have the new prefix.
*** In agenda, only priority cookies get the special face
So far, an entire task would get a special face when
=org-agenda-fontify-priorities= was set. Now, the default value
for this variable is the symbol =cookies=, which means that on
the cookie is fontified. Set it to =t= if you want the entire
task headline to be fontified.
*** Turning off time-of-day search in headline
Some people like to put a creation time stamp into a headline and
then get confused if the time-of-day found in there shows up as
the time-of-day of the deadline/scheduling entry for this
headline. The reason for this is that Org searches the headline
for a free-format time when trying to sort the entry into the
agenda, and that search accidentally finds the time in the
creation time stamp or something else that happens to look like a
time. If this is more painful than useful for you, configure the
new variable =org-agenda-search-headline-for-time=.
* Version 6.23
:PROPERTIES:
:CUSTOM_ID: v6.23
:END:
** Overview
- Capture state change notes into a drawer
- Clock lines are now captured into the LOGBOOK drawer as well
- Added org-R.el to contrib directory
- Allow individual formatting of each TODO keyword in HTML export
- New hooks for add-ons to tap into context-sensitive commands
- Publishing files irrespective of extension
- New variable index in the manual
- The ORDERED property also influences checkboxes
- The ORDERED property can be tracked with a tag
- You may now specify line breaks in the fast tags interface
- When a TODO is blocked by checkboxes, keep it visible in agenda
- LaTeX can import Org's in-buffer definitions for TITLE, EMAIL etc.
** Incompatible changes
- CLOCK lines will now be captured into the LOGBOOK drawer.
See below for details.
** Details
*** Capture state change notes into a drawer
State change notes can now be captured into a drawer =LOGBOOK=,
to keep the entry tidy. If this is what you want, you will need
this configuration:
#+begin_src emacs-lisp
(setq org-log-into-drawer "LOGBOOK")
#+end_src
Thanks to Wanrong Lin for this proposal.
*** Clock lines are now captured into the LOGBOOK drawer as well
The =CLOCK= drawer will be abandoned, clock lines will now also
end up in a drawer =LOGBOOK=. The reason for this is that it's a
bit useless to have two different drawers for state change notes
and clock lines. If you wish to keep the old way, use
#+begin_src emacs-lisp
(setq org-clock-into-drawer "CLOCK")
#+end_src
*** Added org-R.el to contrib directory
Dan Davison has contributed /org-R.el/ which is now in the
contrib directory. Org-R performs numerical computations and
generates graphics. Data can come from org tables, or from csv
files; numerical output can be stored in the org buffer as org
tables, and links are created to files containing graphical
output. Although, behind the scenes, it uses R, you do not need
to know anything about R. Common operations, such as tabulating
discrete values in a column of an org table, are available "off
the shelf" by specifying options on lines starting with =#+R:=.
However, you can also provide raw R code to be evaluated. The
documentation is currently the worg tutorial at
http://orgmode.org/worg/org-tutorials/org-R/org-R.php
Thanks to Dan for this great contribution.
*** Allow individual formatting of TODO keyword and tags in HTML export
TODO keywords in HTML export have the CSS class =todo= or =done=.
Tags have the CSS class =tag=. In addition to this, each keyword
has now itself as class, so you could do this in your CSS file:
#+begin_src css
.todo { font-weight:bold; }
.done { font-weight:bold; }
.TODO { color:red; }
.WAITING { color:orange; }
.DONE { color:green; }
#+end_src
If any of your keywords causes conflicts with CSS classes used
for different purposes (for example a tag "title" would cause a
conflict with the class used for formatting the document title),
then you can use the variables =org-export-html-tag-class-prefix=
and =org-export-html-todo-kwd-class-prefix= to define prefixes
for the class names for keywords, for example "kwd-".
Thanks to Wanrong Lin for this request, and to Sebastian Rose for
help with the implementation.
*** New hooks for add-ons to tap into context-sensitive commands
Some commands in Org are context-sensitive, they will execute
different functions depending on context. The most important
example is of course =C-c C-c=, but also the =M-cursor= keys fall
into this category.
Org has now a system of hooks that can be used by add-on packages
to install their own functionality into these keys. See the
docstring of =org-ctrl-c-ctrl-c-hook= for details. The other
hooks are named like =org-metaleft-hook= or
=org-shiftmetaright-hook=.
*** Publishing files irrespective of extension
If you set the =:base-extension= property for a publishing
project to the symbol =any=, all files in the directory will be
published, irrespective of extension.
Thanks to Richard Klinda for a patch to this effect.
*** New variable index in the manual
A new index in the manual lists all variables mentioned in the
manual, about 200 variables in total.
*** The ORDERED property also influences checkboxes
When an entry has the ORDERED property set, checkboxes in
the entry must be completed in order. This was already the case
for children TODO items, now it also applies for checkboxes.
Thanks to Rainer Stengele for this proposal.
*** The ORDERED property can be tracked with a tag
The =ORDERED= property is used to flag an entry so that subtasks
(both children TODO items and checkboxes) must be completed in
order. This property is most easily toggled with the command
=C-c C-x o=. A property was chosen for this functionality,
because this should be a behavior local to the current task, not
inherited like tags. However, properties are normally
invisible. If you would like visual feedback on the state of
this property, configure the variable
=org-track-ordered-property-with-tag=. If you then use =C-c C-x
o= to toggle the property, a tag will be toggled as well, for
visual feedback.
Note that the tag itself has no meaning for the behavior of TODO
items and checkboxes, and that changing the tag with the usual
tag commands will not influence the property and therefore the
behavior of TODO and checkbox commands.
*** You may now specify line breaks in the fast tags interface
Up to now, the fast tags interface tried to lump as many tags as
possible into a single line, with the exception that groups would
always be on a line by themselves.
Now, if you use several lines to define your tags, like
#+begin_src org
,#+TAGS: aa(a) bb(b) cc(c)
,#+TAGS: dd(d) ee(e) ff(f)
#+end_src
then there will also be a line break after the "cc" tag in the
fast tag selection interface. You may also write
#+begin_src org
,#+TAGS: aa(a) bb(b) cc(c) \n dd(d) ee(e) ff(f)
#+end_src
to achieve the same effect, and you can use =\n= several times in
order to produce empty lines. In =org-tag-alist=, newlines are
represented as =(:newline)=.
Thanks to Christopher Suckling for a patch to this effect.
*** When a TODO is blocked by checkboxes, keep it visible in agenda
When the variable =org-agenda-dim-blocked-tasks= is set to
=invisible=, tasks that are blocked will not be visible in the
agenda. If the blocking is due to child TODO entries, this does
make sense because the children themselves will show up in the
TODO list.
However, as John Rakestraw has [[http://thread.gmane.org/gmane.emacs.orgmode/10939][pointed out]], if the blocking is
done by checkboxes, no trace of these subtasks is left.
Therefore, when the blocking is done by checkboxes, we now
overrule the =invisible= setting and replace it with mere dimming
of the task.
*** LaTeX can import Org's in-buffer definitions for TITLE, EMAIL etc.
If you configure =org-export-latex-import-inbuffer-stuff=,
in-buffer definitions like #+TITLE will be made available in the
LaTeX file as =\orgTITLE=.
This was a request by Russel Adams.
* Version 6.22
:PROPERTIES:
:CUSTOM_ID: v6.22
:END:
** Details
*** org-choose.el by Tom Breton is now included
Org-choose helps documenting a decision-making process by using
TODO keywords for different degrees of /chosenness/, and by
automatically keeping a set of alternatives in a consistent state.
Documentation for /org-choose.el/ is available [[http://orgmode.org/worg/org-contrib/org-choose.php][here]].
This package inserts itself into Org using hooks, so if other
people would like to do interesting stuff with TODO keywords for
special purposes, looking at Tom's code might be a good way to
start.
Thanks to Tom for this interesting contribution!
*** orgmode.org and Worg css works now better on IE
Thanks to Sebastian Rose for making these changes.
*** When exporting a subtree, headline levels are now relative to parent
This was reported as a bug by William Henney and is fixed now.
*** Inactive dates in tables can be used for sorting.
When sorting table fields or entries by date, Org first tries to
find an active date, and, if none exist, uses a passive date if
present.
This was a request by Hsui-Khuen Tang
*** The default for =org-return-follows-link= is back to =nil=
Setting it to =t= violates Emacs rules to some extent. The
internal implementation of this has been improved, so setting it
to =t= should now be pretty stable.
*** Automatic scheduling of siblings with org-depend.el
The sibling of a DONE task can now automatically be scheduled.
This was a patch by Andrew Hyatt.
*** New skipping conditions
The functions =org-agenda-skip-entry-if= and
=org-agenda-skip-subtree-if= now accept =timestamp= and
=nottimestamp= as additional conditions.
This was in response to a request by Saurabh Agrawal.
* Version 6.21
:PROPERTIES:
:CUSTOM_ID: v6.21
:END:
** Details
*** Changes to some default values of variables:
Here are the new default values:
#+begin_example
(setq org-return-follows-link t)
(setq org-use-fast-todo-selection t)
(setq org-yank-adjusted-subtrees nil)
(setq org-tags-column -77)
(setq org-agenda-sorting-strategy
'((agenda time-up priority-down category-keep)
(todo time-up priority-down category-keep)
(tags time-up priority-down category-keep)
(search category-keep)))
#+end_example
*** Final cleanup for Emacs 21.1 pretest
* Version 6.20
:PROPERTIES:
:CUSTOM_ID: v6.20
:END:
** Details
*** Support for simple TODO dependencies
John Wiegley's code for enforcing simple TODO dependencies has
been integrated into Org-mode. Thanks John!
The structure of Org files (hierarchy and lists) makes it easy to
define TODO dependencies. A parent TODO task should not be
marked DONE until all subtasks (defined as children tasks) are
marked as DONE. And sometimes there is a logical sequence to a
number of (sub)tasks, so that one task cannot be acted upon
before all siblings above it are done. If you customize the
variable =org-enforce-todo-dependencies=, Org will block entries
from changing state while they have children that are not DONE.
Furthermore, if an entry has a property =ORDERED=, each of its
children will be blocked until all earlier siblings are marked
DONE. Here is an example:
#+begin_src org
,* TODO Blocked until (two) is done
,** DONE one
,** TODO two
,* Parent
, :PROPERTIES:
, :ORDERED: t
, :END:
,** TODO a
,** TODO b, needs to wait for (a)
,** TODO c, needs to wait for (a) and (b)
#+end_src
The command =C-c C-x o= toggles the value of the =ORDERED=
property.
The variable =org-agenda-dim-blocked-tasks= controls how blocked
entries should appear in the agenda, where they can be dimmed or
even made invisible.
Furthermore, you can use the variable
=org-enforce-todo-checkbox-dependencies= to block TODO entries
from switching to DONE while any checkboxes are unchecked in the entry.
*** Support for shift-selection in Emacs 23
Customize the variable =org-support-shift-select= to use S-cursor
key for selecting text. Make sure that you carefully read the
docstring of that variable first.
*** Adding and removing checkboxes from many lines
The command =C-c C-x C-b= normally toggles checkbox status in the
current line, or in all lines in the region. With prefix
argument it now either adds or removes the checkbox.
This was a requested by Daniel Clemente.
* Version 6.19
:PROPERTIES:
:CUSTOM_ID: v6.19
:END:
** Overview
- Improved behavior of conversion commands =C-c -= and =C-c *=
- Table formulas may now reference fields in other tables
- A final hline is imagined in each table, for the sake of references
- A tags-todo search can now ignore timestamped items
- =\par= can be used to force a paragraph break, also in footnotes
** Details
*** Improved behavior of conversion commands =C-c -= and =C-c *=
The conversion commands =C-c -= and =C-c *= are now better
behaved and therefore more useful, I hope.
If there is an active region, these commands will act on the
region, otherwise on the current line.
- C-c - :: This command turns headings or normal lines into
items, or items into normal lines. When there is a
region, everything depends on the first line of the
region:
- if it is a item, turn all items in the region into
normal lines.
- if it is a headline, turn all headlines in the region
into items.
- if it is a normal line, turn all lines into items.
- special case: if there is no active region and the
current line is an item, cycle the bullet type of the
current list.
- C-c * :: This command turns items and normal lines into
headings, or headings into normal lines. When there is
a region, everything depends on the first line of the
region:
- if it is a item, turn all items in the region into
headlines.
- if it is a headline, turn all headlines in the region
into normal lines.
- if it is a normal line, turn all lines into headlines.
*** Table formulas may now reference fields in other tables
You may now reference constants, fields and ranges from a
different table, either in the current file or even in a
different file. The syntax is
: remote(NAME-OR-ID,REF)
where /NAME/ can be the name of a table in the current file as
set by a =#+TBLNAME: NAME= line before the table. It can also be
the ID of an entry, even in a different file, and the reference
then refers to the first table in that entry. /REF/ is an
absolute field or range reference, valid in the referenced table.
Note that since there is no "current filed" for the remote table,
all row and column references must be absolute, not relative.
*** A final hline is imagined in each table, for the sake of references
Even if a table does not end with a hline (mine never do because I
think it is not pretty), for the sake of references you can
assume there is one. So in the following table
#+begin_src org
| a | b |
|---+---|
| 1 | 2 |
| 3 | 4 |
#+end_src
a reference like =@I$1..@II$2= will now work.
*** A tags-todo search can now ignore timestamped items
The variables =org-agenda-todo-ignore-with-date=,
=org-agenda-todo-ignore-with-date=, and
=org-agenda-todo-ignore-with-date= make it possible to
exclude TODO entries which have this kind of planning info
associated with them. This is most useful for people who
schedule everything, and who use the TODO list mainly to find
things that are not yet scheduled. Thomas Morgan pointed out
that also the tags-todo search may serve exactly this
purpose, and that it might be good to have a way to make
these variables also apply to the tags-todo search. I can
see that, but could not convince myself to make this the
default. A new variable must be set to make this happen:
=org-agenda-tags-todo-honor-ignore-options=.
*** =\par= can be used to force a paragraph break, also in footnotes
The LaTeX idiom =\par= will insert a paragraph break at that
location. Normally you would simply leave an empty line to get
such a break, but this is useful for footnotes whose
definitions may not contain empty lines.
* Version 6.18
:PROPERTIES:
:CUSTOM_ID: v6.18
:END:
** Incompatible changes
*** Short examples must have a space after the colon
Short literal examples can be created by preceding lines
with a colon. Such lines must now have a space after the
colon. I believe this is already general practice, but now
it must be like this. The only exception are lines that are
empty except for the colon.
** Details
*** Include files can now also process switches
The example and src switches like =-n= can now also be added
to include file statements:
: #+INCLUDE "~/.emacs" src emacs-lisp -n -r
Thanks to Manish for pointing out that this was not yet
supported.
*** Examples can be exported to HTML as text areas
You can now specify a =-t= switch to an example or src block,
to make it export to HTML as a text area. To change the
defaults for height (number of lines in the example) and
width of this area (80), use the =-h= and =-w= switches.
Thanks to Ulf Stegemann for driving this development.
*** LaTeX_CLASS can be given as a property
When exporting a single subtree by selecting it as a region
before export, the LaTeX class for the export will be taken
from the =LaTeX_CLASS= property of the entry if present.
Thanks to Robert Goldman for this request.
*** Better handling of inlined images in different backends
Two new variables govern which kind of files can be inlined
during export. These are
=org-export-html-inline-image-extensions= and
=org-export-latex-inline-image-extensions=. Remember that
links are turned into an inline image if they are a pure link
with no description. HTML files can inline /.png/, /.jpg/,
and /.gif/ files, while LaTeX files, when processed with
/pdflatex/, can inline /.png/, /.jpg/, and /.pdf/ files.
These also represent the default settings for the new
variables. Note that this means that pure links to /.pdf/
files will be inlined - to avoid this for a particular link,
make sure that the link has a description part which is not
equal to the link part.
*** Links by ID now continue to work in HTML exported files
If you make links by ID, these links will now still work in
HTML exported files, provided that you keep the relative path
from link to target file the same.
Thanks to Friedrich Delgado Friedrichs for pushing this over
the line.
*** The relative timer can be paused
The new command `C-c C-x ,' will pause the relative timer.
When the relative timer is running, its value will be shown
in the mode line. To get rid of this display, you need to
really stop the timer with `C-u C-c C-x ,'.
Thanks to Alan Davis for driving this change.
*** The attachment directory may now be chosen by the user
Instead of using the automatic, unique directory related to
the entry ID, you can also use a chosen directory for the
attachments of an entry. This directory is specified by the
ATTACH_DIR property. You can use `C-c C-a s' to set this
property.
Thanks to Jason Jackson for this proposal.
*** You can use a single attachment directory for a subtree
By setting the property ATTACH_DIR_INHERIT, you can now tell
Org that children of the entry should use the same directory
for attachments, unless a child explicitly defines its own
directory with the ATTACH_DIR property. You can use the
command `C-c C-a i' to set this property in an entry.
* Version 6.17
:PROPERTIES:
:CUSTOM_ID: v6.17
:END:
** Overview
- Footnote support
- Line numbers and references in literal examples
- New hooks for export preprocessing
- Capture column view into a different file
** Details
*** Footnote support
Org-mode now directly supports the creation of footnotes. In
contrast to the /footnote.el/ package, Org-mode's footnotes are
designed for work on a larger document, not only for one-off
documents like emails. The basic syntax is similar to the one
used by /footnote.el/, i.e. a footnote is defined in a paragraph
that is started by a footnote marker in square brackets in column
0, no indentation allowed. The footnote reference is simply the
marker in square brackets inside text. For example:
#+begin_src org
The Org homepage[fn:1] now looks a lot better than it used to.
...
[fn:1] The link is: http://orgmode.org
#+end_src
Org-mode extends the number-based syntax to /named/ footnotes and
optional inline definition. Using plain numbers as markers is
supported for backward compatibility, but not encouraged because
of possible conflicts with LaTeX syntax. Here are the valid
references:
- [1] :: A plain numeric footnote marker.
- [fn:name] :: A named footnote reference, where `name' is a
unique label word or, for simplicity of automatic creation,
a number.
- [fn:: This is the inline definition of this footnote] :: A
LaTeX-like anonymous footnote where the definition is given
directly at the reference point.
- [fn:name: a definition] :: An inline definition of a footnote,
which also specifies a name for the note. Since Org allows
multiple references to the same note, you can then use use
`[fn:name]' to create additional references.
Footnote labels can be created automatically, or you create names
yourself. This is handled by the variable
=org-footnote-auto-label= and its corresponding =#+STARTUP=
keywords, see the docstring of that variable for details.
The following command handles footnotes:
- C-c C-x f :: The footnote action command. When the cursor is
on a footnote reference, jump to the definition. When it is
at a definition, jump to the (first) reference. Otherwise,
create a new footnote. Depending on the variable
`org-footnote-define-inline' (with associated =#+STARTUP=
options =fninline= and =nofninline=), the definitions will
be placed right into the text as part of the reference, or
separately into the location determined by the variable
=org-footnote-section=.
When this command is called with a prefix argument, a menu
of additional options is offered:
- s :: Sort the footnote definitions by reference sequence.
During editing, Org makes no effort to sort footnote
definitions into a particular sequence. If you want
them sorted, use this command, which will also move
entries according to =org-footnote-section=.
- n :: Normalize the footnotes by collecting all
definitions (including inline definitions) into a
special section, and then numbering them in
sequence. The references will then also be
numbers. This is meant to be the final step before
finishing a document (e.g. sending off an email).
The exporters do this automatically, and so could
something like `message-send-hook'.
- d :: Delete the footnote at point, and all references to it.
- C-c C-c :: If the cursor is on a footnote reference, jump to
the definition. If it is a the definition, jump back to the
reference. When called with a prefix argument at either
location, offer the same menu as `C-u C-c C-x f'.
- C-c C-o or mouse-1/2 :: Footnote labels are also links to the
corresponding definition/reference, and you can use the
usual commands to follow these links.
Org-mode's footnote support is designed so that it should also
work in buffers that are not in Org-mode, for example in email
messages. Just bind =org-footnote-action= to a global key like
=C-c f=.
The main trigger for this development came from a hook function
written by Paul Rivier, to implement named footnotes and to
convert them to numbered ones before export. Thanks, Paul!
Thanks also to Scot Becker for a thoughtful post bringing this
subject back onto the discussion table, and to Matt Lundin for
the idea of named footnotes and his prompt testing of the new
features.
*** Line numbers and references in literal examples
Literal examples introduced with =#+BEGIN_EXAMPLE= or =#+BEGIN_SRC=
do now allow optional line numbering in the example.
Furthermore, links to specific code lines are supported, greatly
increasing Org-mode's utility for writing tutorials and other
similar documents.
Code references use special labels embedded directly into the
source code. Such labels look like "(ref:name)" and must be
unique within a document. Org-mode links with "(name)" in the
link part will be correctly interpreted, both while working with
an Org file (internal links), and while exporting to the
different backends. Line numbering and code references are
supported for all three major backends, HTML, LaTeX, and ASCII.
In the HTML backend, hovering the mouse over a link to a source
line will remote-highlight the referenced code line.
The options for the BEGIN lines are:
- -n :: Number the lines in the example
- +n :: Like -n, but continue numbering from where the previous
example left off.
- -r :: Remove the coderef cookies from the example, and replace
links to this reference with line numbers. This option
takes only effect if either -n or +n are given as well.
If -r is not given, coderefs simply use the label name.
- -l "fmt" :: Define a local format for coderef labels, see the
variable =org-coderef-label-format= for details. Use this
of the default syntax causes conflicts with the code in the
code snippet you are using.
Here is an example:
#+begin_example -k
#+begin_src emacs-lisp -n -r
(defmacro org-unmodified (&rest body) (ref:def)
"Execute body without changing `buffer-modified-p'."
`(set-buffer-modified-p (ref:back)
(prog1 (buffer-modified-p) ,@body)))
#+end_src
[[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
backquoting is used.
#+end_example
When exported, this is translated to:
#+begin_src emacs-lisp -n -r
(defmacro org-unmodified (&rest body) (ref:def)
"Execute body without changing `buffer-modified-p'."
`(set-buffer-modified-p (ref:back)
(prog1 (buffer-modified-p) ,@body)))
#+end_src
[[(def)][Line (def)]] contains the macro name. Later at line [[(back)]],
backquoting is used.
Thanks to Ilya Shlyakhter for proposing this feature set. Thanks
to Sebastian Rose for the key Javascript element that made the
remote highlighting possible.
*** New hooks for export preprocessing
The export preprocessor now runs more hooks, to allow
better-timed tweaking by user functions:
- =org-export-preprocess-hook= ::
Pretty much the first thing in the preprocessor. But org-mode
is already active in the preprocessing buffer.
- =org-export-preprocess-after-include-files-hook= ::
This is run after the contents of included files have been inserted.
- =org-export-preprocess-after-tree-selection-hook= ::
This is run after selection of trees to be exported has
happened. This selection includes tags-based selection, as
well as removal of commented and archived trees.
- =org-export-preprocess-before-backend-specifics-hook= ::
Hook run before backend-specific functions are called during preprocessing.
- =org-export-preprocess-final-hook= ::
Hook for preprocessing an export buffer. This is run as the
last thing in the preprocessing buffer, just before returning
the buffer string to the backend.
*** Capture column view into a different file
The :id parameter for the dynamic block capturing column view
can now truly be an ID that will also be found in a
different file. Also, it can be like =file:path/to/file=, to
capture the global column view from a different file.
Thanks to Francois Lagarde for his report that IDs outside
the current file would not work.
* Version 6.16
:PROPERTIES:
:CUSTOM_ID: v6.16
:END:
Cleanup of many small bugs, and one new feature.
** Details
*** References to last table row with special names
Fields in the last row of a table can now be referenced with
$LR1, $LR2, etc. These references can appear both on the
left hand side and right hand side of a formula.
* Version 6.15f
:PROPERTIES:
:CUSTOM_ID: v6.15f
:END:
This version reverses the introduction of @0 as a reference to
the last rwo in a table, because of a conflict with the use of
@0 for the current row.
* Version 6.15
:PROPERTIES:
:CUSTOM_ID: v6.15
:END:
** Overview
- All known LaTeX export issues fixed
- Captions and attributes for figures and tables.
- Better implementation for entry IDs
- Spreadsheet references to the last table line.
- Old syntax for link attributes abandoned
** Incompatible changes
*** Old syntax for link attributes abandoned
There used to be a syntax for setting link attributes for
HTML export by enclosing the attributes into double braces
and adding them to the link itself, like
#+begin_example
[[./img/a.jpg{{alt="an image"}}] ]
#+end_example
This syntax is not longer supported, use instead
#+begin_src org
,#+ATTR_HTML: alt="an image"
[[./img/a.jpg] ]
#+end_src
** Details
*** All known LaTeX export issues fixed
All the remaining issues with the LaTeX exporter have hopefully
been addressed in this release. In particular, this covers
quoting of special characters in tables and problems with
exporting files where the headline is in the first line, or with
an active region.
*** Captions and attributes for figures and tables.
Tables, and Hyperlinks that represent inlined images, can now be
equipped with additional information that will be used during
export. The information will be taken from the following special
lines in the buffer and apply to the first following table or
link.
- #+CAPTION: :: The caption of the image or table. This string
should be processed according to the export backend, but
this is not yet done.
- #+LABEL: :: A label to identify the figure/table for cross
references. For HTML export, this string will become the
ID for the ~ |