ORG NEWS -- history of user-visible changes. -*- mode: org; coding: utf-8 -*- #+STARTUP: overview #+LINK: doc https://orgmode.org/worg/doc.html#%s #+LINK: msg https://list.orgmode.org/%s/ #+LINK: git https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=%s Copyright (C) 2012-2024 Free Software Foundation, Inc. See the end of the file for license conditions. Please send Org bug reports to mailto:emacs-orgmode@gnu.org. * Version 9.8 (not released yet) ** Important announcements and breaking changes # Here, we list the *most important* changes and changes that _likely_ # require user action for most Org mode users. # Sorted from most important to least important. *** =C-c C-x C-v= command toggling inline image display has been reworked Previously, =C-c C-x C-v= always toggled image display in the whole buffer (or narrowed part of the buffer). With prefix argument, it also forced displaying image links with description. Now, =C-c C-x C-v= is bound to a new command ~org-link-preview~, which uses different defaults: 1. When the region is active, images in the region are previewed 2. Otherwise, if there is an image at point, it is toggled. If there is no image at point, images in the current entry are previewed 3. With the =C-u= argument, image previews in the active region or at point are cleared instead 4. The =C-u C-u= argument unconditionally shows all images in the accessible portion of the buffer 5. The =C-u C-u C-u= argument unconditionally clears all images in the accessible portion of the buffer 6. Displaying images over links with description can be forced using numeric argument: - ~C-u 1~ for toggling all images at point/current entry - ~C-u 11~ for toggling all images in buffer (The first five of these prefix arg behaviors are the same as that of the ~org-latex-preview~ command.) In addition to images, ~org-link-preview~ can also be used to preview Org links of all types for which preview behavior is defined, see [[#link-preview][previews for arbitrary link types]]. The old ~org-toggle-inline-images~ command is obsolete but still available. You can bind it back to =C-c C-x C-v= by adding the following to your config: #+begin_src emacs-lisp (eval-after-load 'org-keys (org-defkey org-mode-map (kbd "C-c C-x C-v") #'org-toggle-inline-images)) #+end_src *** Org mode may throw an error when attempting to include remote unsafe resource noninteractively Previously, when ~org-resource-download-policy~ is ~ask~ (default), and Emacs is running in batch mode, Org mode simply skipped unsafe remote resources in the =#+include:='s. Now, an error is thrown to avoid seemingly ignored =#+include= statements when publishing via batch scripts. *** Diary-style timestamps are exported together with active timestamps ~org-export-with-timestamps~ and ~org-icalendar-with-timestamps~ now treat diary-style timestamps as a type of active timestamp for purposes of export. This mainly affects iCalendar export, where diary timestamps will now be included when only active timestamps are exported (the default). This should have minimal impact on non-iCalendar exporters, since ~org-export-with-timestamps~ was already ~t~ by default. However, users who manually set ~org-export-with-timestamps~ to ~active~ will now have diary timestamps included as well. ** New features # We list the most important features, and the features that may # require user action to be used. *** All Org link types can be previewed :PROPERTIES: :CUSTOM_ID: link-preview :END: Org links support a new parameter =:preview= that can be used to preview arbitrary link types. The value of this parameter should be a function that is called to preview links of the corresponding type (see ~org-link-parameters~). *** Alignment of image previews can be customized This is not a new feature. It has been added in Org 9.7, but not documented in the news. See [[#preview-align][restrospectively added news entry]]. *** Beamer export supports setting frame subtitles If a headline is exported as a frame, and has its =BEAMER_SUBTITLE= property set, the value is used as the subtitle. *** =ol.el=: New =shortdoc= link type You can now create links to =shortdoc= documentation groups for Emacs Lisp functions (see =M-x shortdoc-display-group=). Requires Emacs 28 or newer. *** Some navigation commands can now be repeated When ~repeat-mode~ is turned on, the following navigation commands can be repeated: | Command | Key binding | Repeat key | |-----------------------------------+------------------------+--------------| | ~org-next-visible-heading~ | {{{kbd(C-c C-n)}}} | {{{kbd(n)}}} | | ~org-previous-visible-heading~ | {{{kbd(C-c C-p)}}} | {{{kbd(p)}}} | | ~org-forward-heading-same-level~ | {{{kbd(C-c C-f)}}} | {{{kbd(f)}}} | | ~org-backward-heading-same-level~ | {{{kbd(C-c C-b)}}} | {{{kbd(b)}}} | | ~org-up-heading~ | {{{kbd(C-c C-u)}}} | {{{kbd(u)}}} | | ~org-next-block~ | {{{kbd(C-c M-f)}}} | {{{kbd(f)}}} | | ~org-previous-block~ | {{{kbd(C-c M-b)}}} | {{{kbd(b)}}} | | ~org-next-link~ | {{{kbd(C-c C-x C-n)}}} | {{{kbd(n)}}} | | ~org-previous-link~ | {{{kbd(C-c C-x C-p)}}} | {{{kbd(p)}}} | The keybindings in the repeat-maps can be changed by customizing ~org-navigation-repeat-map~, ~org-link-navigation-repeat-map~, and ~org-block-navigation-repeat-map~. See the new [[info:org#Repeating commands]["Repeating commands"]] section in Org mode manual. ** New and changed options # Chanes deadling with changing default values of customizations, # adding new customizations, or changing the interpretation of the # existing customizations. *** New option ~org-link-preview-batch-size~ Org link previews are generated asynchronously and a few at a time, in batches. This option controls the number of links that are previewed in each batch. *** New option ~org-link-preview-delay~ Org link previews are generated asynchronously. This option controls the minimum idle time in seconds between previews of batches of links. *** Allow disabling macro replacement during export New custom option ~org-export-replace-macros~ controls whether Org mode replaces macros in the buffer before export. Set it to nil to disable macro replacement. This variable has no effect on the ={{{results...}}}= macros for inline code block results. *** Allow headline/olp target in ~org-capture-templates~ to be a function/variable The variable ~org-capture-templates~ accepts a target specification as function or symbol for headline (~file+headline~) and olp (~file+olp~ and ~file+olp+datetree~). *** New =%\*N= placeholder in ~org-capture-templates~ The new placeholder is like =%\N=, gives access not only to the =%^{prompt}= values, but also to =%^{prompt}X= values. *** The default value of ~org-babel-latex-process-alist~ is no longer taken from ~org-preview-latex-process-alist~ The default value used to be pulled from =dvipng= process type from ~org-preview-latex-process-alist~. Now, it defaults to using =latexmk= (when available), or running =latex= multiple times, so that all the references are resolved in the generated png. *** New option ~org-cite-csl-bibtex-titles-to-sentence-case~ When this option is non-nil then title fields in bibtex bibliography entries are converted to sentence-case before being formatted according to a CSL style, except for entries with a =langid= field specifying a non-English language. When nil, this conversion is limited to entries having a =langid= field specifying a variant of English. The default value is ~t~ as the CSL standard assumes that English titles are specified in sentence-case but the bibtex bibliography format requires them to be written in title-case. ** New functions and changes in function arguments # This also includes changes in function behavior from Elisp perspective. *** New command ~org-link-preview~ to preview Org links This command replaces ~org-toggle-inline-images~, which is now obsolete. *** New command ~org-link-preview-region~ to preview Org links in a region or the buffer This command replaces ~org-display-inline-images~, which is now obsolete. *** New command ~org-link-preview-clear~ to clear Org link previews in a region or the buffer This command replaces ~org-remove-inline-images~, which is now obsolete. *** New command ~org-link-preview-refresh~ to refresh Org link previews in the buffer This command replaces ~org-redisplay-inline-images~, which is now obsolete. *** ob-sqlite: Added ability to open a database in readonly mode Added option :readonly to ob-sqlite. When :readonly=true the database is opened in readonly mode. For example: #+begin_src sqlite :db /tmp/rip.db :readonly yes :exports both create table rip(a,b); #+end_src This results in an error such as: #+begin_example Runtime error near line 2: attempt to write a readonly database (8) [ Babel evaluation exited with code 1 ] #+end_example *** ~org-html-head~ and ~org-html-head-extra~ can now be specified as functions Previously, ~org-html-head~ and ~org-html-head-extra~ could only be specified directly as strings. Now, they can be set to functions that accept the INFO channel and return a string. This makes it possible to dynamically generate the content of the resulting ~~ tag in the resulting HTML document. *** ob-comint: New optional arguments controlling prompt handling The new argument ~prompt-handling~ in ~org-babel-comint-with-output~ and ~org-babel-comint-async-register~ allows Babel languages to specify how prompts should be handled in comint output. If equal to ~filter-prompts~, prompts are removed from output before it is passed on to language-specific processing. If equal to ~disable-prompt-filtering~, then the prompt filtering is skipped. If unset, then the default behavior is the same as ~filter-prompts~ for backwards compatibility. Prompt filtering is needed for some Babel languages, such as ob-shell, which leave extra prompts in the output as a side effect of evaluation. However other Babel languages, like ob-python, don't leave extra prompts after evaluation, and skipping the prompt filtering can be more robust for such languages (as this avoids removing false positive prompts). ** Removed or renamed functions and variables *** ~org-cycle-display-inline-images~ is renamed to ~org-cycle-display-link-previews~ Inline image previews in Org mode are now provided by the more general link previews feature. The behavior with regards to image links is unchanged. *** ~org-cycle-inline-images-display~ is renamed to ~org-cycle-link-previews-display~ The behavior is unchanged, except in that the new variable now affects previews of supported link types besides image links. *** ~org-startup-with-inline-images~ is renamed to ~org-startup-with-link-previews~ The behavior is unchanged, except in that the new variable now affects previews of supported link types besides image links. ** Miscellaneous *** Org mode no longer prevents =flyspell= from spell-checking inside =LOGBOOK= drawers Previously, spell-checking via =flyspell= was disabled inside =LOGBOOK= (or ~org-log-into-drawer~) drawers. Now, it is no longer the case. It can be useful to see spelling mistakes inside notes added via ~org-add-note~ command. *** ~ob-R~ and ~ob-julia~ no longer use ESS settings for working directory Previously, without =:dir= parameter, R and Julia code blocks could query for working directory during evaluation. This was because ~ess-ask-for-ess-directory~ setting was obeyed. Now, ~ess-ask-for-ess-directory~, ~ess-directory-function~, and ~ess-directory~ are all ignored during code block evaluation (except when session is already running). In other words, R and Julia code blocks now conform to the "16.4 Environment of a Code Block" section of Org mode manual that prescribes Org buffer directory or ~:dir~ value to be used as working dir to run the code blocks. *** ~org-cancel-repeater~ now cancels all the repeaters under inside entry Previously, ~org-cacnel-repeater~ only canceled repeater in the first active timestamp inside heading. Now, all the repeaters are cancelled. The function is renamed to ~org-cacnel-repeaters~ accordingly (the old name is still kept as an alias). *** ~org-refile~ now saves current position to Org mark ring when jumping to heading When ~org-refile~ is called with =C-u= or =C-u C-u= prefix argument (to jump to heading or to jump to the last refiled heading), it saves point to Org mark ring before jumping. Then, the user can return back via ~org-mark-ring-goto~. *** ~orgtbl-to-generic~ retains special rows when exporting to Org Previously, special table rows were unconditionally removed when export to Org. Now, the defaults follow what ox-org does - to retain special rows by default. See [[*=ox-org= now exports special table rows by default]]. To retain the old behaviour, add ~:with-special-rows nil~ to PARAMS argument: : (orgtbl-to-generic table '(:with-special-rows nil) *** Trailing =-= is now allowed in plain links Previously, plain links like : https://domain/test- did not include the trailing =-= punctuation. Now, the =-= is allowed at the end, and is considered a part of the plain link. #+begin_quote These types of links will likely be encountered for sites where anchor targets are automatically generated from documentation headings which are questions. https://list.orgmode.org/orgmode/87sexh9ddv.fsf@ice9.digital/ #+end_quote *** =org-attach= now considers symlinked files when searching pre-existing attach dirs When Org buffer is opened from a symlink, Org mode looks into the original file directory when searching if an attach directory already exists. This way, attachments will remain accessible when opening symlinked Org file. When no attach dir exists, Org mode will still prefer creating it in the "default" directory - where the symlink is located. *** Texinfo exporter now supports links in headings The Texinfo exporter no longer removes links from headings. This applies to all headings, below and above the =H= and =toc= export =#+OPTIONS:=. * Version 9.7 ** Important announcements and breaking changes # Here, we list the *most important* changes and changes that _likely_ # require user action for most Org mode users. # Sorted from most important to least important. *** Arbitrary shell commands may no longer run when turning on Org mode This is for security reasons, to avoid running malicious commands. *** =python-mode.el (MELPA)= support in =ob-python.el= is removed =python-mode.el= support has been removed from =ob-python.el=. The related customization =org-babel-python-mode= has been changed to a constant. If you still want to use python-mode with ob-python, you might consider [[https://gitlab.com/jackkamm/ob-python-mode-mode][ob-python-mode-mode]], where the code to support python-mode has been ported to. *** It is no longer possible to reveal hidden parts of the links during isearch Org 9.6 introduced support for searching hidden parts of the links. Unfortunately, we had to drop this support because its implementation turned out to be unreliable for many users. Proper implementation would require patching =isearch.el= and possibly a number of external libraries implementing isearch equivalents. It cannot be done on Org side alone. *** =ox-latex=: ~org-latex-line-break-safe~ is deprecated ~org-latex-line-break-safe~ constant was previously introduced to deal with edge cases when LaTeX interprets [...] as LaTeX command argument. However, it caused a number of other issues and proved itself not to be as "safe" as it supposed to be. We now use a Pandoc's approach to deal with the same problem, utilizing ={[}= to escape =[...]= instances where needed. *** ~tab-width~ value is now assumed to be 8 Org mode now assumes tab width to be 8 characters, when calculating list and other indentation. ~tab-width~ is also set to 8 when Org major mode is loaded. This is done to improve consistency of the markup for lists, where indentation affects list items. Users with non-default values of ~tab-width~ should avoid overriding the value of 8 set by Org mode. If the custom ~tab-width~ value is _smaller_ than 8, the existing Org documents can be converted to the new standard tab width using the following helper command: #+begin_src emacs-lisp (defun org-compat-adjust-tab-width-in-buffer (old-width) "Adjust visual indentation from `tab-width' equal OLD-WIDTH to 8." (interactive "nOld `tab-width': ") (cl-assert (derived-mode-p 'org-mode)) (unless (= old-width 8) (org-with-wide-buffer (goto-char (point-min)) (let (bound (repl (if (< old-width 8) (make-string old-width ?\s) (concat "\t" (make-string (- old-width 8) ?\s))))) (while (re-search-forward "^ *\t" nil t) (skip-chars-forward " \t") (setq bound (point-marker)) (forward-line 0) (while (search-forward "\t" bound t) (replace-match repl))))))) #+end_src *** ~org-ctags~ is not activated by default any more To follow Emacs [[info:elisp#Coding Conventions][coding conventions]] and to avoid confusion of users who accidentally get ~org-ctags~ autoloaded due to help completion, the library does not modify ~org-open-link-functions~ during loading any more. Run ~org-ctags-enable~ to setup hooks and advices: #+begin_src emacs-lisp (with-eval-after-load "org-ctags" (org-ctags-enable)) #+end_src *** "Priority" used to sort items in agenda is renamed to "urgency" Previously, ~priority-up~ and ~priority-down~ in ~org-agenda-sorting-strategy~ used a composite rank depending on item's priority (=[#A]=, =[#B]=, =[#C]=, etc) and overdue time to order agenda items (see "11.4.3 Sorting of agenda items" section of Org manual). Now, this composite rank is renamed to =urgency= and the relevant sorting strategies are renamed to ~urgency-up~ and ~urgency-down~. ~priority-up~ and ~priority-down~ sort by item's priority only. Users relying on the previous composite ranking should adjust their agenda sorting settings. *** ~org-priority-show~ command no longer adjusts for scheduled/deadline In agenda views, ~org-priority-show~ command previously displayed the composite rank consisting of the item priority and overdue. This is no longer the case. The displayed and returned value only depends on the item priority now. The behavior in Org buffers is unchanged. *** =ox-icalendar.el= line ending fix may affect downstream packages iCalendar export now uses dos-style CRLF ("\r\n") line endings throughout, as required by the iCalendar specification (RFC 5545). Previously, the export used an inconsistent mix of dos and unix line endings. This might cause errors in external packages that parse output from ox-icalendar. In particular, older versions of org-caldav may encounter issues, and users are advised to update to the most recent version of org-caldav. See [[https://github.com/dengste/org-caldav/commit/618bf4cdc9be140ca1993901d017b7f18297f1b8][this org-caldav commit]] for more information. *** Icalendar export of unscheduled TODOs no longer have start time of today For TODOs without a scheduled start time, ox-icalendar no longer forces them to have a scheduled start time of today when exporting. Instead, the new customization ~org-icalendar-todo-unscheduled-start~ controls the exported start date for unscheduled tasks. Its default is ~recurring-deadline-warning~ which will export unscheduled tasks with no start date, unless it has a recurring deadline (in which case the iCalendar spec demands a start date, and ~org-deadline-warning-days~ is used for that). To revert to the old behavior, set ~org-icalendar-todo-unscheduled-start~ to ~current-datetime~. *** Built-in HTML, LaTeX, Man, Markdown, ODT, and Texinfo exporters preserve the link protocol during export Previously, some link types where not exported as =protocol:uri= but as bare =uri=. This is now changed. When a link is known by Org mode and does not have a custom ~:export~ parameter (see A.3 Adding Hyperlink Types section of the manual), the link protocol is now not stripped. For example, if one adds a link type =tel=, but does not define ~:export~ parameter : (org-link-set-parameters "tel") =[[tel:12345][John Doe]]= link will be correctly exported to LaTeX as =\href{tel:12345}{John Doe}=, not =\href{12345}{John Doe}=. However, links like =[[elisp:(+ 1 2)]]= will be exported as =\url{elisp:(+ 1 2)}=, which may be somewhat unexpected. *** =ox-html=: When exporting footnotes with custom non-number names, the names are used as link anchors Previously, link anchors for footnote references and footnote definitions were based on the footnote number: =fn.1=, =fnr.15=, etc. Now, when the footnote has a non-number name, it is used as an anchor: =fn.name=, =fnr.name=. *** =ox-org= disables citation processors by default Previously, when exporting to Org, all the citations and =print_bibliography= keywords, were transformed according to the chosen citation processor. This is no longer the case. All the citation-related markup is now exported as is. The previous behavior can be reverted by setting new custom option ~org-org-with-cite-processors~. *** ODT export no longer opens the exported file in the background ODT exporter used to open the exported file in ~archive-mode~ "for examination". This was not documented, was done in the background, and is not consistent with all other export backends. Now, this feature is removed. *** Inline image width value in =#+attr_org= is preferred over other =#+attr_...= keywords Previously, when ~org-image-actual-width~ is a list or nil, Org used the first =#+attr_...= keyword containing =:width ...= to compute the inline image width. Now, =#+attr_org=, if present, takes precedence. In the following example the image preview has width of 75% while earlier versions pick 33%. : #+attr_html: :width 33% : #+attr_org: :width 0.75 : [[image.png]] *** ~org-latex-to-mathml-convert-command~ and ~org-latex-to-html-convert-command~ may need to be adjusted Previously, =%i= placeholders in the ~org-latex-to-mathml-convert-command~ and ~org-latex-to-html-convert-command~ user options were replaced with raw LaTeX fragment text, potentially triggering shell-expansion and incorrect result. Now, the =%i= placeholders are shell-escaped to prevent shell expansion. If you have single or double quotes around =%i= then update customizations and remove quotes. *** ~org-insert-subheading~ no longer inserts a sub-heading above current when point is at the beginning of line Previously, calling ~org-insert-subheading~ on : * Heading 1 : * Heading 2 yielded : * Heading 1 : ** : * Heading 2 This is no longer the case. The sub-heading is always created below current heading (prefix arguments have the same meaning as in ~org-insert-heading~): : * Heading 1 : * Heading 2 : ** *** It is no longer allowed to tangle into the same file as Org source Previously, =file.org= with the following contents : #+begin_src org :tangle file.org : Text : #+end_src would overwrite itself. Now, an error is thrown. ** New features # We list the most important features, and the features that may # require user action to be used. *** Images and files in clipboard can be pasted Org asks the user what must be done when pasting images and files copied to the clipboard from a file manager using the ~yank-media~ command. The default action can be set by customizing ~org-yank-dnd-method~. The ~yank-media~ command was added in Emacs 29. Images can be saved to a separate directory instead of being attached, customize ~org-yank-image-save-method~. Image filename chosen can be customized by setting ~org-yank-image-file-name-function~ which by default autogenerates a filename based on the current time. Note that ~yank-media~, as of Emacs 30, does not yet support Windows (Emacs bug#71909) and may not be always reliable on Mac (Emacs bug#71731). *** Files and images can be attached by dropping onto Emacs By default, Org asks the user what to do with the dropped file like for pasted files. The same user option ~org-yank-dnd-method~ is respected. Images dropped also respect the value of ~org-yank-image-save-method~ when ~org-yank-dnd-method~ is =attach=. *** Alignment of image previews can be customized :PROPERTIES: :CUSTOM_ID: preview-align :END: Previously, all the image previews were always left-aligned. Now, you can customize image previews to be left-aligned, centered, or right-aligned. The customization can be done globally, via ~org-image-align~, or per image, using =#+attr_...:=. Example: : #+attr_org: :align center : [[/path/to/image/file/png]] : : or : : #+attr_org: :center t : [[/path/to/image/file/png]] When =#+attr_org= is not present, ~:align~ and ~:center~ attributes from other =#+attr_...:= keywords will be used. *** =id:= links support search options; ~org-id-store-link~ adds search option by default Adding search option by ~org-id-store-link~ can be disabled by setting ~org-id-link-use-context~ to ~nil~, or toggled for a single call by passing universal argument. When using this feature, IDs should not include =::=, which is used in links to indicate the start of the search string. For backwards compatibility, existing IDs including =::= will still be matched (but cannot be used together with search option). A new org-lint checker has been added to warn about this. *** Org mode no longer disallows configuring ~display-buffer-alist~ to open Org popups in other frame Previously, Org mode disallowed pop-up frames when displaying dispatch buffers. This is no longer the case. ~display-buffer-alist~ is fully obeyed. ~org-switch-to-buffer-other-window~ and ~org-no-popups~ are now deprecated. *** Asynchronous code evaluatation in ~ob-shell~ Running shell blocks with the ~:session~ header freezes Emacs until execution completes. The new ~:async~ header allows users to continue editing with Emacs while a ~:session~ block executes. *** Add support for repeating tasks in iCalendar export Repeating Scheduled and Deadline timestamps in TODOs are now exported as recurring tasks in iCalendar export. In case the TODO has just a single planning timestamp (Scheduled or Deadline, but not both), its repeater is used as the iCalendar recurrence rule (RRULE). If the TODO has both Scheduled and Deadline planning timestamps, then the following cases are implemented: - If both have the same repeater, then it is used as the RRULE. - Scheduled has repeater but Deadline does not: the Scheduled repeater is used as RRULE, and Deadline is used as UNTIL (the end date for the repeater). This is similar to ~repeated-after-deadline~ in ~org-agenda-skip-scheduled-if-deadline-is-shown~. The following 2 cases are not yet implemented, and the repeater is skipped (with a warning) if the ox-icalendar export encounters them: - Deadline has a repeater but Scheduled does not. - Scheduled and Deadline have different repeaters. Also note that only vanilla repeaters are currently exported; the special repeaters ~++~ and ~.+~ are skipped. *** Babel references =FILE:REFERENCE= now search current buffer when =FILE= does not exist When =FILE= does not exist, the reference is searched in the current file, using the verbatim reference. This way, =:var table=tbl:example= will be searched inside the current buffer. *** Folded lines can now extend their face beyond ellipsis Previously, ~:extend t~ face attribute did not make folded headlines, blocks, and drawers extend their face beyond end of line. Now, the ellipsis and trailing newline use the same face as the last character before the fold. *** iCalendar export now supports multiline =SUMMARY=, =LOCATION=, and =DESCRIPTION= properties Previously, it was not possible to specify multi-line location, summary, or description when exporting to iCalendar. In the following example, =LOCATION= was exported as "Someplace", ignoring the other lines. #+begin_src org ,* heading with multi-line property :PROPERTIES: :LOCATION: Someplace :LOCATION+: Some Street 5 :LOCATION+: 12345 Small Town :END: #+end_src Now, =SUMMARY+=, =LOCATION+=, and =DESCRIPTION+= properties can be used to create multi-line values. In the above example, =LOCATION= is now exported as : Someplace : Some Street 5 : 12345 Small Town *** Org export backends can now disable citation processors A new global export option ~:with-cite-processors~, when set to nil, disables citation processors completely. This option is available to export backends via ~:options-alist~ when defining the backend. The backends disabling citation processors must take care about exporting citation objects and =print_bibliography= keywords via transcoders. Users can disable citations processors by customizing new ~org-export-process-citations~ option. *** Org babel backends are now expected to define an additional API function ~org-babel-session-buffer:~ Org babel now uses session buffer (if it exists) to retrieve ~default-directory~ environment during src block evaluation. By default, buffer named like session is checked. All the backends that create sessions inside buffers named differently should provide a function ~org-babel-session-buffer:~. The function must accept two arguments - session name and info list (as returned by ~org-babel-get-src-block-info~); and return the session buffer name. *** ~org-paste-subtree~ now handles =C-u= and =C-u C-u= prefix arguments specially With =C-u= prefix argument, force inserting a sibling heading below. With =C-u C-u= prefix argument, force inserting a child heading. *** ~org-metaup~ and ~org-metadown~ now act on headings in region When region is active and starts at a heading, ~org-metaup~ and ~org-metadown~ will move all the selected subtrees. *** Many structure editing commands now do not deactivate region Moving, promoting, and demoting of headings and items in region now do not deactivate Transient mark mode. Users can thus conveniently select multiple headings/items and use, for example, =M-=/=M-= repeatedly without losing the selection. *** Capture templates now support ~(here)~ as a target A capture template can target ~(here)~ which is the equivalent of invoking a capture template with a zero prefix. *** =colview= dynamic block supports custom formatting function The =colview= dynamic block understands a new ~:formatter~ parameter, which specifies a user-supplied function to format and insert the data in the dynamic block. A global default formatting function for =colview= dynamic blocks can be set via the new option ~org-columns-dblock-formatter~ which defaults to the new function ~org-columns-dblock-write-default~, that implements the previous (fixed) formatting behavior. Hence, the default behavior is identical to previous versions. The global default function can be overridden for any given =colview= dynamic block individually by specifying a custom formatter function using the new ~:formatter~ parameter on the block's =BEGIN= line. This new feature replicates the ~:formatter~ option already available for =clocktable= dynamic blocks. *** =colview= dynamic block can link to headlines The =colview= dynamic block understands a new ~:link~ parameter, which when non-~nil~ causes =ITEM= headlines in the table to be linked to their origins. *** =ob-tangle.el=: New flag to remove tangle targets before writing When ~org-babel-tangle-remove-file-before-write~ is set to ~t~ the tangle target is removed before writing. This will allow overwriting read-only tangle targets. However, when tangle target is a symlink, this will convert the tangle target into an ordinary file. The default value is ~auto~ -- overwrite tangle targets when they are read-only. *** ~org-bibtex-yank~ accepts a prefix argument When called with a prefix argument, ~org-bibtex-yank~ adds data to the headline of the entry at point instead of creating a new one. *** =ob-plantuml.el=: Support tikz file format output =ob-plantuml.el= now output =tikz= :file format via =-tlatex:nopreamble= option. So that the output tikz file can be an input into the exported latex correctly. For example, exporting the following to LaTeX #+begin_src plantuml :file test.tikz :exports results Bob -> Alice : Hello World! #+end_src will include the generated =.tikz= into the exported LaTeX source. *** =UNNUMBERED= property inheritance is now honored by ~org-num-mode~ When ~org-num-skip-unnumbered~ is non-nil, ~org-num-mode~ now honors ~org-use-property-inheritance~ for =UNNUMBERED= property (see manual section "Property Inheritance"). Previously, only local =UNNUMBERED= property was taken into account. Users can add ="UNNUMBERED"= to ~org-use-property-inheritance~ and set ~org-numb-skip-unnumbered~ to ~t~ to make ~org-num-mode~ skip numbering of all the sub-headings with non-nil =UNNUMBERED= property. *** ~org-insert-todo-heading-respect-content~ now accepts prefix arguments The prefix arguments are passed to ~org-insert-todo-heading~. *** Make ~ob-sqlite~ use in-memory databases by default ~sqlite~ source blocks with no ~:db~ header argument now make SQLite use a temporary in-memory database instead of throwing an error, matching the behavior of the official ~sqlite3~ shell. As a result, ~sqlite~ source blocks are now usable out of the box, that is with no header arguments. *** ~org-return~ now acts on citations at point When ~org-return-follows-link~ is non-nil and cursor is over an org-cite citation, ~org-return~ will call ~org-open-at-point~. *** ~org-tags-view~ supports more property operators It supports inequality operators ~!=~ and ~/=~ in addition to the less common (BASIC? Pascal? SQL?) ~<>~. And it supports starred versions of all relational operators (~<*~, ~=*~, ~!=*~, etc.) that work like the regular, unstarred operators but match a headline only if the tested property is actually present. *** =ob-python.el=: Support for more result types and plotting =ob-python= now converts the following objects to org-mode tables when ":results table" header arg is set: - Dictionaries - Numpy arrays - Pandas DataFrames - Pandas Series When the header argument =:results graphics= is set, =ob-python= will use matplotlib to save graphics. The behavior depends on whether value or output results are used. For value results, the last line should return a matplotlib Figure object to plot. For output results, the current figure (as returned by =pyplot.gcf()=) is cleared before evaluation, and then plotted afterwards. *** =ob-maxima.el=: Support for ~batch~ and ~draw~ =ob-maxima= has two new header arguments: ~:batch~ and ~:graphics-pkg~. The ~:batch~ header argument can be set to one of Maxima's file loaders (~batch~, ~load~ or ~batchload~); the default remains ~batchload~. The ~:graphics-pkg~ header argument can be set to one of Maxima's graphics packages (~draw~ or ~plot~); the default remains ~plot~. The graphics terminal is now determined from the file-ending of the file-name set in the ~:file~ header argument. *** =ob-calc.el=: Support for tables in ~:var~ =ob-calc= now supports tables in ~:var~. They are converted to a matrix or a vector depending on the dimensionality of the table. A table with a single row is converted to a vector, the rest are converted to a matrix. *** ox-texinfo always generates a ~@direntry~ We use defaults based on the file name and title of the document, and place the entry in the ~Misc~ category if ~TEXINFO_DIR_CATEGORY~ is missing. =TEXINFO_DIR_TITLE= is renamed to =TEXINFO_DIR_NAME=. The old name is obsolete. ** New and changed options # Changes dealing with changing default values of customizations, # adding new customizations, or changing the interpretation of the # existing customizations. *** Org mode faces are now consistently combined, with markup faces taking precedence over the containing element faces Previously, fontification of inline source blocks, macros, footnotes, target links, timestamps, radio targets, targets, inline export snippets, verbatim code, and COMMENT keyword in headings replaced the containing element fontification. Now, this is changed - the inner markup faces and the containing element faces are combined, with "inner" faces taking precedence; just as for all other markup. *** Org mode now fontifies whole table lines (including newline) according to ~org-table~ face Previously, leading indentation and trailing newline in table rows were not fontified using ~org-table~ face. ~default~ face was used instead. This made it impossible to scale line height when ~org-table~ face has smaller height than default (Emacs calculates line height using the tallest face). Now, new ~org-table-row~ face is used on the whole table row lines, including indentation and the final newline. This face, by default, inherits from ~org-table~ face. If the new behavior is not desired, ~org-table-row~ face can be changed to inherit from ~default~ face. See "Customizing Faces" section of Emacs manual or "Face Attribute Functions" section of Elisp manual. ~org-table~ takes precedence over ~org-table-row~ for the parts of table rows without indentation and newline. *** ~org-auto-align-tags~ is now respected universally Previously, only a subset of Org editing commands respected ~org-auto-align-tags~ option. Now, it is no longer the case. All the editing commands, including typing (~org-self-insert-command~) and deletion respect the option. ~org-auto-align-tags~ is still enabled by default. For users who customized ~org-auto-align-tags~ to nil, ~org-edit-headline~, ~org-priority~, ~org-set-tags~, ~org-entry-put~, ~org-kill-line~, and typing/deleting in headlines will no longer unconditionally auto-align the tags. *** New export option ~org-export-expand-links~ The new option makes Org expand environment variables in link and INCLUDE paths. The option is on by default. Users who do not want variable expansion can set ~org-export-expand-links~ variable to nil or provide =expand-links:nil= in-file export option. *** New hook ~org-after-note-stored-hook~ This new hook runs when a note has been stored. *** New option controlling how Org mode sorts things ~org-sort-function~ Sorting of agenda items, tables, menus, headlines, etc can now be controlled using a new custom option ~org-sort-function~. By default, Org mode sorts things according to the operating system language. However, language sorting rules may or may not produce good results depending on the use case. For example, multi-language documents may be sorted weirdly when sorting rules for system language are applied on the text written using different language. Also, some operations systems (e.g. MacOS), do not provide accurate string sorting rules. Org mode provides 3 possible values for ~org-sort-function~: 1. (default) Sort using system language rules. 2. Sort using string comparison (~compare-strings~), making use of UTF case conversion. This may work better for mixed-language documents and on MacOS. 3. Custom function, if the above does not fit the needs. *** =ob-latex= now uses a new option ~org-babel-latex-process-alist~ to generate png output Previously, =ob-latex= used ~org-preview-latex-default-process~ from ~org-preview-latex-process-alist~ to produce png output. Now, the process settings are separated into a new dedicated option ~org-babel-latex-process-alist~. The default value is pulled from =dvipng= process type from ~org-preview-latex-process-alist~, preserving the existing behavior. However, the output is now immune to changes in ~org-preview-latex-default-process~ and can be customized independently of the image preview settings. *** New option ~org-babel-lua-multiple-values-separator~ The string that separates the values of multi-valued results returned from Lua code blocks. *** =.avif= images are now recognized in ~org-html-inline-image-rules~ In =ox-html=, =.avif= image links are now inlined by default. *** New option ~org-beamer-frame-environment~ The new option defines name of an alternative environment to be used for fragile beamer frames. This option is needed to work around beamer bug with frame contents containing literal =\end{frame}= string (for example, inside example blocks). See https://github.com/josephwright/beamer/issues/360 The default value is =orgframe=. The option should normally not be changed, except when you need to put =\end{orgframe}= string inside beamer frames. A checker has been added to =M-x org-lint= to detect instances of ~org-beamer-frame-environment~ in Org documents. *** New option ~org-export-process-citations~ The new option controls whether to use citation processors to process citations. *** New option ~org-org-with-cite-processors~ The new option controls whether to use citation processors to process citations when exporting to Org. *** New option ~org-org-with-special-rows~ The new options controls whether to export special table rows in Org-Org (=ox-org=) export. The default value is ~t~. *** New option ~org-babel-comint-fallback-regexp-threshold~ Org babel is often using Emacs's interactive REPL feature to implement :session functionality in code blocks. However, Emacs's REPLs use heuristics to detect which lines in the REPL buffer correspond to output and which lines are user prompts. Normally, Org babel changes the default prompt to something unique. It avoids incorrect detection of code block output. Sometimes, the Org-configured prompt is changed manually by users or when running a sub-REPL (for example, when running ssh/python interpreter inside shell). The new option controls Org mode's heuristics for catching user-changed prompt in interactive Org babel sessions. When Org mode cannot find REPL's prompt for more than ~org-babel-comint-fallback-regexp-threshold~ seconds, imprecise generic prompt is tried to detect whether the code block output has arrived. Users who often work with altering REPL prompts may consider reducing the default 5 second value of the new option. *** ~repeated-after-deadline~ value of ~org-agenda-skip-scheduled-if-deadline-is-shown~ is moved to a new customization A new custom option ~org-agenda-skip-scheduled-repeats-after-deadline~ is introduced in place of ~repeated-after-deadline~ value of ~org-agenda-skip-scheduled-if-deadline-is-shown~. The following example would no longer show in the agenda as scheduled after January 5th with the new customization set to ~t~. : * TODO Do me every day until Jan, 5th (inclusive) : SCHEDULED: <2024-01-03 Wed +1d> DEADLINE: <2024-01-05 Fri> The old customization will continue to work, ensuring backwards compatibility. *** New custom setting ~org-icalendar-ttl~ for the ~ox-icalendar~ backend The option ~org-icalendar-ttl~ allows to advise a subscriber to the exported =.ics= file to reload after the given time interval. This is useful i.e. if a calendar server subscribes to your exported file and that file is updated regularly. See IETF RFC 5545, Section 3.3.6 Duration and https://en.wikipedia.org/wiki/ICalendar#Other_component_types for details. Default for ~org-icalendar-ttl~ is ~nil~. In that case the setting will not be used in the exported ICS file. The option may also be set using the =ICAL-TTL= keyword. *** The default value of ~org-attach-store-link-p~ is now ~attached~ Now, after attaching a file, =[[attach:...]]= link to the attached file is stored. It can later be inserted using =M-x org-insert-link=. *** ~org-link-descriptive~ can now be set per-buffer via =#+STARTUP= options In addition to ~org-link-descriptive~ custom option, link display can now be controlled per-buffer as: : #+STARTUP: literallinks : #+STARTUP: descriptivelinks *** New option ~org-fast-tag-selection-maximum-tags~ You can now limit the total number of tags displayed in the fast tag selection interface. Useful in buffers with huge number of tags. *** New variable ~org-clock-out-removed-last-clock~ The variable is intended to be used by ~org-clock-out-hook~. It is a flag used to signal when the =CLOCK= line has been removed. This can happen when ~org-clock-out-remove-zero-time-clocks~ is customized to be non-nil. *** ~org-info-other-documents~ is now a custom option Users can now extend the value of ~org-info-other-documents~ to specify Urls to third-party (non-Emacs) online info nodes when exporting =info:= links. *** ~org-export-smart-quotes-alist~ is now a custom option Previously, smart quotes rules for different languages where hard-coded. Now, they can be customized by users. *** Commands affected by ~org-fold-catch-invisible-edits~ can now be customized New user option ~org-fold-catch-invisible-edits-commands~ controls which commands trigger checking for invisible edits. The full list of affected commands is: - ~org-self-insert-command~ - ~org-delete-backward-char~ - ~org-delete-char~ - ~org-meta-return~ - ~org-return~ (not checked in earlier Org versions) *** New customization ~org-image-max-width~ limiting the displayed inline image width New custom variable ~org-image-max-width~ limits the maximum inline image width, but only when the inline image width is not explicitly set via ~org-image-actual-width~, =ORG-IMAGE-ACTUAL-WIDTH= property, or =#+ATTR*= keyword. By default, when ~org-image-actual-width~ is set to t, ~org-image-max-width~ takes effect. Its default value is set to ~fill-column~, limiting the image previews to ~fill-column~ number of characters. To fall back to previous defaults, where the inline image width is not constrained, set ~org-image-max-width~ to nil. *** ~org-src-block-faces~ now accepts empty string ~""~ as language name It is now possible to customize face of source blocks without language specifier. : #+begin_src : Source block with no language : #+end_src For example, to set ~highlight~ face, use #+begin_src emacs-lisp (setq org-src-fontify-natively t) (add-to-list 'org-src-block-faces '("" highlight)) #+end_src *** New ~org-cite-natbib-export-bibliography~ option defining fallback bibliography style ~natbib~ citation export processor now uses ~org-cite-natbib-export-bibliography~ (defaults to ~unsrtnat~) as a fallback bibliography style if none is specified by user in =#+cite_export:= keyword. Previously, export would fail without explicitly selected bibliography style. *** New escape in ~org-beamer-environments-extra~ for labels in Beamer export The escape =%l= in ~org-beamer-environments-extra~ inserts the label obtained from ~org-beamer--get-label~. This is added to the default environments =theorem=, =definition=, =example=, and =exampleblock= in ~org-beamer-environments-default~. *** ~org-clock-x11idle-program-name~ now defaults to =xprintidle=, when available When =xprintidle= executable is available at =org-clock= load time, it is used as the default value for ~org-clock-x11idle-program-name~. The old =x11idle= default is used as the fallback. =xprintidle= is available as system package in most Linux distributions, unlike ancient =x11idle= that is distributed via WORG. *** New options for the "csl" citation export processor's LaTeX output The ~org-cite-csl-latex-label-separator~ and ~org-cite-csl-latex-label-width-per-char~ options allow the user to control the indentation of entries for labeled bibliography styles when the "csl" citation processor is used for LaTeX export. The indentation length is computed as the sum of ~org-cite-csl-latex-label-separator~ and the maximal label width, for example: #+begin_example indentation length <-------------------------> max. label width separator <---------------><--------> [Doe22] John Doe. A title... [DoeSmithJones19] John Doe, Jane Smith and... [SmithDoe02] Jane Smith and John Doe... #+end_example The maximal label width, in turn, is calculated as the product of ~org-cite-csl-latex-label-width-per-char~ and the maximal label length measured in characters. The ~org-cite-csl-latex-preamble~ option makes it possible to customize the entire LaTeX fragment that the "csl" citation processor injects into the preamble. *** New ~org-latex-listings-src-omit-language~ option for LaTeX export The ~org-latex-listings-src-omit-language~ option allows omitting the =language= parameter in the exported =lstlisting= environment. This is necessary when the =listings= backend delegates listing generation to another package like =fancyvrb= using the following setup in the document header: #+BEGIN_src org ,#+LATEX_HEADER: \RequirePackage{fancyvrb} ,#+LATEX_HEADER: \DefineVerbatimEnvironment{verbatim}{Verbatim}{...whatever...} ,#+LATEX_HEADER: \DefineVerbatimEnvironment{lstlisting}{Verbatim}{...whatever...} #+END_src *** New face: ~org-agenda-calendar-daterange~ The face ~org-agenda-calendar-daterange~ is used to show entries with a date range in the agenda. It inherits from the default face in order to remain backward-compatible. *** New ~org-babel-clojurescript-backend~ option to choose ClojureScript backend Before, a ClojureScript source block used the same backend as Clojure, configured in ~org-babel-clojure-backend~ and relied on an undocumented ~:target~ parameter. Now, there's ~org-babel-clojurescript-backend~ to determine the backend used for evaluation of ClojureScript. *** Support for Clojure CLI in ~ob-clojure~ ~ob-clojure~ now supports executing babel source blocks with the official [[https://clojure.org/guides/deps_and_cli][Clojure CLI tools]]. The command can be customized with ~ob-clojure-cli-command~. *** New customization options for ~org-export-dispatch~ New custom variables ~org-export-body-only~, ~org-export-visible-only~, and ~org-export-force-publishing~ allow the default settings of "Body only", "Visible only", and "Force publishing" in the ~org-export-dispatch~ UI to be customized, respectively. *** New option ~org-icalendar-todo-unscheduled-start~ to control unscheduled TODOs in ox-icalendar ~org-icalendar-todo-unscheduled-start~ controls how ox-icalendar exports the starting datetime for unscheduled TODOs. Note this option only has an effect when ~org-icalendar-include-todo~ is non-nil. By default, ox-icalendar will not export a start datetime for unscheduled TODOs, except in cases where the iCalendar spec demands a start (specifically, for recurring deadlines, in which case ~org-deadline-warning-days~ is used). Currently implemented options are: - ~recurring-deadline-warning~: The default as described above. - ~deadline-warning~: Use ~org-deadline-warning-days~ to set the start time if the unscheduled task has a deadline (recurring or not). - ~current-datetime~: Revert to old behavior, using the current datetime as the start of unscheduled tasks. - ~nil~: Never add a start time for unscheduled tasks. For repeating tasks this technically violates the iCalendar spec, but some iCalendar programs support this usage. *** Capture template expansion now supports ID links The capture template expansion element =%K= creates links using ~org-store-link~, which respects the values of ~org-id-link-to-use-id~. *** Changes to ~org-babel-python-command~, and new session/nonsession specific options The default Python command used by interactive sessions has been changed to match ~python-shell-interpreter~ and ~python-shell-interpreter-args~ by default. The default Python command for nonsessions has not changed. New options ~org-babel-python-command-nonsession~ and ~org-babel-python-command-session~ control the default Python command for nonsessions and sessions, respectively. By default, ~org-babel-python-command-session~ is ~auto~, which means to use the configuration for ~python-shell-interpreter(-args)~ as default. The old option ~org-babel-python-command~ has been changed to have default value of ~auto~. When not ~auto~, it overrides both ~org-babel-python-command-nonsession~ and ~org-babel-python-command-session~. Therefore, users who had previously set ~org-babel-python-command~ will not experience any changes. Likewise, users who had neither set ~org-babel-python-command~ nor ~python-shell-interpreter(-args)~ will not see any changes -- ~python~ remains the default command. The main change will be for users who did not configure ~org-babel-python-command~, but did configure ~python-shell-interpreter~, e.g. to use IPython. In this case, ~ob-python~ will now start interactive sessions in a more consistent manner with ~run-python~. *** New hook option ~org-indent-post-buffer-init-functions~ This allows to run functions after ~org-indent~ initializes a buffer to enrich its properties. *** New option ~org-agenda-start-with-archives-mode~ This option starts the agenda to automatically include archives, propagating the value for this variable to ~org-agenda-archives-mode~. For acceptable values and their meaning, see the value of that variable. *** New option ~org-id-link-consider-parent-id~ to allow =id:= links to parent headlines For =id:= links, when this option is enabled, ~org-store-link~ will look for ids from parent/ancestor headlines, if the current headline does not have an id. Combined with the new ability for =id:= links to use search options [fn:: when =org-id-link-use-context= is =t=, which is the default], this allows linking to specific headlines without requiring every headline to have an id property, as long as the headline is unique within a subtree that does have an id property. For example, given this org file: #+begin_src org ,* Parent :PROPERTIES: :ID: abc :END: ,** Child 1 ,** Child 2 #+end_src Storing a link with point at "Child 1" will produce a link ==, which precisely links to the "Child 1" headline even though it does not have its own ID. By giving files top-level id properties, links to headlines in the file can also be made more robust by using the file id instead of the file path. *** New option ~latex-default-footnote-command~ to customize the LaTeX footnote command This new option allows you to define the LaTeX command the Org mode footnotes are converted to (for example ~\sidenote{%s%s}~ instead of the default ~\footnote{%s%s}~). The option can be customized either by 1. setting the global variable in the ~org-export-latex~ customization group or 2. by setting the file local keyword =LATEX_FOOTNOTE_COMMAND= *** Options for ~#+cite_export: biblatex~ can use the package's option syntax When using =biblatex= to export bibliographies, you can use the format as specified in the =biblatex= package documentation as =key=val,key=val,...= *** New option ~org-columns-dblock-formatter~ =colview= dynamic blocks now understand a new ~:formatter~ parameter to use a specific function for formatting and inserting the contents of the dynamic block. This new option can be used to set the global default formatting function that will be used for =colview= dynamic blocks that do not specify any ~:formatter~ parameter. Its default value (the new function ~org-columns-dblock-write-default~) yields the previous (fixed) formatting behavior. *** New allowed value of ~org-md-headline-style~ to mix ATX and Setext style headlines Setting ~org-md-headline-style~ to ~'mixed~ will export headline levels one and two as Setext style headlines, and headline levels three through six will be exported as ATX style headlines. *** ~org-footnote-new~ can be configured to create anonymous footnotes When ~org-footnote-auto-label~ is set to ~'anonymous~, create anonymous footnotes automatically with ~org-footnote-new~. The same can be done via startup options: : #+STARTUP: fnanon *** New final hooks for Modifier-Cursor keys Final hooks are added to the following commands: - ~org-metaleft-final-hook~ to ~org-metaleft~ (bound to =M-=). - ~org-metaright-final-hook~ to ~org-metaright~ (bound to =M-=). - ~org-metaup-final-hook~ to ~org-metaup~ (bound to =M-=). - ~org-metadown-final-hook~ to ~org-metadown~ (bound to =M-=). - ~org-shiftmetaleft-final-hook~ to ~org-shiftmetaleft~ (bound to =M-S-=). - ~org-shiftmetaright-final-hook~ to ~org-shiftmetaright~ (bound to =M-S-=). - ~org-shiftmetaup-final-hook~ to ~org-shiftmetaup~ (bound to =M-S-=). - ~org-shiftmetadown-final-hook~ to ~org-shiftmetadown~ (bound to =M-S-=). ** Major changes and additions to Org element API and Org syntax *** Diary type timestamps now support optional time/timerange Previously, diary type timestamps could not specify time. Now, it is allowed to add a time or time range: : <%%(diary-float t 4 2) 22:00-23:00> : <%%(diary-float t 4 2) 10:30> The parsed representation of such timestamps will have ~:hour-start~, ~:minute-start~, ~:hour-end~, ~:minute-end~, and ~:range-type~ properties set appropriately. In addition, a new ~:diary-sexp~ property will store the diary sexp value. For example, : <%%(diary-float t 4 2) 22:00-23:00> will have the following properties #+begin_src emacs-lisp :type: diary :range-type: timerange :raw-value: "<%%(diary-float t 4 2) 22:00-23:00>" :year-start: nil :month-start: nil :day-start: nil :hour-start: 22 :minute-start: 0 :year-end: nil :month-end: nil :day-end: nil :hour-end: 23 :minute-end: 0 :diary-sexp: "(diary-float t 4 2)" #+end_src *** Underline syntax now takes priority over subscript when both are applicable Previously, Org mode interpreted =(_text_)= as subscript. Now, the interpretation is changed to underline. =(_text_)= matches both subscript and underline markup. The interpretation is changed to keep consistency with other emphasis like =(*bold*)=. Most of the users should not be affected by this change - it only applies when character immediately preceding =_= is one of =-=, =(=, ='=, and ={=. *** New term: "syntax node" To reduce confusion with "element" referring to both "syntax element" and "element/object" class, we now prefer using "syntax node" when referring to generic Org syntax elements. "Elements" and "objects" now refer to different syntax node classes of paragraph-like nodes and markup-like nodes. *** New element type ~anonymous~ Secondary strings can now be recognized as ~anonymous~ type to distinguish from non-elements. With a new optional argument, ~org-element-type~ will return ~anonymous~ for secondary strings instead of nil. The new element type can be used in ~org-element-lineage~, ~org-element-map~, and other functions that filter by element type. *** Internal structure of Org parse tree has been changed The code relying upon the previously used =(TYPE PROPERTIES-PLIST CONTENTS-LIST)= structure may no longer work. Please use ~org-element-create~, ~org-element-property~, and other Org element API functions to work with Org syntax trees. Some syntax node properties are no longer stored as property list elements. Instead, they are kept in a special vector value of a new =:standard-properties= property. This is done to improve performance. If there is a need to traverse all the node properties, a new API function ~org-element-properties-map~ can be used. Properties and their values can now be deferred to avoid overheads when parsing. They are calculated lazily, when the value/property is requested by ~org-element-property~ and other getter functions. Using ~plist-get~ to retrieve values of =PROPERTIES-PLIST= is not recommended as deferred properties will not be resolved in such scenario. New special property =:secondary= is used internally to record which properties store secondary objects. New special property =:deferred= is used to keep information how to calculate property names lazily. See the commentary in =lisp/org-element-ast.el= for more details. *** Multiple affiliated keyword values are now stored in the order they appear in buffer Previously, : #+caption: foo : #+caption: bar : Paragraph would have its =:caption= property set to ~(("bar") ("foo"))~ in reverse order. Now, the order is not reversed: ~(("foo") ("bar"))~. *** Some property values may now be calculated lazily and require original Org buffer to be live ~org-element-at-point~, ~org-element-context~, and ~org-element-at-point-no-context~ may now not calculate all the property values at the call time. Instead, the calculation will be deferred until ~org-element-property~ or the equivalent getter function is called. The property names may not all be calculated as well. It may often be necessary to have the original Org buffer open when resolving the deferred values. One can ensure that all the deferred values are resolved using new function ~org-element-resolve-deferred~ and new optional argument for ~org-element-property~. ~org-element-parse-buffer~ and ~org-element-parse-secondary-string~ will resolve all the deferred values by default. No adjustment is needed for their users. *** New API functions and macros **** New property accessors and setters New functions to retrieve and set (via ~setf~) commonly used element properties: - =:begin= :: ~org-element-begin~ - =:end= :: ~org-element-end~ - =:contents-begin= :: ~org-element-contents-begin~ - =:contents-end= :: ~org-element-contents-end~ - =:post-affiliated= :: ~org-element-post-affiliated~ - =:post-blank= :: ~org-element-post-blank~ - =:parent= :: ~org-element-parent~ **** New macro ~org-element-with-enabled-cache~ The macro arranges the element cache to be active during =BODY= execution. When cache is enabled, the macro is identical to ~progn~. When cache is disabled, the macro arranges a new fresh cache that is discarded upon completion of =BODY=. **** New function ~org-element-property-raw~ This function is like ~org-element-property~ but does not try to resolve deferred properties. ~org-element-property-raw~ can be used with ~setf~. **** New function ~org-element-put-property-2~ Like ~org-element-put-property~, but the argument list is changed to have =NODE= as the last argument. Useful with threading macros like ~thread-last~. **** New function ~org-element-properties-resolve~ This function resolves all the deferred values in a =NODE=, modifying the =NODE= for side effect. **** New functions ~org-element-properties-map~ and ~org-element-properties-mapc~ New functions to map over =NODE= properties. **** New function ~org-element-ast-map~ This is a more general equivalent of ~org-element-map~. It allows more precise control over recursion into secondary strings. **** New function ~org-element-lineage-map~ Traverse syntax tree ancestor list, applying arbitrary function to each ancestor. **** New function ~org-element-property-inherited~ Like ~org-element-property~, but can be used to retrieve and combine multiple different properties for a given =NODE= and its parents. *** ~org-element-cache-map~ can now be used even when element cache is disabled *** =org-element= API functions and macros can now accept syntax nodes as =POM= argument The following functions are updated: - ~org-agenda-entry-get-agenda-timestamp~ - ~org-element-at-point~ - ~org-is-habit-p~ - ~org-id-get~ - ~org-with-point-at~ - ~org-entry-properties~ - ~org-entry-get~ - ~org-entry-delete~ - ~org-entry-add-to-multivalued-property~ - ~org-entry-remove-from-multivalued-property~ - ~org-entry-member-in-multivalued-property~ - ~org-entry-put-multivalued-property~ - ~org-entry-get-with-inheritance~ - ~org-entry-put~ - ~org-read-property-value~ - ~org-property-get-allowed-values~ *** ~org-element-map~ now traverses main value in dual keywords before the secondary value The traverse order for dual keywords is reversed. The main value is now traversed first, followed by the secondary value. *** Org parse tree is now non-printable Org parser now assigns a new property =:buffer= that holds non-printable buffer object. This makes syntax tree non-printable. Using ~print~/~read~ is no longer safe. *** Some Org API functions no longer preserve match data ~org-element-at-point~, ~org-element-context~, ~org-get-category~, and ~org-get-tags~ may modify the match data. The relevant function docstrings now explicitly mention that match data may be modified. *** ~org-element-create~ now treats a single ~anonymous~ =CHILDREN= argument as a list of child nodes When =CHILDREN= is a single anonymous node, use its contents as children nodes. This way, : (org-element-create 'section nil (org-element-contents node)) will yield expected results with contents of another node adopted into a newly created one. Previously, one had to use : (apply #'org-element-create 'section nil (org-element-contents node)) *** New property ~:range-type~ for org-element timestamp object ~org-element-timestamp-parser~ now adds =:range-type= property to each timestamp object. Possible values: ~timerange~, ~daterange~, ~nil~. ~org-element-timestamp-interpreter~ takes into account this property and returns an appropriate timestamp string. *** New properties =:repeater-deadline-value= and =:repeater-deadline-unit= for org-element timestamp object ~org-element-timestamp-parser~ now adds =:repeater-deadline-value= and =:repeater-deadline-unit= properties to each timestamp object that has a repeater deadline. For example, in =<2012-03-29 Thu ++1y/2y>=, =2y= is the repeater deadline with a value of =2= and unit of =y=. See "5.3.3 Tracking your habits" section in the manual. Possible values for =:repeater-deadline-value=: ~positive integer~, ~nil~. Possible values for =:repeater-deadline-unit=: ~hour~, ~day~, ~week~, ~month~, ~year~. ~org-element-timestamp-interpreter~ takes into account these properties and returns an appropriate timestamp string. *** =org-link= store functions are passed an ~interactive?~ argument The ~:store:~ functions set for link types using ~org-link-set-parameters~ are now passed an ~interactive?~ argument, indicating whether ~org-store-link~ was called interactively. Existing store functions will continue to work. ** New functions and changes in function arguments # This also includes changes in function behavior from Elisp perspective. *** ~org-babel-lilypond-compile-lilyfile~ ignores optional second argument The =TEST= parameter is better served by Emacs debugging tools. *** ~org-print-speed-command~ is now an internal function The old name is marked obsolete and the new name is ~org--print-speed-command~. This function was always aimed for internal use when building speed command help buffer. Now, it is stated explicitly. *** When ~org-link-file-path-type~ is a function, its argument is now a filename as it is read by ~org-insert-link~; not an absolute path Previously, when ~org-link-file-path-type~ is set to a function, the function argument was the filename from the link expanded via ~expand-file-name~. Now, a bare filename is passed to the function. *** ~org-create-file-search-functions~ can use ~org-list-store-props~ to suggest link description In Org <9.0, ~org-create-file-search-functions~ could set ~description~ variable to suggest link description for the stored link. However, this feature stopped working since Org 9.0 switched to lexical binding. Now, it is again possible for ~org-create-file-search-functions~ to supply link descriptions using ~(org-list-store-props :description "suggested description")~ in the search function body. *** New API functions to store data within ~org-element-cache~ Elisp programs can now store data inside Org element cache. The data will remain stored as long as the Org buffer text associated with the cached elements remains unchanged. Two options are available: - Store the data until any text within element boundaries is changed - Store the data, but ignore any changes inside element contents that do not affect the high-level element structure. For example, changes inside subheadings can be ignored for the data stored inside parent heading element. The new functions are: ~org-element-cache-store-key~ and ~org-element-cache-get-key~. *** New optional argument =UPDATE-HEADING= for ~org-bibtex-yank~ When the new argument is non-nil, add data to the headline of the entry at point. *** ~org-fold-hide-drawer-all~ is now interactive ~org-fold-hide-drawer-all~ is now a command, accepting two optional arguments - region to act on. *** =TYPES= argument in ~org-element-lineage~ can now be a symbol When =TYPES= is symbol, only check syntax nodes of that type. *** New optional argument =KEEP-CONTENTS= for ~org-element-copy~ With the new argument, the contents is copied recursively. *** ~org-element-property~ can now be used with ~setf~ *** New optional arguments for ~org-element-property~ The value of the new optional argument =DFLT= is returned if the property with given name is not present. Same as =DEFAULT= argument for ~alist-get~. New optional argument =FORCE-UNDEFER= modifies the =NODE=, storing the resolved deferred values. See the top comment in =lisp/org-element-ast.el= for more details about the deferred values. *** New optional argument =NO-UNDEFER= in ~org-element-map~ and changed argument conventions New optional argument =NO-UNDEFER=, when non-nil, will make ~org-element-map~ keep deferred secondary string values in their raw form. See the top comment in =lisp/org-element-ast.el= for more details about the deferred values. =TYPES= argument can now be set to ~t~. This will match all the syntax nodes when traversing the tree. ~FUN~ can now be a lisp form that will be evaluated with symbol ~node~ assigned to the current syntax node. ~FUN~ can now throw ~:org-element-skip~ signal to skip recursing into current element children and secondary strings. *** New optional argument =KEEP-DEFERRED= in ~org-element-parse-buffer~ When non-nil, the deferred values and properties will not be resolved. See the top comment in =lisp/org-element-ast.el= for more details about the deferred values. *** New optional argument =ANONYMOUS= for ~org-element-type~ When the new argument is non-nil, return symbol ~anonymous~ for anonymous elements. Previously, ~nil~ would be returned. *** ~org-element-adopt-elements~ is renamed to ~org-element-adopt~ The old name is kept as an alias. The new name creates less confusion as the function can also act on objects. *** ~org-element-extract-element~ is renamed to ~org-element-extract~ The old name is kept as an alias. The new name creates less confusion as the function can also act on objects. *** ~org-element-set-element~ is renamed to ~org-element-set~ The old name is kept as an alias. The new name creates less confusion as the function can also act on objects. *** ~org-export-get-parent~ is renamed to ~org-element-parent~ and moved to =lisp/org-element.el= *** ~org-export-get-parent-element~ is renamed to ~org-element-parent-element~ and moved to =lisp/org-element.el= *** ~org-insert-heading~ optional argument =TOP= is now =LEVEL= A numeric value forces a heading at that level to be inserted. For backwards compatibility, non-numeric non-nil values insert level 1 headings as before. *** New optional argument for ~org-id-get~ New optional argument =INHERIT= means inherited ID properties from parent entries are considered when getting an entry's ID (see ~org-id-link-consider-parent-id~ option). *** New optional argument for ~org-link-search~ If a missing heading is created to match the search string, the new optional argument =NEW-HEADING-CONTAINER= specifies where in the buffer it will be added. If not specified, new headings are created at level 1 at the end of the accessible part of the buffer, as before. ** Miscellaneous *** Add completion for links to man pages Completion is enabled for links to man pages added using ~org-insert-link~: =C-c C-l man RET emacscl TAB= to get =emacsclient=. Of course, the ~ol-man~ library should be loaded first. *** Datetree structure headlines can now be complex TODO state, priority, tags, statistics cookies, and COMMENT keywords are allowed in the tree structure. *** Org links now support ~thing-at-point~ You can now retrieve the destination of a link by calling ~(thing-at-point 'url)~. Requires Emacs 28 or newer. In Emacs 30 or newer, ~forward-thing~ and ~bounds-of-thing-at-point~ is also supported for links. *** Add support for ~logind~ idle time in ~org-user-idle-seconds~ When Emacs is built with =dbus= support and the =org.freedesktop.login1= interface is available, fallback to checking the =IdleSinceHint= property when determining =org-user-idle-seconds= as the penultimate step. *** =colview= dynamic block now writes column width specifications When column format contains width specifications, =colview= dynamic block now writes these specifications as column width in the generated tables and automatically shrinks the columns on display. Example: : * PROYECTO EMACS : :PROPERTIES: : :COLUMNS: %10ITEM(PROJECT) : :END: : : Before : : #+BEGIN: columnview :id local : | PROJECT | : |----------------| : | PROYECTO EMACS | : #+END: : : After : : #+BEGIN: columnview :id local : | <10> | : | PROJECT | : |----------------| : | PROYECTO EMACS | : #+END: *** =ob-lua=: Support all types and multiple values in results Lua code blocks can now return values of any type and can also return multiple values. Previously, values of certain types were incorrectly converted to the empty string =""=, which broke HTML export for inline code blocks, and multiple values were incorrectly concatenated, where ~return 1, 2, 3~ was evaluated as =123=. Multiple values are comma-separated by default, so that they work well with inline code blocks. To change the string used as the separator, customize ~org-babel-lua-multiple-values-separator~. *** ~org-store-link~ now moves an already stored link to front of the ~org-stored-links~ Previously, when the link to be stored were stored already, ~org-store-link~ displayed a message and did nothing. Now, ~org-store-link~ moves the stored link to front of the list of stored links. This way, the link will show up first in the completion and when inserting all the stored links with ~org-insert-all-links~. *** ob-python now sets ~python-shell-buffer-name~ in Org edit buffers When editing a Python src block, the editing buffer is now associated with the Python shell specified by the src block's ~:session~ header, which means users can now send code directly from the edit buffer, e.g., using ~C-c C-c~, to the session specified in the Org buffer. *** ~org-edit-special~ no longer force-starts session in R and Julia source blocks Previously, when R/Julia source block had =:session= header argument set to a session name with "earmuffs" (like =*session-name*=), ~org-edit-special~ always started a session, if it does not exist. Now, ~org-edit-special~ arranges that a new session with correct name is initiated only when user explicitly executes R/Julia-mode commands that trigger session interactions (requires ESS 24.01.0 or newer). The same session will remain available in the context of Org babel. *** ~org-store-link~ behavior storing additional =CUSTOM_ID= links has changed Previously, when storing =id:= link, ~org-store-link~ stored an additional "human readable" link using a node's =CUSTOM_ID= property. This behavior has been expanded to store an additional =CUSTOM_ID= link when storing any type of external link type in an Org file, not just =id:= links. *** =org-habit.el= now optionally inherits ~:STYLE: habit~ properties Currently, the ~STYLE~ property of habits is not inherited when searching for entries. This change allows the property to be inherited optionally by customizing the ~org-use-property-inheritance~ variable. This change aims to provide more flexibility in managing habits, allowing users to dedicate separate subtrees or files to habits without manually setting the ~STYLE~ property for each sub-task. The change is breaking when ~org-use-property-inheritance~ is set to ~t~. *** =ox-org= preserves header arguments in src blocks Previously, all the header arguments where stripped from src blocks during export. Now, header arguments are preserved. *** =ox-org= now exports special table rows by default Previously, when exporting to Org, special table rows (for example, width cookies) were not exported. Now, they are exported by default. You can customize new option ~org-org-with-special-rows~ to fall back to previous behavior. *** ~org-agenda-search-headline-for-time~ now ignores all the timestamp in headings Previously, ~org-agenda-search-headline-for-time~ made Org agenda match anything resembling time inside headings. Even when the time was a part of a timestamp. Now, all the timestamps in headings are ignored when searching the time. *** =org-crypt.el= now applies initial visibility settings to decrypted entries Previously, all the text was unfolded unconditionally, including property drawers. *** Blank lines after removed objects are now retained during export When certain objects in Org document are to be excluded from export, spaces after these objects were previously removed as well. For example, if ~org-export-with-footnotes~ is set to nil, the footnote in : Pellentesque dapibus suscipit ligula.[fn:1] Donec posuere augue in quam. would be removed, leading to the following exported ASCII document : Pellentesque dapibus suscipit ligula.Donec posuere augue in quam. This is because spaces after footnote (and other markup) are considered a part of the preceding AST object in Org. Now, unless there is a whitespace before an object to be removed, spaces are preserved during export: : Pellentesque dapibus suscipit ligula. Donec posuere augue in quam. *** Remove undocumented ~:target~ header parameter in ~ob-clojure~ The ~:target~ header was only used internally to distinguish from Clojure and ClojureScript. This is now handled with an optional function parameter in the respective functions that need this information. *** New org-entity alias: =\P= for =\para= For symmetry with =\S= and =\sect= for the section symbol, =\P= has been added as an another form for the pilcrow symbol currently available as =\para=. *** ~org-table-to-lisp~ no longer clobbers the regexp global state It does no longer use regexps. It is also faster. Large tables can be read quickly. * Version 9.6 ** Important announcements and breaking changes *** =python-mode.el (MELPA)= support in =ob-python.el= is deprecated We no longer aim to support third-party =python-mode.el= implementation of Python REPL. Only the built-in =python.el= will be supported from now on. We still keep the old, partially broken, code in =ob-python.el= for the time being. It will be removed in the next release. See https://orgmode.org/list/87r0yk7bx8.fsf@localhost for more details. *** Element cache is enabled by default and works for headings The old element cache code has been refactored. Emacs does not hang anymore when the cache is enabled. When cache is enabled, ~org-element-at-point~ for headings is guaranteed to return valid =:parent= property. The highest-level headings contain new =org-data= element as their parent. The new =org-data= element provides properties from top-level property drawer, buffer-global category, and =:path= property containing file path for file Org buffers. The new cache still need to be tested extensively. Please, report any warning coming from element cache. If you see warnings regularly, it would be helpful to set ~org-element--cache-self-verify~ to ='backtrace= and provide the backtrace to Org mailing list. *** Element cache persists across Emacs sessions The cache state is saved between Emacs sessions. Enabled by default. The cache persistence can be controlled via ~org-element-cache-persistent~. *** Users experiencing performance issues can use new folding backend The old folding backend used in Org is poorly scalable when the file size increases beyond few Mbs. The symptoms usually include slow cursor motion, especially in long-running Emacs sessions. A new optimized folding backend is now available, and enabled by default. To disable it, put the following to the Emacs config *before* loading Org: #+begin_src emacs-lisp (setq org-fold-core-style 'overlays) #+end_src Even more performance optimization can be enabled by customizing =org-fold-core--optimise-for-huge-buffers=. However, this option may be dangerous. Please, read the variable docstring carefully to understand the possible consequences. When =org-fold-core-style= is set to =text-properties=, several new features will become available and several notable changes will happen to the Org behavior. The new features and changes are listed below. **** Hidden parts of the links can now be searched and revealed during isearch [2024-06-09 Sun] Since Org 9.7, this is no longer working. See changes for Org 9.7. In the past, hidden parts of the links could not be searched using isearch (=C-s=). Now, they are searchable by default. The hidden match is also revealed temporarily during isearch. To restore the old behavior add the following core to your Emacs config: #+begin_src emacs-lisp (defun org-hidden-link-ignore-isearch () "Do not match hidden parts of links during isearch." (org-fold-core-set-folding-spec-property 'org-link :isearch-open nil) (org-fold-core-set-folding-spec-property 'org-link :isearch-ignore t)) (add-hook 'org-mode-hook #'org-hidden-link-ignore-isearch) #+end_src See docstring of =org-fold-core--specs= to see more details about =:isearch-open= and =:isearch-ignore= properties. **** =org-catch-invisible-edits= now works for hidden parts of the links and for emphasis markers In the past, user could edit invisible parts of the links and emphasis markers. Now, the editing is respecting the value of =org-catch-invisible-edits=. Note that hidden parts of sub-/super-scripts are still not handled. **** Breaking structure of folded elements automatically reveals the folded text In the past, the user could be left with unfoldable text after breaking the org structure. For example, if #+begin_src org :DRAWER: like this :END: #+end_src is folded and then edited into #+begin_src org DRAWER: like this :END: #+end_src The hidden text would not be revealed. Now, breaking structure of drawers, blocks, and headings automatically reveals the folded text. **** Folding state of the drawers is now preserved when cycling headline visibility In the past drawers were folded every time a headline is unfolded. Now, it is not the case anymore. The drawer folding state is preserved. The initial folding state of all the drawers in buffer is set according to the startup visibility settings. To restore the old behavior, add the following code to Emacs config: #+begin_src emacs-lisp (add-hook 'org-cycle-hook #'org-cycle-hide-drawers) #+end_src Note that old behavior may cause performance issues when cycling headline visibility in large buffers. **** =outline-*= functions may no longer work correctly in Org mode The new folding backend breaks some of the =outline-*= functions that rely on the details of visibility state implementation in =outline.el=. The old Org folding backend was compatible with the =outline.el= folding, but it is not the case anymore with the new backend. From now on, using =outline-*= functions is strongly discouraged when working with Org files. *** HTML export uses MathJax 3+ instead of MathJax 2 Org now uses MathJax 3 by default instead of MathJax 2. During HTML exports, Org automatically converts all legacy MathJax 2 options to the corresponding MathJax 3+ options, except for the ~path~ option in which now /must/ point to a file containing MathJax version 3 or later. The new Org does /not/ work with the legacy MathJax 2. Further, if you need to use a non-default ~font~ or ~linebreaks~ (now ~overflow~), then the ~path~ must point to MathJax 4 or later. See the updated ~org-html-mathjax-options~ for more details. MathJax 3, a ground-up rewrite of MathJax 2 came out in 2019. The new version brings modularity, better and faster rendering, improved LaTeX support, and more. For more information about new features, see: https://docs.mathjax.org/en/latest/upgrading/whats-new-3.0.html https://docs.mathjax.org/en/latest/upgrading/whats-new-3.1.html https://docs.mathjax.org/en/latest/upgrading/whats-new-3.2.html MathJax 3 comes with useful extensions. For instance, you can typeset calculus with the ~physics~ extension or chemistry with the ~mhchem~ extension, like in LaTeX. Note that the Org manual does not discuss loading of MathJax extensions via ~+HTML_MATHJAX~ anymore. It has never worked anyway. To actually load extensions, consult the official documentation: https://docs.mathjax.org/en/latest/input/tex/extensions.html Lastly, MathJax 3 changed the default JavaScript content delivery network (CDN) provider from CloudFlare to jsDelivr. You can find the new terms of service, including the privacy policy, at https://www.jsdelivr.com/terms. *** List references in source block variable assignments are now proper lists List representation of named lists is now converted to a simple list as promised by the manual section [[info:org#Environment of a Code Block][org#Environment of a Code Block]]. Previously, it was converted to a list of lists. Before: #+begin_src org ,#+NAME: example-list - simple - not - nested - list ,#+BEGIN_SRC emacs-lisp :var x=example-list :results value (format "%S" x) ,#+END_SRC ,#+RESULTS: : (("simple" (unordered ("not") ("nested"))) ("list")) #+end_src After: #+begin_src org ,#+BEGIN_SRC emacs-lisp :var x=example-list :results value (format "%S" x) ,#+END_SRC ,#+RESULTS: : ("simple" "list") #+end_src ** New features *** Column view: new commands to move rows up & down You can move rows up & down in column view with ~org-columns-move-row-up~ and ~org-columns-move-row-down~. Keybindings are the same as ~org-move-subtree-up~ and ~org-move-subtree-down~ =M-= and =M-=. *** Clock table can now produce quarterly reports =:step= clock table parameter can now be set to =quarter=. *** Publishing now supports links to encrypted Org files Links to other published Org files are automatically converted to the corresponding html links. Now, this feature is also available when links point to encrypted Org files, like =[[file:foo.org.gpg::Heading]]=. *** Interactive commands now support escaping text inside comment blocks ~org-edit-special~ and ~org-insert-structure-template~ now handle comment blocks. See [[*New command ~org-edit-comment-block~ to edit comment block at point]]. *** New customization option =org-property-separators= A new alist variable to control how properties are combined. If a property is specified multiple times with a =+=, like #+begin_src org :PROPERTIES: :EXPORT_FILE_NAME: some/path :EXPORT_FILE_NAME+: to/file :END: #+end_src the old behavior was to always combine them with a single space (=some/path to/file=). For the new variable, the car of each item in the alist should be either a list of property names or a regular expression, while the cdr should be the separator to use when combining that property. The default value for the separator is a single space, if none of the provided items in the alist match a given property. For example, in order to combine =EXPORT_FILE_NAME= properties with a forward slash =/=, one can use #+begin_src emacs-lisp (setq org-property-separators '((("EXPORT_FILE_NAME") . "/"))) #+end_src The example above would then produce the property value =some/path/to/file=. *** New library =org-persist.el= implements variable persistence across Emacs sessions The library stores variable data in ~org-persist-directory~ (set to XDG cache dir by default). The entry points are ~org-persist-register~, ~org-persist-unregister~, ~org-persist-read~, and ~org-persist-read-all~. Storing circular structures is supported. Storing references between different variables is also supported (see =:inherit= key in ~org-persist-register~). The library permits storing buffer-local variables. Such variables are linked to the buffer text, file =inode=, and file path. *** New =:options= attribute when exporting tables to LaTeX The =:options= attribute allows adding an optional argument with a list of various table options (between brackets in LaTeX export), since certain tabular environments, such as longtblr of the tabularray LaTeX package, provides this structure. *** New =:compact= attribute when exporting lists to Texinfo The =:compact= attribute allows exporting multiple description list items to one =@item= command and one or more =@itemx= commands. This feature can also be enabled for all description lists in a file using the =compact-itemx= export option, or globally using the ~org-texinfo-compact-itemx~ variable. *** New shorthands recognized when exporting to Texinfo Items in a description list that begin with =Function:=, =Variable:= or certain related prefixes are converted using Texinfo definition commands. *** New =:noweb-prefix= babel header argument =:noweb-prefix= can be set to =no= to prevent the prefix characters from being repeated when expanding a multiline noweb reference. *** New =:noweb= babel header argument value =strip-tangle= =:noweb= can be set to =strip-tangle= to strip the noweb syntax references before tangling. *** New LaTeX source block backend using =engraved-faces-latex= When ~org-latex-src-block-backend~ is set to ~engraved~, =engrave-faces-latex= from [[http://elpa.gnu.org/packages/engrave-faces.html][engrave-faces]] is used to transcode source blocks to LaTeX. This requires the =fvextra=, =float=, and (by default, but not necessarily) =tcolorbox= LaTeX packages be installed. It uses Emacs's font-lock information, and so tends to produce results superior to Minted or Listings. *** Support for =#+include=-ing URLs =#+include: FILE= will now accept URLs as the file. *** Structure templates now respect case used in ~org-structure-template-alist~ The block type in ~org-structure-template-alist~ is not case-sensitive. When the block type starts from the upper case, structure template will now insert =#+BEGIN_TYPE=. Previously, lower-case =#+begin_type= was inserted unconditionally. *** New ox-latex tabbing support for tables. LaTeX tables can now be exported to the latex tabbing environment tabbing environment]]. This is done by adding =#+ATTR_LATEX: :mode tabbing= at the top of the table. The default column width is set to 1/n times the latex textwidth, where n is the number of columns. This behavior can be changed by supplying a =:align= parameter. The tabbing environment can be useful when generating simple tables which can be span multiple pages and when table cells are allowed to overflow. *** Support for =nocite= citations and sub-bibliographies in the "csl" export processor The "csl" citation export processor now supports =nocite= style citations that add items to the printed bibliography without visible references in the text. Using the key =*= in a nocite citation, for instance, #+begin_src org [cite/n:@*] #+end_src includes all available items in the printed bibliography. The "csl" export processor now also supports sub-bibliographies that show only a subset of the references based on some criterion. For example, #+begin_src org #+print_bibliography: :type book :keyword ai #+end_src prints a sub-bibliography containing the book entries with =ai= among their keywords. *** New =:filetitle= option for clock table The =:filetitle= option for clock tables can be set to ~t~ to show org file title (set by =#+title:=) in the File column instead of the file name. For example: #+begin_src org ,#+BEGIN: clocktable :scope agenda :maxlevel 2 :block thisweek :filetitle t #+end_src If a file does not have a title, the table will show the file name instead. *** New =org-md-toplevel-hlevel= variable for Markdown export The =org-md-toplevel-hlevel= customization variable sets the heading level used for top level headings, much like how =org-html-toplevel-hlevel= sets the heading level used for top level headings in HTML export. *** Babel: new syntax to pass the contents of a src block as argument Use the header argument =:var x=code-block[]= or : #+CALL: fn(x=code-block[]) to pass the contents of a named code block as a string argument. *** New property =ORG-IMAGE-ACTUAL-WIDTH= for overriding global ~org-image-actual-width~ The new property =ORG-IMAGE-ACTUAL-WIDTH= can override the global variable ~org-image-actual-width~ value for inline images display width. *** Outline cycling can now include inline image visibility New ~org-cycle-hook~ function ~org-cycle-display-inline-images~ for auto-displaying inline images in the visible parts of the subtree. This behavior is controlled by new custom option ~org-cycle-inline-images-display~. *** New ~org-babel-tangle-finished-hook~ hook run at the very end of ~org-babel-tangle~ This provides a proper counterpart to ~org-babel-pre-tangle-hook~, as ~org-babel-post-tangle-hook~ is run per-tangle-destination. ~org-babel-tangle-finished-hook~ is just run once after the post tangle hooks. *** New =:backend= header argument for clojure code blocks The =:backend= header argument on clojure code blocks can override the value of ~org-babel-clojure-backend~. For example: #+begin_src clojure :backend babashka (range 2) #+end_src *** New =:results discard= header argument Unlike =:results none=, the return value of code blocks called with =:results discard= header argument is always ~nil~. Org does not attempt to analyze the results and simply returns nil. This can be useful when the code block is used for side effects only but generates large outputs that may be slow to analyze for Org. *** Add Capture template hook properties Capture templates can now attach template specific hooks via the following properties: ~:hook~, ~:prepare-finalize~, ~:before-finalize~, ~:after-finalize~. These nullary functions run prior to their global counterparts for the selected template. ** New options *** New option ~org-columns-checkbox-allowed-values~ This would allow to use more than two states ("[ ]", "[X]") in columns with SUMMARY-TYPE that use checkbox ("X", "X/", "X%"). For example you can add an intermediate state ("[-]"). Or empty state ("") to remove checkbox. *** A new option for custom setting ~org-refile-use-outline-path~ to show document title in refile targets Setting ~org-refile-use-outline-path~ to ~'title~ will show title instead of the file name in refile targets. If the document do not have a title, the filename will be used, similar to ~'file~ option. *** A new option for custom setting ~org-agenda-show-outline-path~ to show document title Setting ~org-agenda-show-outline-path~ to ~'title~ will show title instead of the file name at the beginning of the outline. The title of the document can be set by special keyword =#+title:=. *** New custom settings =org-icalendar-scheduled-summary-prefix= and =org-icalendar-deadline-summary-prefix= These settings allow users to define prefixes for exported summary lines in ICS exports. The customization can be used to disable the prefixes completely or make them a little bit more verbose (e.g. "Deadline: " instead of the default "DL: "). The same settings can also be applied via corresponding exporter options: =:icalendar-scheduled-summary-prefix=, =:icalendar-deadline-summary-prefix= *** A new custom setting =org-hide-drawer-startup= to control initial folding state of drawers Previously, all the drawers were always folded when opening an Org file. This only had an effect on the drawers outside folded headlines. The drawers inside folded headlines were re-folded because =org-cycle-hide-drawers= was present inside =org-cycle-hook=. With the new folding backend, running =org-cycle-hide-drawers= is no longer needed if all the drawers are truly folded on startup: [[*Folding state of the drawers is now preserved when cycling headline visibility]]. However, this has an unwanted effect when a user does not want the drawers to be folded (see [[https://orgmode.org/list/m2r14f407q.fsf@ntnu.no][this bug report]]). The new custom setting gives more control over initial folding state of the drawers. When set to =nil= (default is =t=), the drawers are not folded on startup. The folding state can also be controlled on per-file basis using =STARTUP= keyword: : #+startup: hidedrawers : #+startup: nohidedrawers *** New custom setting ~org-icalendar-force-alarm~ The new setting, when set to non-nil, makes Org create alarm at the event time when the alarm time is set to 0. The default value is nil -- do not create alarms at the event time. *** New special value ~'attach~ for src block =:dir= option Passing the symbol ~attach~ or string ="'attach"= (with quotes) to the =:dir= option of a src block is now equivalent to =:dir (org-attach-dir) :mkdir yes= and any file results with a path descended from the attachment directory will use =attachment:= style links instead of the standard =file:= link type. ** New functions and changes in function arguments *** New function ~org-get-title~ to get =#+TITLE:= property from buffers A function to collect the document title from the org-mode buffer. *** ~org-fold-show-entry~ does not fold drawers by default anymore ~org-fold-show-entry~ now accepts an optional argument HIDE-DRAWERS. When the argument is non-nil, the function folds all the drawers inside entry. This was the default previously. Now, ~org-fold-show-entry~ does not fold drawers by default. *** New command ~org-edit-comment-block~ to edit comment block at point As the contents of comments blocks is not parsed as Org markup, the headlines and keywords inside should be escaped, similar to src blocks, example blocks, and export blocks. This in inconvenient to do manually and ~org-edit-special~ is usually advised to edit text in such kind of blocks. Now, comment block editing is also supported via this new function. *** New function ~org-element-cache-map~ for quick mapping across Org elements When element cache is enabled, the new function provides the best possible performance to map across large Org buffers. It is recommended to provide =:next-re= and =:fail-re= parameters for best speed. Diagnostic information about execution speed can be provided according to ~org-element--cache-map-statistics~ and ~org-element--cache-map-statistics-threshold~. ~org-scan-tags~ and tag views in agenda utilize the new function. *** New function ~org-element-at-point-no-context~ This function is like ~org-element-at-point~, but it does not try to update the cache and does not guarantee correct =:parent= properties for =headline= elements. This function is faster than ~org-element-at-point~ when used together with frequent buffer edits. *** Various Org API functions now use cache and accept Org elements as optional arguments ~org-in-archived-heading-p~, ~org-in-commented-heading-p~, ~org-up-heading-safe~, ~org-end-of-subtree~, ~org-goto-first-child~, ~org-back-to-heading~, ~org-entry-get-with-inheritance~, and ~org-narrow-to-subtree~ all accept Org element as an extra optional argument. ~org-get-tags~ now accepts Org element or buffer position as first argument. *** New function ~org-texinfo-kbd-macro~ This function is intended for us in the definition of a ~kbd~ macro in files that are exported to Texinfo. *** =org-at-heading-p= now recognizes optional argument. Its meaning is inverted. =org-at-heading-p= now returns t by default on headings inside folds. Passing optional argument will produce the old behavior. *** =org-babel-execute:plantuml= can output ASCII graphs in the buffer Previously, executing PlantUML src blocks always exported to a file. Now, if :results is set to a value which does not include "file", no file will be exported and an ASCII graph will be inserted below the src block. ** Removed or renamed functions and variables *** =org-plantump-executable-args= is renamed and applies to jar as well The new variable name is =org-plantuml-args=. It now applies to both jar PlantUML file and executable. *** Default values and interpretations of ~org-time-stamp-formats~ and ~org-time-stamp-custom-formats~ are changed Leading =<= and trailing =>= in the default values of ~org-time-stamp-formats~ and ~org-time-stamp-custom-formats~ are stripped. The Org functions that are using these variables also ignore leading and trailing brackets (=<...>= and =[...]=, if present). This change makes the Org code more consistent and also makes the docstring for ~org-time-stamp-custom-formats~ accurate. No changes on the user side are needed if ~org-time-stamp-custom-formats~ was customized. *** ~org-timestamp-format~ is renamed to ~org-format-timestamp~ The old function name is similar to other ~org-time-stamp-format~ function. The new name emphasizes that ~org-format-timestamp~ works on =timestamp= objects. *** Updated argument list in ~org-time-stamp-format~ New =custom= argument in ~org-time-stamp-format~ makes the function use ~org-time-stamp-custom-formats~ instead of ~org-time-stamp-formats~ to determine the format. Optional argument =long= is renamed to =with-time=, emphasizing that it refers to time stamp format with time specification. Optional argument =inactive= can now have a value =no-brackets= to return format string with brackets stripped. ** Miscellaneous *** SQL Babel ~:dbconnection~ parameter can be mixed with other SQL Babel parameters Before you could either specify SQL parameters like ~:dbhost~, ~:dbuser~, ~:database~, etc or a ~:dbconnection~ parameter which looks up all other parameters from the ~sql-connection-alist~ variable. Now it's possible to specify a ~:dbconnection~ and additionally other parameters that will add or overwrite the parameters coming from ~sql-connection-alist~. E.g. if you have a connection in your ~sql-connection-alist~ to a server that has many databases, you don't need an entry for every database but instead can just specify ~:database~ next to your ~:dbconnection~ parameter. *** Post-processing code blocks can return an empty list When the result of a regular code block is nil, then that was already treated as an empty list. Now that is also the case for code blocks that post-process the result of another block. *** Styles are customizable in ~biblatex~ citation processor It is now possible to add new styles or modify old ones in ~biblatex~ citation processor. See ~org-cite-biblatex-styles~ for more information. *** Citation processors can declare styles dynamically When a citation processor is registered, it is now possible to set ~:cite-styles~ key to a function, which will be called whenever the list of styles is required. *** Org also searches for CSL style files in default directory When CSL style file name is relative, Org first looks into default-directory before trying ~org-cite-csl-styles-dir~. *** Users can add checkers to the linting process The function ~org-lint-add-checker~ allows one to add personal checks when calling ~org-lint~. See its docstring for more information. *** New =transparent-image-converter= property for =dvipng= The =dvipng= option in ~org-preview-latex-process-alist~ has a new property =transparent-image-converter= which is used instead of =image-converter= when producing transparent images. *** =:tangle-mode= now accepts more permissions formats Previously =:tangle-mode (identity #o755)= was the only reasonable way to set the file mode. ~org-babel-interpret-file-mode~ has been introduced which will accept three new formats: + Short octals, e.g. =:tangle-mode o755= + ls-style, e.g. =:tangle-mode rwxrw-rw-= + chmod-style, e.g. =:tangle-mode u+x= Chmod-style permissions are based on the new variable ~org-babel-tangle-default-file-mode~. *** A new custom setting =org-agenda-clock-report-header= to add a header to org agenda clock report *** ~org-latex-listings~ has been replaced with ~org-latex-src-block-backend~ ~org-latex-listings~ has been renamed to better reflect the current purpose of the variable. The replacement variable ~org-latex-src-block-backend~ acts in exactly the same way, however it accepts =listings= and =verbatim= in place of =t= and =nil= (which still work, but are no longer listed as valid options). *** ~org-link-parameters~ has a new ~:insert-description~ parameter The value of ~:insert-description~ is used as the initial input when prompting for a link description. It can be a string (used as-is) or a function (called with the same arguments as ~org-make-link-description-function~ to return a string to use). An example of a such function for =info:= links is ~org-info-description-as-command~. To access a manual section outside of Org, description may be pasted to shell prompt or evaluated within Emacs using =M-:= (wrapped into parenthesis). For example, description of the =info:org#Tags= link is =info "(org) Tags"=. To restore earlier behavior add to your Emacs init file the following: #+begin_src elisp :results silent :eval never-export (with-eval-after-load 'ol-info (org-link-set-parameters "info" :insert-description nil)) #+end_src *** New list of languages for LaTeX export: ~org-latex-language-alist~ ~org-latex-language-alist~ unifies into a single list the old language lists for the =babel= and =polyglossia= LaTeX packages: ~org-latex-babel-language-alist~ and ~org-latex-polyglossia-language-alist~, respectively, which are declared obsolete. This new list captures the current state of art regarding language support in LaTeX. The new =babel= syntax for loading languages via =ini= files and the new command =\babelprovide= (see: https://mirrors.ctan.org/macros/latex/required/babel/base/babel.pdf) are also supported. *** Texinfo exports include LaTeX With the new customization option ~org-texinfo-with-latex~ set to (its default value) ~'detect~, if the system runs Texinfo 6.8 (3 July 2021) or newer, Org will export all LaTeX fragments and environments using Texinfo ~@math~ and ~@displaymath~ commands respectively. *** More flexible ~org-attach-id-to-path-function-list~ List entries may return nil if they are unable to handle the passed ID. So, responsibility is passed to the next item in the list. Default entries ~org-attach-id-uuid-folder-format~ and ~org-attach-id-ts-folder-format~ now return nil for too short IDs. Earlier an obscure error has been thrown. After the change, error text suggests adjusting ~org-attach-id-to-path-function-list~ value. The ~org-attach-dir-from-id~ function is adapted to ignore nil values and to take first non-nil value instead of the value returned by first ~org-attach-id-to-path-function-list~ item. New policy allows mixing different ID styles while keeping subfolder layout suited best for each one. For example, one can use the following snippet to allow multiple different ID formats in Org files. #+begin_src emacs-lisp (setq org-attach-id-to-path-function-list '(;; When ID looks like an UUIDs or Org internal ID, use ;; `org-attach-id-uuid-folder-format'. (lambda (id) (and (or (org-uuidgen-p id) (string-match-p "[0-9a-z]\\{12\\}" id)) (org-attach-id-uuid-folder-format id))) ;; When ID looks like a timestamp-based ID. Group by year-month ;; folders. (lambda (id) (and (string-match-p "[0-9]\\{8\\}T[0-9]\\{6\\}\.[0-9]\\{6\\}" id) (org-attach-id-ts-folder-format id))) ;; Any other ID goes into "important" folder. (lambda (id) (format "important/%s/%s" (substring id 0 1) id)) ;; Fallback to detect existing attachments for old defaults. ;; All the above functions, even when return non-nil, would ;; point to non-existing folders. org-attach-id-uuid-folder-format org-attach-id-ts-folder-format)) #+end_src * Version 9.5 ** Important announcements and breaking changes *** The =contrib/= now lives in a separate repository Org's repository has been trimmed from the =contrib/= directory. The old contents of the =contrib/= directory now lives in a separate repository at https://git.sr.ht/~bzg/org-contrib. You can install this repository by cloning it and updating your ~load-path~ accordingly. You can also install =org-contrib= as a [[https://elpa.nongnu.org/nongnu/][NonGNU ELPA]] package. *** Org ELPA and Org archives won't be available for Org > 9.5 [[https://orgmode.org/elpa.html][Org ELPA]] is still available for installing Org 9.5, either with or without contributed packages, but future versions won't be available via Org ELPA, as we are deprecating this installation method. Also, Org 9.5 is available as =tar.gz= and =zip= archives, but this installation method is also deprecated. If you want to install the latest stable versions of Org, please use the GNU ELPA package. If you want to install the contributed files, please use the NonGNU ELPA package. If you want to keep up with the latest unstable Org, please install from the Git repository. See https://orgmode.org/org.html#Installation for the details. *** =ditaa.jar= is not bundled with Org anymore =ditaa.jar= used to be bundled with Org but it is not anymore. See [[https://github.com/stathissideris/ditaa][the ditaa repository]] on how to install it. *** ~org-adapt-indentation~ now defaults to =nil= If you want to automatically indent headlines' metadata, set it to =headline-data=. If you want to automatically indent every line to the headline's current indentation, set it to =t=. Indent added by =RET= and =C-j= also depends on the value of ~electric-indent-mode~. Enabling this mode by default in 9.4 revealed some bugs caused confusing behavior. If you disabled ~electric-indent-mode~ for this reason, it is time to try it again. Hopefully problems have been fixed. See [[https://orgmode.org/worg/org-faq.html#indentation][this FAQ]] for more details. *** ~org-speed-commands-user~ is obsolete, use ~org-speed-commands~ Setting ~org-speed-commands-user~ in your configuration won't have any effect. Please set ~org-speed-commands~ instead, which see. *** Some =ob-*.el= files have been moved to the org-contrib repo These files have been moved to https://git.sr.ht/~bzg/org-contrib: - ob-abc.el - ob-asymptote.el - ob-coq.el - ob-ebnf.el - ob-hledger.el - ob-io.el - ob-J.el - ob-ledger.el - ob-mscgen.el - ob-picolisp.el - ob-shen.el - ob-stan.el - ob-vala.el See the discussion [[msg::87bl9rq29m.fsf@gnu.org][here]]. *** Compatibility with Emacs versions We made it explicit that we aim at keeping the latest stable version of Org compatible with at least Emacs V, V-1 and V-2, where V is the stable major version of Emacs. For example, if the current major version of Emacs is 28.x, then the latest stable version of Org should be compatible with Emacs 28.x, 27.x and 26.x – but not with Emacs 25.x. See [[https://orgmode.org/worg/org-maintenance.html#emacs-compatibility][this note on Worg]] and [[git::519947e508e081e71bf67db99e27b1c171ba4dfe][this commit]]. *** The keybinding for ~org-table-blank-field~ has been removed If you prefer to keep the keybinding, you can add it back to ~org-mode-map~ like so: #+begin_src emacs-lisp (define-key org-mode-map (kbd "C-c SPC") #'org-table-blank-field) #+end_src ** New features *** New citation engine Org 9.5 provides a new library =oc.el= which provides tooling to handle citations in Org, e.g., activate, follow, insert, and export them, respectively called "activate", "follow", "insert" and "export" capabilities. Libraries responsible for providing some, or all, of these capabilities are called "citation processors". The manual contains a few pointers to let you start and you may want to check [[https://blog.tecosaur.com/tmio/2021-07-31-citations.html][this blog post]]. If you need help using this new features, please ask on the mailing list. Thanks to Nicolas Goaziou for implementing this, to Bruce D’Arcus for helping him and to John Kitchin for paving the way with =org-ref.el=. *** Async session evaluation The =:async= header argument can be used for asynchronous evaluation in session blocks for certain languages. Currently, async evaluation is supported in Python. There is also functionality to implement async evaluation in other languages that use comint, but this needs to be done on a per-language basis. By default, async evaluation is disabled unless the =:async= header argument is present. You can also set =:async no= to force it off (for example if you've set =:async= in a property drawer). Async evaluation is disabled during export. *** ~ox-koma-letter.el~ is now part of Org's core ~ox-koma-letter.el~ provides a KOMA scrlttr2 back-end for the Org export engine. It used to be in the =contrib/= directory but it is now part of Org's core. *** Support exporting DOI links Org now supports export for DOI links, through its new =ol-doi.el= library. For backward compatibility, it is loaded by default. *** Add a new ~:refile-targets~ template option When exiting capture mode via ~org-capture-refile~, the variable ~org-refile-targets~ will be temporarily bound to the value of this template option. *** New startup options =#+startup: showlevels= These startup options complement the existing =overview=, =content=, =showall=, =showeverything= with a way to start the document with n levels shown, where n goes from 2 to 5. Example: : #+startup: show3levels *** New =u= table formula flag to enable Calc units simplification mode A new =u= mode flag for Calc formulas in Org tables has been added to enable Calc units simplification mode. *** Support fontification of inline export snippets See [[msg:87im57fh8j.fsf@gmail.com][this thread]]. *** New command =org-refile-reverse= bound to =C-c C-M-w= You can now use =C-c C-M-w= to run ~org-refile-reverse~. It is almost identical to ~org-refile~, except that it temporarily toggles how ~org-reverse-note-order~ applies to the current buffer. So if ~org-refile~ would append the entry as the last entry under the target heading, ~org-refile-reverse~ will prepend it as the first entry, and vice-versa. *** LaTeX attribute ~:float~ now passes through arbitrary values LaTeX users are able to define arbitrary float types, e.g. with the float package. The Org mode LaTeX exporter is now able to process and export arbitrary float types. The user is responsible for ensuring that Org mode configures LaTeX to process any new float type. *** Support verse and quote blocks in LaTeX export The LaTeX export back-end accepts four attributes for verse blocks: =:lines=, =:center=, =:versewidth= and =:latexcode=. The three first require the external LaTeX package =verse.sty=, which is an extension of the standard LaTeX environment. The LaTeX export back-end accepts two attributes for quote blocks: =:environment=, for an arbitrary quoting environment (the default value is that of =org-latex-default-quote-environment=: ="quote"=) and =:options=. *** =org-set-tags-command= selects tags from ~org-global-tags-completion-table~ Let ~org-set-tags-command~ TAB fast tag completion interface complete tags including from both buffer local and user defined persistent global list (~org-tag-alist~ and ~org-tag-persistent-alist~). Now option ~org-complete-tags-always-offer-all-agenda-tags~ is honored. *** Clocktable option =:formula %= now shows the per-file time percentages This change only has an effect when multiple files are contributing to a given clocktable (such as when =:scope agenda= has been specified). The existing behavior is that such tables have an extra 'File' column, and each individual file that contributes has its own summary line with the headline value '*File time*'. Those summary rows also produce a rollup time value for the file in the 'Time' column. Prior to this change, the built-in =%= formula did not produce a calculation for those per-file times in the '%' column (the relevant cells in the '%' column were blank). With this change, the percentage contribution of each individual file time to the total time is shown. The more agenda files you have, the more useful this behavior becomes. *** =ob-python.el= improvements to =:return= header argument The =:return= header argument in =ob-python= now works for session blocks as well as non-session blocks. Also, it now works with the =:epilogue= header argument -- previously, setting the =:return= header would cause the =:epilogue= to be ignored. This change allows more easily moving boilerplate out of the main code block and into the header. For example, for plotting, we need to add boilerplate to save the figure to a file and return the filename. Instead of doing this within the code block, we can now handle it through the header arguments as follows: #+BEGIN_SRC org ,#+header: :var fname="/home/jack/tmp/plot.svg" ,#+header: :epilogue plt.savefig(fname) ,#+header: :return fname ,#+begin_src python :results value file import matplotlib, numpy import matplotlib.pyplot as plt fig=plt.figure(figsize=(4,2)) x=numpy.linspace(-15,15) plt.plot(numpy.sin(x)/x) fig.tight_layout() ,#+end_src ,#+RESULTS: [[file:/home/jack/tmp/plot.svg]] #+END_SRC As another example, we can use =:return= with the external [[https://pypi.org/project/tabulate/][tabulate]] package, to convert pandas Dataframes into orgmode tables: #+begin_src org ,#+header: :prologue from tabulate import tabulate ,#+header: :return tabulate(table, headers=table.columns, tablefmt="orgtbl") ,#+begin_src python :results value raw :session import pandas as pd table = pd.DataFrame({ "a": [1,2,3], "b": [4,5,6] }) ,#+end_src ,#+RESULTS: | | a | b | |---+---+---| | 0 | 1 | 4 | | 1 | 2 | 5 | | 2 | 3 | 6 | #+end_src *** Display images with width proportional to the buffer text width Previously, if you used a =:width= attribute like =#+attr_html: :width 70%= or =#+attr_latex: :width 0.7\linewidth= this would be interpreted as a 70px wide and 0.7px wide width specification respectively. Now, percentages are transformed into floats (i.e. 70% becomes 0.7), and float width specifications between 0.0 and 2.0 are now interpreted as that portion of the text width in the buffer. For instance, the above examples of =70%= and =0.7\linewidth= will result in an image with width equal to the pixel-width of the buffer text multiplied by 0.7. This functionality is implemented in a new function, ~org-display-inline-image--width~ which contains the width determination logic previously in ~org-display-inline-images~ and the new behavior. ** New options *** Option ~org-hidden-keywords~ now also applies to #+SUBTITLE: The option ~org-hidden-keywords~ previously applied to #+TITLE:, #+AUTHOR:, #+DATE:, and #+EMAIL:. Now it can also be used to hide the #+SUBTITLE: keyword. *** New formatting directive ~%L~ for org-capture The new ~%L~ formatting directive contains the bare link target, and may be used to create links with programmatically generated descriptions. *** New option ~org-id-ts-format~ Earlier, IDs generated using =ts= method had a hard-coded format (i.e. =20200923T160237.891616=). The new option allows user to customize the format. Defaults are unchanged. *** New argument for ~file-desc~ babel header It is now possible to provide the =file-desc= header argument for a babel source block but omit the description by passing an empty vector as an argument (i.e., :file-desc []). This can be useful because providing =file-desc= without an argument results in the result of =file= being used in the description. Previously, the only way to omit a file description was to omit the header argument entirely, which made it difficult/impossible to provide a default value for =file-desc=. *** New option to set ~org-link-file-path-type~ to a function ~org-link-file-path-type~ can now be set to a function that takes the full filename as an argument and returns the path to link to. For example, if you use ~project.el~, you can set this function to use relative links within a project as follows: #+begin_src emacs-lisp (setq (org-link-file-path-type (lambda (path) (let* ((proj (project-current)) (root (if proj (project-root proj) default-directory))) (if (string-prefix-p (expand-file-name root) path) (file-relative-name path) (abbreviate-file-name path)))))) #+end_src *** New options and new behavior for babel LaTeX SVG image files Org babel now uses a two-stage process for converting latex source blocks to SVG image files (when the extension of the output file is ~.svg~). The first stage in the process converts the latex block into a PDF file, which is then converted into an SVG file in the second stage. The TeX->PDF part uses the existing infrastructure for ~org-babel-latex-tex-to-pdf~. The PDF->SVG part uses a command specified in a new customization, ~org-babel-latex-pdf-svg-process~. By default, this uses inkscape for conversion, but since it is fully customizable, any other command can be used in its place. For instance, dvisvgm might be used here. This two-part processing replaces the previous use of htlatex to process LaTeX directly to SVG (htlatex is still used for HTML conversion). Conversion to SVG exposes a number of additional customizations that give the user full control over the contents of the latex source block. ~org-babel-latex-preamble~, ~org-babel-latex-begin-env~ and ~org-babel-latex-end-env~ are new customization options added to allow the user to specify the preamble and code that precedes and proceeds the contents of the source block. *** New option ~org-html-meta-tags~ allows for HTML meta tags customization New variable ~org-html-meta-tags~ makes it possible to customize the == tags used in an HTML export. Accepts either a static list of values, or a function that generates such a list (see ~org-html-meta-tags-default~ as an example of the latter). *** Option ~org-agenda-bulk-custom-functions~ now supports collecting bulk arguments When specifying a custom agenda bulk option, you can now also specify a function which collects the arguments to be used with each call to the custom function. *** New faces to improve the contextuality of Org agenda views Four new faces improve certain styles and offer more flexibility for some Org agenda views: ~org-agenda-date-weekend-today~, ~org-imminent-deadline~, ~org-agenda-structure-secondary~, ~org-agenda-structure-filter~. They inherit from existing faces in order to remain backward-compatible. Quoting from [[https://list.orgmode.org/87lf7q7gpq.fsf@protesilaos.com/][this thread]]: #+begin_quote + The 'org-imminent-deadline' is useful to disambiguate generic warnings from deadlines. For example, a warning could be rendered in a yellow colored text and have a bold weight, whereas a deadline might be red and styled with italics. + The 'org-agenda-structure-filter' applies to all tag/term filters in agenda views that search for keywords or patterns. It is designed to inherit from 'org-agenda-structure' in addition to the 'org-warning' face that was present before (and removes the generic 'warning' face from one place). This offers the benefit of consistency, as, say, an increase in font height or a change in font family in 'org-agenda-structure' will propagate to the filter as well. The whole header line thus looks part of a singular design. + The 'org-agenda-structure-secondary' complements the above for those same views where a description follows the header. For instance, the tags view provides information to "Press N r" to filter by a numbered tag. Themes/users may prefer to disambiguate this line from the header above it, such as by using a less intense color or by reducing its height relative to the 'org-agenda-structure'. + The 'org-agenda-date-weekend-today' provides the option to differentiate the current date on a weekend from the current date on weekdays. #+end_quote *** New option ~org-clock-ask-before-exiting~ By default, a function is now added to ~kill-emacs-query-functions~ that asks whether to clock out and save when there's a running clock. Customize ~org-clock-ask-before-exiting~~ to nil to disable this new behavior. *** Option ~org-html-inline-image-rules~ now includes .webp By default ox-html now inlines webp images. *** ~org-html-head-include-scripts~ is now =nil= by default See [[msg:498dbe2e-0cd2-c81e-7960-4a26c566a1f7@memebeam.org][this thread]]. *** New option ~org-html-content-class~ This is the CSS class name to use for the top level content wrapper. *** New option ~org-babel-plantuml-svg-text-to-path~ This option, nil by default, allows to add a SVG-specific post-export step that runs inkscape text-to-path replacement over the output file. *** You can now configure ~org-html-scripts~ and ~org-html-style-default~ ~org-html-scripts~ and ~org-html-style-default~ used to be constants, you can now configure them. *** New option ~org-attach-git-dir~ ~org-attach-git-dir~ will decide whether to use ~org-attach-git-dir~ (the default) or use the attachment directory of the current node, if it is correctly configured as a Git repository. *** New option ~org-attach-sync-delete-empty-dir~ ~org-attach-sync-delete-empty-dir~ controls the deletion of an empty attachment directory at calls of ~org-attach-sync~. There is Never delete, Always delete and Query the user (default). *** ~org-babel-default-header-args~ can now be specified as closures or strings ~org-babel-default-header-args~ now also accepts closures that evaluate to a string. Previously, only direct strings were supported. These closures are evaluated when point is at the source block, which allows them to make use of contextual information at the relevant source block. One example that illustrates the usefulness of this addition (also given in the documentation for ~org-babel-default-header-args~) is: #+begin_src elisp (defun org-src-sha () (let ((elem (org-element-at-point))) (concat (sha1 (org-element-property :value elem)) \".svg\"))) (setq org-babel-default-header-args:latex `((:results . \"file link replace\") (:file . (lambda () (org-src-sha))))) #+end_src This will set the ~:file~ header argument to the sha1 checksum of the contents of the current latex source block. Finally, the closures are only evaluated if they're not overridden for a source block. This improves efficiency in cases where the result of a compute-expensive closure would otherwise be discarded. ** Miscellaneous *** =org-bibtex= includes =doi= and =url= entries when exporting to BiBTeX =doi= and =url= entries have been made optional for some publication types and will be exported if present for those types. *** Missing or empty placeholders in "eval" macros are now =nil= They used to be the empty string. *** =org-goto-first-child= now works before first heading When point is before first heading =org-goto-first-child= will move point to the first child heading, or return nil if no heading exist in buffer. This is in line with the fact that everything before first heading is regarded as outline level 0, i.e. the parent level of all headings in the buffer. Previously =org-goto-first-child= would do nothing before first heading, except return nil. *** Faces of all the heading text elements now conform to the headline face In the past, faces of todo keywords, emphasized text, tags, and priority cookies inherited =default= face. The resulting headline fontification was not always consistent, as discussed in [[msg::87h7sawubl.fsf@protesilaos.com][this bug report]]. Now, the relevant faces adapt to face used to fontify the current headline level. Users who prefer to keep the old behavior should change their face customization explicitly stating that =default= face is inherited. Example of old face customization: #+begin_src emacs-lisp (setq org-todo-keyword-faces '(("TODO" :background "chocolate" :height 0.75))) #+end_src To preserve the old behavior the above customization should be changed to #+begin_src emacs-lisp (setq org-todo-keyword-faces '(("TODO" :inherit default :background "chocolate" :height 0.75))) #+end_src *** Storing ID-links before first heading uses title as description Storing links to files using ~org-store-link~ (==) when ~org-id-link-to-org-use-id~ is not nil will now store the title as description of the link, if available. If no title exists it falls back to the filename as before. *** Change in =org-tags-expand= signature The function does not allow for a third optional parameter anymore. *** LaTeX environment =#+results= are now removed If a babel src block produces a raw LaTeX environment, it will now be recognized as a result, and so replaced when re-evaluated. *** Tag completion now uses =completing-read-multiple= Tag completion now uses =completing-read-multiple= with a simple completion table, which should allow better interoperability with custom completion functions. *** Providing =directory-empty-p= from Emacs 28 as =org-directory-empty-p= *** =org-get-last-sibling= marked as obsolete Use =org-get-previous-sibling= instead. This is just a rename to have a more consistent naming. E.g. recall the pair of funtctions =next-line= / =previous-line=. *** Make org-protocol compatible with =URLSearchParams= JavaScript class Decoder of query part of org-protocol URI recognizes "+" as an encoded space characters now, so it is possible to avoid call to =encodeURIComponent= for each parameter and use more readable expression in bookmarklet: #+begin_example 'org-protocol://store-link?' + new URLSearchParams({ url: location.href, title: document.title}) #+end_example *** Remove obsolete LaTeX packages from ~org-latex-default-packages-alist~ The LaTeX packages =grffile= and =textcomp= are redundant, with their capabilities being merged into =graphicx= and the LaTeX core respectively a while ago. * Version 9.4 ** Incompatible changes *** Possibly broken internal file links: please check and fix A bug has been affecting internal links to headlines, like : [[*Headline][A link to a headline]] Storing a link to a headline may have been broken in your setup and those links may appear as : [[*TODO Headline][A link to a headline]] Following the link above will result in an error: the TODO keyword should not be part of internal file links. You can use the following command to fix links in an Org buffer: #+begin_src emacs-lisp (defun org-fix-links () "Fix ill-formatted internal links. E.g. replace [[*TODO Headline][headline]] by [[*Headline][headline]]. Go through the buffer and ask for the replacement." (interactive) (visible-mode 1) (save-excursion (goto-char (point-min)) (let ((regexp (format "\\[\\[\\*%s\\s-+" (regexp-opt org-todo-keywords-1 t)))) (while (re-search-forward regexp nil t) (when (and (save-excursion (goto-char (match-beginning 0)) (looking-at-p org-link-bracket-re)) (y-or-n-p "Fix link (remove TODO keyword)? ")) (replace-match "[[*"))))) (visible-mode -1)) #+end_src *** Calling conventions changes when opening or exporting custom links This changes affects export back-ends, and libraries providing new link types. Function used in ~:follow~ link parameter is required to accept a second argument. Likewise, function used in ~:export~ parameter needs to accept a fourth argument. See ~org-link-set-parameters~ for details. Eventually, the function ~org-export-custom-protocol-maybe~ is now called with a fourth argument. Even though the 3-arguments definition is still supported, at least for now, we encourage back-end developers to switch to the new signature. *** Python session return values must be top-level expression statements Python blocks with ~:session :results value~ header arguments now only return a value if the last line is a top-level expression statement. Also, when a None value is returned, "None" will be printed under "#+RESULTS:", as it already did with ~:results value~ for non-session blocks. *** In HTML export, change on how outline-container-* is set When the headline has a =CUSTOM_ID=, use this custom id to build the div id. For example, if you have =:CUSTOM_ID: my-headline= then the resulting
will be ~
~. You may want to check whether your HTML files are rendered differently after this change. *** New keybinding == for ~org-force-cycle-archived~ ~org-force-cycle-archived~ used to be associated with == but this keybinding is used in Emacs for navigating tabs in Emacs. The new keybinding is ==. ** New default settings for some options These options now default to =t=: - ~org-loop-over-headlines-in-active-region~ - ~org-fontify-done-headline~ - ~org-src-tab-acts-natively~ You may want to read the docstrings of these options to understand the consequences of this change. Also, ~org-startup-folded~ now defaults to ~showeverything~. ** New features *** =RET= and =C-j= now obey ~electric-indent-mode~ Since Emacs 24.4, ~electric-indent-mode~ is enabled by default. In most major modes, this causes =RET= to reindent the current line and indent the new line, and =C-j= to insert a newline without indenting. Org mode now obeys this minor mode: when ~electric-indent-mode~ is enabled, and point is neither in a table nor on a timestamp or a link: - =RET= (bound to ~org-return~) reindents the current line and indents the new line; - =C-j= (bound to the new command ~org-return-and-maybe-indent~) merely inserts a newline. To get the previous behavior back, disable ~electric-indent-mode~ explicitly: #+begin_src emacs-lisp (add-hook 'org-mode-hook (lambda () (electric-indent-local-mode -1))) #+end_src Alternatively, if you wish to keep =RET= as the "smart-return" key, but dislike Org's default indentation of sections, you may prefer to customize ~org-adapt-indentation~ to either nil or =headline-data=. *** New allowed value for ~org-adapt-indentation~ ~org-adapt-indentation~ now accepts a new value, =headline-data=. When set to this value, Org will only adapt indentation of headline data lines, such as planning/clock lines and property/logbook drawers. Also, with this setting, =org-indent-mode= will keep these data lines correctly aligned with the headline above. *** Looping agenda commands over headlines ~org-agenda-loop-over-headlines-in-active-region~ allows you to loop agenda commands over the active region. When set to =t= (the default), loop over all headlines. When set to ='start-level=, loop over headlines with the same level as the first headline in the region. When set to a string, loop over lines matching this regular expression. *** New minor mode ~org-table-header-line-mode~ Turn on the display of the first data row of the table at point in the window header line when this first row is not visible anymore in the buffer. You can activate this minor mode by default by setting the option ~org-table-header-line-p~ to =t=. You can also change the face for the header line by customizing the ~org-table-header~ face. *** New minor mode ~org-list-checkbox-radio-mode~ When this minor mode is on, checkboxes behave as radio buttons: if a checkbox is turned on, other checkboxes at the same level are turned off. If you want to occasionally toggle a checkbox as a radio button without turning this minor mode on, you can use == to call ~org-toggle-radio-button~. You can also add =#+ATTR_ORG: :radio t= right before the list to tell Org to use radio buttons for this list only. *** Numeric priorities are now allowed (up to 65) You can now set ~org-priority-highest/lowest/default~ to integers to use numeric priorities globally or set, for example #+PRIORITIES: 1 10 5 to define a buffer-local range and default for priorities. Priority commands should work as usual. You cannot use numbers superior to 64 for numeric priorities, as it would clash with priorities like [#A] where the "A" is internally converted to its numeric value of 65. *** Property drawers allowed before first headline Property drawers are now allowed before the first headline. Org mode is moving more towards making things before the first headline behave just as if it was at outline level 0. Inheritance for properties will work also for this level. In other words: defining things in a property drawer before the first headline will make them "inheritable" for all headlines. *** Refinement in window behavior on exiting Org source buffer After editing a source block, Org will restore the window layout when ~org-src-window-setup~ is set to a value that modifies the layout. *** Display remote inline images Org now knows how to display remote images inline. Whether the images are actually displayed is controlled by the new option ~org-display-remote-inline-images~. *** New option to resolve open clock at a provided time ~org-resolve-clocks~ now has a `t' option, which works just like the `k' option, but the user specifies a time of day, not a number of minutes. *** New step value =semimonth= accepted for clock tables *** Allow text rescaling in column view You can now use =C-x C-+= in column view: the columns face size will increase or decrease, together with the column header size. *** New startup option =#+startup: num= When this startup option is set, display headings as numerated. Use =#+startup: nonum= to turn this off. *** New tool for custom links Org provides a new tool ~org-link-open-as-file~, useful when defining new link types similar to "file"-type links. See docstring for details. *** New optional numeric argument for ~org-return~ In situations where ~org-return~ calls ~newline~, multiple newlines can now be inserted with this prefix argument. *** New source code block header argument =:file-mode= Source code block header argument =:file-mode= can set file permissions if =:file= argument is provided. *** =ob-C.el= allows the inclusion of non-system header files In C and C++ blocks, ~:includes~ arguments that do not start with a ~<~ character will now be formatted as double-quoted ~#include~ statements. *** =ob-clojure.el= supports inf-clojure.el and ClojureScript evaluation You can now set ~(setq org-babel-clojure-backend 'inf-clojure)~ and evaluate Clojure source blocks using [[https://github.com/clojure-emacs/inf-clojure][inf-clojure]]. With a header argument like =:alias "alias"= the Clojure REPL will boot with =clojure -Aalias=. Otherwise Clojure will boot with =lein=, =boot= or =tools.deps=, depending on whether the current directory contains a =project.clj=, =build.boot= or =deps.edn=, falling back on ~inf-clojure-generic-cmd~ in case no such file is present. Also, when using [[https://github.com/clojure-emacs/cider][cider]], you can now use =#+begin_src clojurescript= to execute ClojureScript code from Org files. Note that this works only if your Org file is associated with a cider session that knows how to run ClojureScript code. A bare =lein repl= session outside of a directory configured for ClojureScript will /not/ work. *** =ob-java.el= supports Java command line arguments Babel Java blocks recognize header argument =:cmdargs= and pass its value in call to =java=. *** =ob-screen.el= now accepts =:screenrc= header argument Screen blocks now recognize the =:screenrc= header argument and pass its value to the screen command via the "-c" option. The default remains =/dev/null= (i.e. a clean screen session) *** =ob-plantuml=: now supports using PlantUML executable to generate diagrams Set =org-plantuml-exec-mode= to ='plantuml= in order to use the executable instead of JAR. When using an executable it is also possible to configure executable location as well as arguments via: =org-plantuml-executable-path= and =org-plantuml-executable-args=. ** New commands *** ~org-table-header-line-mode~ Turn on a minor mode to display the first data row of the table at point in the header-line when the beginning of the table is invisible. *** ~org-agenda-ctrl-c-ctrl-c~ Hitting == in an agenda view now calls ~org-agenda-set-tags~. *** ~org-hide-entry~ This command is the counterpart of ~org-show-entry~. *** ~org-columns-toggle-or-columns-quit~ == bound to ~org-columns-toggle-or-columns-quit~ replaces the recent ~org-columns-set-tags-or-toggle~. Tag setting is still possible via column view value edit or with ==. *** ~org-datetree-find-month-create~ Find or create a month entry for a date. ** New options and settings *** New option ~org-html-prefer-user-labels~ When non-nil, use =NAME= affiliated keyword, or raw target values, to generate anchor's ID. Otherwise, consistently use internal naming scheme. =CUSTOM_ID= values are still always used, when available. *** New option for using tabs in ~org-agenda-window-setup~ Choosing ~other-tab~ for ~org-agenda-window-setup~ will open the agenda view in a new tab. This will work with versions of Emacs since 27.1 when ~tab-bar-mode~ was introduced. *** New option ~org-table-header-line-p~ Setting this option to =t= will activate ~org-table-header-line-mode~ in org-mode buffers. *** New option ~org-startup-numerated~ When this option is =t=, Org files will start using ~(org-num-mode 1)~ and headings will be visually numerated. You can turn this on/off on a per-file basis with =#+startup: num= or =#+startup: nonum=. *** New option ~org-clock-auto-clockout-timer~ When this option is set to a number and the user configuration contains =(org-clock-auto-clockout-insinuate)=, Org will clock out the currently clocked in task after that number of seconds of idle time. This is useful when you often forget to clock out before being idle and don't want to have to manually set the clocking time to take into account. *** New option to group captured datetime entries by month A new `:tree-type month' option was added to org-capture-templates to group new datetime entries by month. *** New option to show source buffers using "plain" display-buffer There is a new option ~plain~ to ~org-src-window-setup~ to show source buffers using ~display-buffer~. This allows users to control how source buffers are displayed by modifying ~display-buffer-alist~ or ~display-buffer-base-action~. *** New option ~org-archive-subtree-save-file-p~ Archiving a subtree used to always save the target archive buffer. Commit [[git::b186d1d7][b186d1d7]] changed this behavior by always not saving the target buffer, because batch archiving from agenda could take too much time. This new option ~org-archive-subtree-save-file-p~ defaults to the value =from-org= so that archiving a subtree will save the target buffer when done from an org-mode buffer, but not from the agenda. You can also set this option to =t= or to =from-agenda=. *** New option ~org-show-notification-timeout~ This option will add a timeout to notifications. *** New option ~org-latex-to-html-convert-command~ This new option allows you to convert a LaTeX fragment directly into HTML. *** New option ~org-babel-shell-results-defaults-to-output~ By default, source code blocks are executed in "functional mode": it means that the results of executing them are the value of their last statement (see [[https://orgmode.org/manual/Results-of-Evaluation.html][the documentation]].) The value of a shell script's execution is its exit code. But most users expect the results of executing a shell script to be its output, not its exit code. So we introduced this option, that you can set to nil if you want to stick using ~:results value~ as the implicit header. In all Babel libraries, the absence of a ~:results~ header should produce the same result than setting ~:results value~, unless there is an option to explicitly create an exception. See [[msg:CA+A2iZaziAfMeGpBqL6qGrzrWEVvLvC0DUw++T4gCF3NGuW-DQ@mail.gmail.com][this thread]] for more context. *** New option in ~org-attach-store-link-p~ ~org-attach-store-link-p~ has a new option to store a file link to the attachment. *** New option ~org-fontify-todo-headline~ This feature is the same as ~org-fontify-done-headline~, but for TODO headlines instead. This allows you to distinguish TODO headlines from normal headlines. The face can be customized via ~org-headline-todo~. *** New default value for ~org-file-apps~ The new value uses Emacs as the application for opening directory. *** New hook ~org-agenda-filter-hook~ Functions in this hook are run after ~org-agenda-filter~ is called. ** Removed or renamed functions and variables *** Deprecated ~org-flag-drawer~ function Use ~org-hide-drawer-toggle~ instead. *** Deprecated ~org-hide-block-toggle-maybe~ function Use ~org-hide-block-toggle~ instead. *** Deprecated ~org-hide-block-toggle-all~ function This function was not used in the code base, and has no clear use either. It has been marked for future removal. Please contact the mailing list if you use this function. *** Deprecated ~org-return-indent~ function In Elisp code, use ~(org-return t)~ instead. Interactively, =C-j= is now bound to ~org-return-and-maybe-indent~, which indents the new line when ~electric-indent-mode~ is disabled. *** Removed ~org-maybe-keyword-time-regexp~ The variable was not used in the code base. *** Removed ~org-export-special-keywords~ The variable was not used in the code base. *** Renamed ~org-at-property-block-p~ The new name is ~org-at-property-drawer-p~, which is less confusing. *** Renamed ~org-columns-set-tags-or-toggle~ See [[*~org-columns-toggle-or-columns-quit~]]. *** Renamed priority options From ~org-lowest-priority~ to ~org-priority-lowest~. From ~org-default-priority~ to ~org-priority-default~. From ~org-highest-priority~ to ~org-priority-highest~. From ~org-enable-priority-commands~ to ~org-priority-enable-commands~. From ~org-show-priority~ to ~org-priority-show~. ** Miscellaneous *** =ob-screen.el= now respects screen =:session= name Screen babel session are now named based on the =:session= header argument (defaults to ~default~). Previously all session names had ~org-babel-session-~ prepended. *** Forward/backward paragraph functions in line with the rest of Emacs ~org-forward-paragraph~ and ~org-backward-paragraph~, bound to ~~ and ~~ functions mimic more closely behavior of ~forward-paragraph~ and ~backward-paragraph~ functions when available. They also accept an optional argument for multiple calls. See their docstring for details. *** ~org-table-to-lisp~ no longer checks if point is at a table The caller is now responsible for the check. It can use, e.g., ~org-at-table-p~. The function is also much more efficient than it used to be, even on very large tables. *** New function ~org-collect-keywords~ *** Drawers' folding use an API similar to block's Tooling for folding drawers interactively or programmatically is now on par with block folding. In particular, ~org-hide-drawer-toggle~, a new function, is the central place for drawer folding. *** Duration can be read and written in compact form ~org-duration-to-minutes~ understands =1d3h5min= as a duration, whereas ~org-duration-from-minutes~ can output this compact form if the duration format contains the symbol ~compact~. *** C-n, C-p, SPC and DEL in agenda commands dispatch window You can now use ==, ==, == and == key to scroll up and down the agenda and attach dispatch window. *** == in agenda calls ~org-agenda-set-tags~ Both == and == set the tags of the headline in the Org buffer. Both keybindings are now available from the agenda too. *** Allow to use an empty HTML extension Using =(setq org-html-extension "")= or setting the HTML extension in any fashion will produce the expected output, with no trailing period to the resulting HTML file. *** Handle repeated tasks with =.+= type and hours step A task using a =.+= repeater and hours step is repeated starting from now. E.g., #+begin_example ,,** TODO Wash my hands DEADLINE: <2019-04-05 08:00 Sun .+1h> Marking this DONE shifts the date to exactly one hour from now. #+end_example *** The format of equation reference in HTML export can now be specified By default, HTML (via MathJax) and LaTeX export equation references using different commands. LaTeX must use ~\ref{%s}~ because it is used for all labels; however, HTML (via MathJax) uses ~\eqref{%s}~ for equations producing inconsistent output. New option ~org-html-equation-reference-format~ sets the command used in HTML export. *** =ob-haskell.el= supports compilation with =:compile= header argument By default, Haskell blocks are interpreted. By adding =:compile yes= to a Haskell source block, it will be compiled, executed and the results will be displayed. *** Support for ~org-edit-special~ with LaTeX fragments Calling ~org-edit-special~ on an inline LaTeX fragment calls a new function, ~org-edit-latex-fragment~. This functions in a comparable manner to editing inline source blocks, bringing up a minibuffer set to LaTeX mode. The math-mode deliminators are read only. *** ~org-capture-current-plist~ is now accessible during ~org-capture-mode-hook~ *** New =org-refile.el= file Org refile variables and functions have been moved to a new file. *** The end of a 7 years old bug This bug [[https://lists.gnu.org/archive/html/emacs-orgmode/2013-08/msg00072.html][originally reported]] by Matt Lundin and investigated by Andrew Hyatt has been fixed. Thanks to both of them. * Version 9.3 ** Incompatible changes *** Change bracket link escaping syntax Org used to percent-encode sensitive characters in the URI part of the bracket links. Now, escaping mechanism uses the usual backslash character, according to the following rules: 1. All =[= and =]= characters in the URI must be escaped; 2. Every =\= character preceding either =[= or =]= must be escaped; 3. Every =\= character at the end of the URI must be escaped. When in doubt, use the function ~org-link-escape~ in order to turn a link string into its properly escaped form. The following function will help switching your links to the new syntax: #+begin_src emacs-lisp (defun org-update-link-syntax (&optional no-query) "Update syntax for links in current buffer. Query before replacing a link, unless optional argument NO-QUERY is non-nil." (interactive "P") (org-with-point-at 1 (let ((case-fold-search t)) (while (re-search-forward "\\[\\[[^]]*?%\\(?:2[05]\\|5[BD]\\)" nil t) (let ((object (save-match-data (org-element-context)))) (when (and (eq 'link (org-element-type object)) (= (match-beginning 0) (org-element-property :begin object))) (goto-char (org-element-property :end object)) (let* ((uri-start (+ 2 (match-beginning 0))) (uri-end (save-excursion (goto-char uri-start) (re-search-forward "\\][][]" nil t) (match-beginning 0))) (uri (buffer-substring-no-properties uri-start uri-end))) (when (or no-query (y-or-n-p (format "Possibly obsolete URI syntax: %S. Fix? " uri))) (setf (buffer-substring uri-start uri-end) (org-link-escape (org-link-decode uri))))))))))) #+end_src The old ~org-link-escape~ and ~org-link-unescape~ functions have been renamed into ~org-link-encode~ and ~org-link-decode~. *** Change match group number in ~org-link-bracket-re~ Link description, if any, is located in match group 2 instead of match group 3. *** ob-clojure does not auto prepend ~(ns ..)~ statement anymore When tangling, user usually just wants to tangle literally code instead of prepend inserting a ~(ns ..)~ statement before source block code. Now, when you have no ~:ns~ header argument specified, this behavior will not happen automatically. *** Change in behavior on exit from an Org edit buffer Org will no longer attempt to restore the window configuration in the frame to which the user returns after editing a source block with ~org-edit-src-code~. Instead, the window configuration will remain as it is. *** Change default value for ~org-email-link-description-format~ When linking from a mail buffer, Org used to truncate the subject of the message to 30 characters in order to build the description of the link. This behavior was considered as too surprising. As a consequence, Org no longer truncates subjects. You can get the old behavior back with the following: : (setq org-email-link-description-format "Email %c: %.30s") *** ~:file~ header argument no longer assume "file" ~:results~ The "file" ~:results~ value is now mandatory for a code block returning a link to a file. The ~:file~ or ~:file-ext~ header arguments no longer imply a "file" result is expected. *** Plain numbers are hours in Column View mode See [[git:3367ac9457]] for details. *** All LaTeX preview backends use now xcolor The dvipng backend was previously relying on fg and bg parameters to be passed to the CLI. This didn't work when xcolor was directly or indirectly used in the document (e.g. tkiz is a user of xcolor). Since every other backend was already using xcolor to set fg and bg, the CLI alternative was removed and there is no more a :use-xcolor options since now it's implicitly always true. *** Org-Attach Git commit [[*Org-Attach has been refactored and extended][Refactoring of Org-Attach]] affected the Git commit functionality. Not much, but the following changes are required if you still need to auto-commit attachments to git: - Customization of ~org-attach-annex-auto-get~ needs to be renamed to ~org-attach-git-annex-auto-get~. - Customization of ~org-attach-commit~ is no longer needed. Instead one need to require the =org-attach-git= module in the startup. ** New features *** New option to wrap source code lines in HTML export When new option ~html-wrap-src-lines~ (with variable ~org-html-wrap-src-lines~) is non-nil, HTML export wraps source code lines in HTML ~code~ elements. *** New option to handle schedules and deadlines in iCalendar export Export ignore done tasks with a deadline when ~org-icalendar-use-deadline~ contains ~event-if-todo-not-done~. Likewise, scheduled done tasks are also ignored when ~org-icalendar-use-scheduled~ contains the same symbol. *** Add ~split-window-right~ option for src block edit window placement Given the increasing popularity of wide screen monitors, splitting horizontally may make more sense than splitting vertically. An option, ~split-window-right~, to request horizontal splitting has been added to ~org-src-window-setup~. *** Org-Attach has been refactored and extended Org attach has been refactored and the functionality extended. It should now be easier to understand how it works. A few improvements and extra options have been added as well. From the initial comment in org-attach source-code: - Attachments are managed either by using a custom property DIR or by using property ID from org-id. When DIR is defined, a location in the filesystem is directly attached to the outline node. When org-id is used, attachments are stored in a folder named after the ID, in a location defined by ~org-attach-id-dir~. DIR has precedence over ID when both parameters are defined for the current outline node (also when inherited parameters are taken into account). From now on inheritance requires no extra property and will adhere to ~org-attach-use-inheritance~ by default. Inheritance can be customized to always be activated or never be activated in ~org-attach-use-inheritance~. The ATTACH_DIR property is deprecated in favor of the shorter property DIR. Links to folders inside the DIR property can now be declared as relative links. This is not enabled by default, but can be set in ~org-attach-dir-relative~. When adding new attachment to the outline node the preferred way of doing so can be customized. Take a look at ~org-attach-preferred-new-method~. It defaults to using ID since that was the behavior before this change. If both DIR and ID properties are set on the same node, DIR has precedence and will be used. One can now also choose to build attachment-directory-paths in a customized way. This is an advanced topic, but in some case it makes sense to parse an ID in a different way than the default one. Create your own function and add it to the beginning of ~org-attach-id-to-path-function~list~ if you want to customize the ID based folder structure. If you've used ATTACH_DIR properties to manage attachments, use the following code to rename that property to DIR which supports the same functionality. ATTACH_DIR_INHERIT is no longer supported and is removed. #+begin_src emacs-lisp (defun org-update-attach-properties () "Change properties for Org-Attach." (interactive) (org-with-point-at 1 (while (outline-next-heading) (let ((DIR (org--property-local-values "ATTACH_DIR" nil))) (when DIR (org-set-property "DIR" (car DIR)) (org-delete-property "ATTACH_DIR")))) (org-delete-property-globally "ATTACH_DIR_INHERIT"))) #+end_src For those who hate breaking changes, even though the changes are made to clean things up; fear not. ATTACH_DIR will still continue to work. It's just not documented any longer. When you get the chance, run the code above to clean things up anyway! **** New hooks Two hooks are added to org-attach: - org-attach-after-change-hook - org-attach-open-hook They are added mostly for internal restructuring purposes, but can ofc. be used for other things as well. *** New link-type: Attachment Attachment-links are now first-class citizens. They mimic file-links in everything they do but use the existing attachment-folder as a base when expanding the links. Both =DIR= and =ID= properties are used to try to resolve the links, in exactly the same way as Org-Attach uses those properties. *** Handle overlay specification for notes in Beamer export This aligns Beamer notes with slide overlays. *** Add support for lettered lists in Texinfo Using =:enum A= or =:enum a= Texinfo attribute switches an otherwise numbered list to a lettered list. *** Add a dispatcher command to insert dynamic blocks You can add new dynamic blocks with function ~org-dynamic-block-define~. All such dynamic blocks can be used by ~org-dynamic-block-insert-dblock~ command. *** Babel **** ob-emacs-lisp sets ~lexical-binding~ in Org edit buffers When editing an Elisp src block, the editing buffer's ~lexical-binding~ is set according to the src block's =:lexical= parameter. **** Add LaTeX output support in PlantUML *** New minor mode to display headline numbering Use == to get a visual indication of the numbering in the outline. The numbering is also automatically updated upon changes in the buffer. *** New property =HTML_HEADLINE_CLASS= in HTML export The new property =HTML_HEADLINE_CLASS= assigns a class attribute to a headline. *** Allow LaTeX attributes and captions for "table.el" tables Supported LaTeX attributes are ~:float~, ~:center~, ~:font~ and ~:caption~. *** Attach buffer contents to headline With == key from attachment dispatcher (==), it is now possible to write the contents of a buffer to a file in the headline attachment directory. *** iCalendar export respects a =CLASS= property Set the =CLASS= property on an entry to specify a visibility class for that entry only during iCalendar export. The property can be set to anything the calendar server supports. The iCalendar standard defines the values =PUBLIC=, =CONFIDENTIAL=, =PRIVATE=, which can be interpreted as publicly visible, accessible to a specific group, and private respectively. This property can be inherited during iCalendar export, depending on the value of ~org-use-property-inheritance~. *** New parameter for =INCLUDE= keyword Add =:coding CODING-SYSTEM= to include files using a different coding system than the main Org document. For example: #+begin_example ,#+INCLUDE: "myfile.cmd" src cmd :coding cp850-dos #+end_example *** New values in clock tables' step: =month= and =year= *** ODT export handles numbers cookies in lists *** New cell movement functions in tables ~S-~, ~S-~, ~S-~, and ~S-~ now move cells in the corresponding direction by swapping with the adjacent cell. *** New option to natively fontify LaTeX snippets and environments A 'native option was added to org-highlight-latex-and-related. It matches the same structures than 'latex but it calls org-src-font-lock-fontify-block instead, thus bringing about full LaTeX font locking. *** ~org-clone-subtree-with-time-shift~ learned to shift backward in time == (~org-clone-subtree-with-time-shift~) now takes a negative value as a valid repeater to shift time stamps in backward in cloned subtrees. You can give, for example, ‘-3d’ to shift three days in the past. *** Toggle display of all vs. undone scheduled habits conveniently == (~org-habit-toggle-display-in-agenda~) in an agenda toggles the display of all habits to those which are undone and scheduled. This is a function for convenience. *** New parameter for SQL Babel blocks: ~:dbconnection~ The new parameter ~:dbconnection~ allows to specify a connection name in a SQL block header: this name is used to look up connection parameters in ~sql-connection-alist~. *** New =:scale= attribute supported by LaTeX exporters The builtin "latex" exporters now accept and use a =:scale= attribute, which scales an image by a given factor. This attribute is wrapped around the =scale= parameter of LaTeX's =\includegraphics= (bitmap images) or a TiKZ's =\scalebox=. Therefore, its value should be some string palatable to LaTeX as a positive float Its default value is an empty string (i.e. disabled). This attribute overrides the =:width= and =:height= attributes. #+begin_example ,#+name: Beastie ,#+caption: I think I saw this curious horse already, but where ? ,#+LATEX_ATTR: :scale 2 [[https://orgmode.org/img/org-mode-unicorn-logo.png]] #+end_example *** Allow specifying the target for a table of contents The =+TOC= keyword now accepts a =:target:= attribute that specifies the headline to use for making the table of contents. #+begin_example ,* Target :PROPERTIES: :CUSTOM_ID: TargetSection :END: ,** Heading A ,** Heading B ,* Another section ,#+TOC: headlines 1 :target "#TargetSection" #+end_example ** New functions *** ~org-dynamic-block-insert-dblock~ Use default keybinding == to run command ~org-dynamic-block-insert-dblock~. It will prompt user to select dynamic block in ~org-dynamic-block-alist~. *** ~org-table-cell-up~ *** ~org-table-cell-down~ *** ~org-table-cell-left~ *** ~org-table-cell-right~ *** ~org-habit-toggle-display-in-agenda~ ** Removed functions and variables *** Removed Org Drill You can install it back from MELPA. *** ~org-babel-set-current-result-hash~ *** ~org-capture-insert-template-here~ *** ~org-attach-directory~ It has been deprecated in favor of ~org-attach-id-dir~ which is less ambiguous given the restructured org-attach. *** ~org-enable-fixed-width-editor~ This variable was not used through the code base. ** Miscellaneous *** Change signature for ~org-list-to-subtree~ The function now accepts the level of the subtree as an optional argument. It no longer deduces it from the current level. *** LaTeX preview is simplified Function ~org-latex-preview~, formerly known as ~org-toggle-latex-fragment~, has a hopefully simpler and more predictable behavior. See its docstring for details. *** ~org-table-copy-down~ supports patterns When ~org-table-copy-increment~ is non-nil, it is now possible to increment fields like =A1=, or =0A=, i.e., any string prefixed or suffixed with a whole number. *** No more special indentation for description items Descriptions items are indented like regular ones, i.e., text starts after the bullet. Special indentation used to introduce bugs when inserting sub-items in a description list. *** New hook: ~org-todo-repeat-hook~ This hook was actually introduced in Org 9.2.1, but wasn't advertised. *** Org Table reads numbers starting with 0 as strings *** Disable fast tag selection interface via prefix arg A call of ~org-set-tags-command~ with prefix argument C-u C-u avoids the fast tag selection interface and instead offers the plain interface. *** ~:mkdirp~ now supports create directory for ~:dir~ path The ~:mkdirp~ header argument used to only work for ~:tangle~ tangle files. Now ~:mkdirp~ works for ~:dir~ too. This is more convenient for specify default directory and with ~:file~ header argument. *** New variable: ~org-agenda-breadcrumbs-separator~ If breadcrumbs are showed in org-agenda with the help of "%b" format in ~org-agenda-prefix-format~, user can customize breadcrumbs's separator using ~org-agenda-breadcrumbs-separator~. *** New variable ~org-attach-commands~ This variable makes it possible to customize the list of commands for the attachment dispatcher. *** New ID method based on timestamp If one chooses, it is now possible to create ID's based on timestamp (ISO8601) instead of UUID by changing org-id-method to ts. For an improved folder structure when using timestamp as ID, make sure to promote ~org-attach-id-ts-folder-format~ to the first element of ~org-attach-id-to-path-function-list~ in your configuration at the same time. *** New customization: ~org-id-locations-relative~ New customization to make the persisting of org-id-locations between sessions to store links to files as relative instead of absolute. The links will be stored as relative to the path of org-id-locations-file. *** ~org-ctrl-c-tab~ is functional before the first headline I.e. treat the whole file as if it was a subtree. Also fold everything below the chosen level. Former behavior was to leave unfolded subtrees unfolded. *** ~org-kill-note-or-show-branches~ is functional before the first headline I.e. treat the whole file as if it was a subtree. *** Respect narrowing when agenda command is restricted to buffer *** ~org-table-insert-column~ inserts the column at point position Before, the new column was inserted to the right of the column at point position. *** Table column deletion now consistent with row deletion Point stays in the column at deletion, except when deleting the rightmost column. * Version 9.2 ** Incompatible changes *** Removal of OrgStruct mode mode and radio lists OrgStruct minor mode and radio lists mechanism (~org-list-send-list~ and ~org-list-radio-lists-templates~) are removed from the code base. Note that only radio /lists/ have been removed, not radio tables. If you want to manipulate lists like in Org in other modes, we suggest to use =orgalist.el=, which you can install from GNU ELPA. If you want to use Org folding outside of Org buffers, you can have a look at the outshine package in the MELPA repository. *** Change in the structure template expansion Org 9.2 comes with a new template expansion mechanism, combining ~org-insert-structure-template~ bound to ~C-c C-,~. If you customized the ~org-structure-template-alist~ option manually, you probably need to update it, see the docstring for accepted values. If you prefer using previous patterns, e.g. => ,#+END_SRC #+END_SRC should become #+BEGIN_SRC org ,#+NAME: foo ,#+BEGIN_SRC emacs-lisp :noweb-ref bar 1 ,#+END_SRC ,#+BEGIN_SRC emacs-lisp :noweb-ref bar 2 ,#+END_SRC ,#+BEGIN_SRC emacs-lisp :noweb yes <> ,#+END_SRC #+END_SRC *** Default/accepted values of ~org-calendar-to-agenda-key~ The default value and accepted value of ~org-calendar-to-agenda-key~ changed. This is an excerpt of the new docstring: : When set to ‘default’, bind the function to ‘c’, but only if it is : available in the Calendar keymap. This is the default choice because : ‘c’ can then be used to switch back and forth between agenda and calendar. : : When nil, ‘org-calendar-goto-agenda’ is not bound to any key. Check the full docstring for more. *** Change the signature of the ~org-set-effort~ function Here is the new docstring: : (org-set-effort &optional INCREMENT VALUE) : : Set the effort property of the current entry. : If INCREMENT is non-nil, set the property to the next allowed : value. Otherwise, if optional argument VALUE is provided, use : it. Eventually, prompt for the new value if none of the previous : variables is set. *** Placeholders in =(eval ...)= macros are always strings Within =(eval ...)= macros, =$1=-like placeholders are always replaced with a string. As a consequence, they must not be enclosed within quotes. As an illustration, consider the following, now valid, examples: #+begin_example ,#+macro: join (eval (concat $1 $2)) ,#+macro: sum (eval (+ (string-to-number $1) (string-to-number $2))) {{{join(a,b)}}} => ab {{{sum(1,2)}}} => 3 #+end_example However, there is no change in non-eval macros: #+begin_example ,#+macro: disp argument: $1 {{{disp(text)}}} => argument: text #+end_example *** =align= STARTUP value no longer narrow table columns Columns narrowing (or shrinking) is now dynamic. See [[*Dynamically narrow table columns]] for details. In particular, it is decoupled from aligning. If you need to automatically shrink columns upon opening an Org document, use =shrink= value instead, or in addition to align: #+BEGIN_EXAMPLE ,#+STARTUP: align shrink #+END_EXAMPLE *** ~org-get-tags~ meaning change Function ~org-get-tags~ used to return local tags to the current headline. It now returns all the inherited tags in addition to the local tags. In order to get the old behavior back, you can use: : (org-get-tags nil t) *** Alphabetic sorting in tables and lists When sorting alphabetically, ~org-table-sort-lines~ and ~org-sort-list~ now sort according to the locale’s collation rules instead of by code-point. *** Change the name of the :tags clocktable option to :match The =:match= (renamed from =:tags=) option allows to limit clock entries to those matching a todo-tags matcher. The old =:tags= option can be set to =t= to display a headline's tags in a dedicated column. This is consistent with the naming of =org-dblock-write:columnview= options, where =:match= is also used as a headlines filter. ** New features *** Add ~:session~ support of ob-clojure for CIDER You can initialize source block session with Babel default keybinding =[C-c C-v C-z]= to use =sesman= session manager to link current project, directory or buffer with specific Clojure session, or =cider-jack-in= a new CIDER REPL if no CIDER REPLs available. In older CIDER version which has not =sesman= integrated, only has =cider-jack-in= without Clojure project is supported. #+begin_src clojure :session (dissoc Clojure 'JVM) (conj clojurists "stardiviner") #+end_src *** Add ~:results link~ support for Babel With this output format, create a link to the file specified in ~:file~ header argument, without actually writing any result to it: #+begin_example ,#+begin_src shell :dir "data/tmp" :results link :file "crackzor_1.0.c.gz" wget -c "https://ben.akrin.com/crackzor/crackzor_1.0.c.gz" ,#+end_src ,#+results: [[file:data/tmp/crackzor_1.0.c.gz]] #+end_example *** Add ~:session~ support of ob-js for js-comint #+begin_src js :session "*Javascript REPL*" console.log("stardiviner") #+end_src *** Add ~:session~ support of ob-js for Indium #+begin_src js :session "*JS REPL*" console.log("stardiviner") #+end_src *** Add ~:session~ support of ob-js for skewer-mode #+begin_src js :session "*skewer-repl*" console.log("stardiviner") #+end_src *** Add support for links to LaTeX equations in HTML export Use MathJax links when enabled (by ~org-html-with-latex~), otherwise add a label to the rendered equation. *** Org Tempo may used for snippet expansion of structure template. See manual and the commentary section in ~org-tempo.el~ for details. *** Exclude unnumbered headlines from table of contents Set their =UNNUMBERED= property to the special =notoc= value. See manual for details. *** ~org-archive~ functions update status cookies Archiving headers through ~org-archive-subtree~ and ~org-archive-to-archive-sibling~ such as the ones listed below: #+BEGIN_SRC org ,* Top [1/2] ,** DONE Completed ,** TODO Working #+END_SRC Will update the status cookie in the top level header. *** Disable =org-agenda-overriding-header= by setting to empty string The ~org-agenda-overriding-header~ inserted into agenda views can now be disabled by setting it to an empty string. *** Dynamically narrow table columns With ~C-c TAB~, it is now possible to narrow a column to the width specified by a width cookie in the column, or to 1 character if there is no such cookie. The same keybinding expands a narrowed column to its previous state. Editing the column automatically expands the whole column to its full size. *** =org-columns-summary-types= entries can take an optional COLLECT function You can use this to make collection of a property from an entry conditional on another entry. E.g. given this configuration: #+BEGIN_SRC emacs-lisp (defun custom/org-collect-confirmed (property) "Return `PROPERTY' for `CONFIRMED' entries" (let ((prop (org-entry-get nil property)) (confirmed (org-entry-get nil "CONFIRMED"))) (if (and prop (string= "[X]" confirmed)) prop "0"))) (setq org-columns-summary-types '(("X+" org-columns--summary-sum custom/org-collect-confirmed))) #+END_SRC You can have a file =bananas.org= containing: #+BEGIN_SRC org ,#+columns: %ITEM %CONFIRMED %Bananas{+} %Bananas(Confirmed Bananas){X+} ,* All shipments ,** Shipment 1 :PROPERTIES: :CONFIRMED: [X] :Bananas: 4 :END: ,** Shipment 2 :PROPERTIES: :CONFIRMED: [ ] :BANANAS: 7 :END: #+END_SRC ... and when going to the top of that file and entering column view you should expect to see something like: | ITEM | CONFIRMED | Bananas | Confirmed Bananas | |---------------+-----------+---------+-------------------| | All shipments | | 11 | 4 | | Shipment 1 | [X] | 4 | 4 | | Shipment 2 | [ ] | 7 | 7 | #+BEGIN_EXAMPLE ,#+STARTUP: shrink #+END_EXAMPLE *** Allow to filter by tags/property when capturing colview You can now use =:match= to filter entries using a todo/tags/properties matcher. *** Add support for Oracle's database alias in Babel blocks =ob-sql= library already support running SQL blocks against an Oracle database using ~sqlplus~. Now it's possible to use alias names defined in =TNSNAMES= file instead of specifying full connection parameters. See example below. #+BEGIN_SRC org you can use the previous full connection parameters ,#+BEGIN_SRC sql :engine oracle :dbuser me :dbpassword my_insecure_password :database my_db_name :dbhost my_db_host :dbport 1521 select sysdate from dual; ,#+END_SRC or the alias defined in your TNSNAMES file ,#+BEGIN_SRC sql :engine oracle :dbuser me :dbpassword my_insecure_password :database my_tns_alias select sysdate from dual; ,#+END_SRC #+END_SRC *** ~org-agenda-set-restriction-lock~ toggle agenda restriction at point You can set an agenda restriction lock with =C-x C-x <= or with =<= at the beginning of a headline when using Org speed commands. Now, if there is already a restriction at point, hitting =<= again (or =C-x C-x <=) will remove it. *** Headlines can now link to themselves in HTML export When enabling ~org-html-self-link-headlines~ the headlines exported to HTML contain a hyperlink to themselves. ** New commands and functions *** ~org-insert-structure-template~ This function can be used to wrap existing text of Org elements in a #+BEGIN_FOO/#+END_FOO block. Bound to C-c C-x w by default. *** ~org-export-excluded-from-toc-p~ See docstring for details. *** ~org-timestamp-to-time~ *** ~org-timestamp-from-string~ *** ~org-timestamp-from-time~ *** ~org-attach-dired-to-subtree~ See docstring for details. *** ~org-toggle-narrow-to-subtree~ Toggle the narrowing state of the buffer: when in a narrowed state, widen, otherwise call ~org-narrow-to-subtree~ to narrow. This is attached to the "s" speed command, so that hitting "s" twice will go back to the widen state. *** ~org-browse-news~ Browse https://orgmode.org/Changes.html to let users read information about the last major release. There is a new menu entry for this in the "Documentation" menu item. *** ~org-info-find-node~ From an Org file or an agenda switch to a suitable info page depending on the context. The function is bound to =C-c C-x I=. ** Removed commands and functions *** ~org-outline-overlay-data~ Use ~org-save-outline-visibility~ instead. *** ~org-set-outline-overlay-data~ Use ~org-save-outline-visibility~ instead. *** ~org-get-string-indentation~ It was not used throughout the code base. *** ~org-fix-indentation~ It was not used throughout code base. *** ~org-context-p~ Use ~org-element-at-point~ instead. *** ~org-preserve-lc~ It is no longer used in the code base. *** ~org-try-structure-completion~ Org Tempo may be used as a replacement. See details above. ** Removed options *** org-babel-use-quick-and-dirty-noweb-expansion See [[*Change to Noweb expansion][Change to Noweb expansion]] for explanations. ** Miscellaneous *** New default value for ~org-texinfo-table-scientific-notation~ It is now nil, which means numbers in scientific notation are not handled specially by default. *** New default value for ~org-latex-table-scientific-notation~ It is now nil, which means numbers in scientific notation are not handled specially by default. *** New face: ~org-upcoming-distant-deadline~ It is meant to be used as the face for distant deadlines, see ~org-agenda-deadline-faces~ *** ~org-paste-subtree~ no longer breaks sections Unless point is at the beginning of a headline, ~org-paste-subtree~ now pastes the tree before the next visible headline. If you need to break the section, use ~org-yank~ instead. *** ~org-table-insert-column~ inserts a column to the right It used to insert it on the left. With this change, ~org-table-insert-column~ and ~org-table-delete-column~ are reciprocal. *** ~org-publish-resolve-external-link~ accepts a new optional argument. *** ~org-irc.el~ now supports exporting =irc:= links properly Previously, irc links were exported by ~ox-md~ and ~ox-html~ as normal file links, which lead to them being broken in web browsers. Now both of these exporters will properly export to =irc:= links, which will open properly in irc clients from web browsers. *** ~org-comment-dwim~ (bound to =M-;=) now comments headings, if point is on a heading *** Add support for open source block in window below Set option ~org-src-window-setup~ to ~split-window-below~. *** Alphabetic sorting in headings and tags now uses the locale’s sorting rules When sorting alphabetically, ~org-sort-entries~ and ~org-tags-sort-function~ now sort according to the locale’s collation rules instead of by code-point. *** New speed command "k" to kill (cut) the subtree at point * Version 9.1 ** Incompatible changes *** Variables relative to clocksum duration are obsolete ~org-time-clocksum-format~, ~org-time-clocksum-use-fractional~ and ~org-time-clocksum-fractional-format~ are obsolete. If you changed them, consider modifying ~org-duration-format~ instead. Variable ~org-time-clocksum-use-effort-durations~ is also obsolete. Consider setting ~org-duration-units~ instead. *** ~org-at-timestamp-p~ optional argument accepts different values See docstrings for the allowed values. For backward compatibility, ~(org-at-timestamp-p t)~ is still supported, but should be updated accordingly. *** ~org-capture-templates~ no longer accepts S-expressions as file names Since functions are allowed there, a straightforward way to migrate is to turn, e.g., : (file (sexp)) into : (file (lambda () (sexp))) *** Deleted contributed packages =org-ebib.el, =org-bullets.el= and =org-mime.el= have been deleted from the contrib/ directory. You can now find them here : - https://github.com/joostkremers/ebib - https://github.com/sabof/org-bullets - https://github.com/org-mime/org-mime *** Change ~org-texinfo-classes~ value The value cannot support functions to create sectioning commands anymore. Also, the sectioning commands should include commands for appendices. See the docstring for more information. *** Removal of ~:sitemap-sans-extension~ The publishing property is no longer recognized, as a consequence of changes to site-map generation. You can get the same functionality by setting ~:sitemap-format-entry~ to the following #+BEGIN_SRC elisp (lambda (entry style project) (cond ((not (directory-name-p entry)) (format "[[file:%s][%s]]" (file-name-sans-extension entry) (org-publish-find-title entry project))) ((eq style 'tree) (file-name-nondirectory (directory-file-name entry))) (t entry))) #+END_SRC *** Change signature for ~:sitemap-function~ ~:sitemap-function~ now expects to be called with two arguments. See ~org-publish-project-alist~ for details. *** Change signature for some properties in ~org-list-to-generic~ ~:istart~, ~:icount~, ~:iend~ and ~:isep~ now expect the type of the list as their first argument. *** Change signature for ~org-get-repeater~ The optional argument is now a string to extract the repeater from. See docstring for details. *** Change signature for ~org-time-string-to-time~ See docstring for changes. *** Change order of items in ~org-agenda-time-grid~ ~org-agenda-time-grid~ gained an extra item to allow users to customize the string displayed after times in the agenda. See docstring for details. *** ~tags-todo~ custom searches now include DONE keywords Use "/!" markup when filtering TODO keywords to get only not-done TODO keywords. *** ~org-split-string~ returns ~("")~ when called on an empty string It used to return nil. *** Removal of =ob-scala.el= See [[https://github.com/ensime/emacs-scala-mode/issues/114][this github issue]]. You can use =ob-scala.el= as packaged in scala-mode, available from the MELPA repository. ** New features *** iCalendar export uses inheritance for TIMEZONE and LOCATION properties Both these properties can be inherited during iCalendar export, depending on the value of ~org-use-property-inheritance~. *** iCalendar export respects a TIMEZONE property Set the TIMEZONE property on an entry to specify a time zone for that entry only during iCalendar export. The property value should be specified as in "Europe/London". *** ~org-attach~ can move directory contents When setting a new directory for an entry, org-attach offers to move files over from the old directory. Using a prefix arg will reset the directory to old, ID based one. *** New Org duration library This new library implements tools to read and print time durations in various formats (e.g., "H:MM", or "1d 2h 3min"...). See ~org-duration-to-minutes~ and ~org-duration-from-minutes~ docstrings. *** Agenda **** New variable : ~org-agenda-show-future-repeats~ **** New variable : ~org-agenda-prefer-last-repeat~ **** New variable : ~org-deadline-past-days~ See docstring for details. **** Binding C-c C-x < for ~org-agenda-set-restriction-lock-from-agenda~ **** New auto-align default setting for =org-agenda-tags-column= =org-agenda-tags-column= can now be set to =auto=, which will automatically align tags to the right edge of the window. This is now the default setting. *** New value for ~org-publish-sitemap-sort-folders~ The new ~ignore~ value effectively allows toggling inclusion of directories in published site-maps. *** Babel **** Scheme: support for tables **** Scheme: new variable: ~org-babel-scheme-null-to~ This new custom option allows you to use an empty list or null symbol to format the table output, initially assigned to ~hlines~. **** Scheme: new header ~:prologue~ A new block code header has been created for Org Babel that enables developers to prepend code to the scheme block being processed. Multiple ~:prologue~ headers can be added each of them using a string with the content to be added. The scheme blocks are prepared by surrounding the code in the block with a let form. The content of the ~:prologue~ headers are prepended before this let form. **** Support for hledger accounting reports added **** Clojure: new setting ~org-babel-clojure-sync-nrepl-timeout~ Creation of a new setting to specify the Cider timeout. By setting the =org-babel-clojure-sync-nrepl-timeout= setting option. The value is in seconds and if set to nil then no timeout will occur. **** Clojure: new header ~:show-process~ A new block code header has been created for Org Babel that enables developers to output the process of an ongoing process into a new window/buffer. You can tell Org Babel to output the process of a running code block. To show that output you only have to specify the =:show-process= option in the code block's header like this: #+begin_example ,#+BEGIN_SRC clojure :results output :show-process t (dotimes [n 10] (println n ".") (Thread/sleep 500)) ,#+END_SRC #+end_example If =:show-process= is specified that way, then when you will run the code using =C-c C-c= a new window will open in Emacs. Everything that is output by the REPL will immediately be added to that new window. When the processing of the code is finished, then the window and its buffer will be closed and the results will be reported in the =#+RESULTS= section. Note that the =:results= parameter's behavior is *not* changed. If =silent= is specified, then no result will be displayed. If =output= is specified then all the output from the window will appears in the results section. If =value= is specified, then only the last returned value of the code will be displayed in the results section. **** Maxima: new headers ~:prologue~ and ~:epilogue~ Babel options ~:prologue~ and ~:epilogue~ have been implemented for Maxima source blocks which prepend and append, respectively, the given code strings. This can be useful for specifying formatting settings which would add clutter to exported code. For instance, you can use this ~:prologue "fpprintprec: 2; linel: 50;"~ for presenting Maxima results in a beamer presentation. **** PlantUML: add support for header arguments [[https://plantuml.com/][Plantuml]] source blocks now support the [[https://orgmode.org/manual/prologue.html#prologue][~:prologue~]], [[https://orgmode.org/manual/epilogue.html#epilogue][~:epilogue~]] and [[https://orgmode.org/manual/var.html#var][~:var~]] header arguments. **** SQL: new engine added ~sqsh~ A new engine was added to support ~sqsh~ command line utility for use against Microsoft SQL Server or Sybase SQL server. More information on ~sqsh~ can be found here: [[https://sourceforge.net/projects/sqsh/][sourceforge/sqsh]] To use ~sqsh~ in an *sql* =SRC_BLK= set the =:engine= like this: #+begin_example ,#+BEGIN_SRC sql :engine sqsh :dbhost my_host :dbuser master :dbpassword pass :database support Select * From Users Where clue > 0 ,#+END_SRC #+end_example **** SQL: new engine added =vertica= A new engine was added to support vsql command line utility for use against HP Vertica. More information on =vsql= can be found here: [[https://my.vertica.com/docs/7.2.x/HTML/index.htm#Authoring/ConnectingToHPVertica/vsql/UsingVsql.htm][my.vertica.com]] To use =vertica= in an sql =SRC_BLK= set the =:engine= like this: #+BEGIN_EXAMPLE ,#+BEGIN_SRC sql :engine vertica :dbhost my_host :dbuser dbadmin :dbpassword pw :database vmart SELECT * FROM nodes; ,#+END_SRC #+END_EXAMPLE **** C++: New header ~:namespaces~ The new ~:namespaces~ export option can be used to specify namespaces to be used within a C++ org source block. Its usage is similar to ~:includes~, in that it can accept multiple, space-separated namespaces to use. This header is equivalent to adding ~using namespace ;~ in the source block. Here is a "Hello World" in C++ using ~:namespaces~: #+begin_example ,#+BEGIN_SRC C++ :results output :namespaces std :includes cout << "Hello World" << endl; ,#+END_SRC #+end_example **** Support for Vala language [[https://wiki.gnome.org/Projects/Vala][Vala]] language blocks support two special header arguments: - ~:flags~ passes arguments to the compiler - ~:cmdline~ passes commandline arguments to the generated executable Support for [[https://orgmode.org/manual/var.html#var][~:var~]] does not exist yet, also there is no [[https://orgmode.org/manual/session.html#session][~:session~]] support because Vala is a compiled language. The Vala compiler binary can be changed via the ~defcustom~ ~org-babel-vala-compiler~. *** New ~function~ scope argument for the Clock Table Added a nullary function that returns a list of files as a possible argument for the scope of the clock table. *** Export **** Implement vernacular table of contents in Markdown exporter Global table of contents are generated using vanilla Markdown syntax instead of HTML. Also #+TOC keyword, including local table of contents, are now supported. **** Add Slovenian translations **** Implement ~org-export-insert-image-links~ This new function is meant to be used in back-ends supporting images as descriptions of links, a.k.a. image links. See its docstring for details. **** New macro : ~{{{n}}}~ This macro creates and increment multiple counters in a document. See manual for details. **** Add global macros through ~org-export-global-macros~ With this variable, one can define macros available for all documents. **** New keyword ~#+EXPORT_FILE_NAME~ Similarly to ~:EXPORT_FILE_NAME:~ property, this keyword allows the user to specify the name of the output file upon exporting the document. This also has an effect on publishing. **** Horizontal rules are no longer ignored in LaTeX table math mode **** Use ~compilation-mode~ for compilation output **** Plain lists accept a new ~:separator~ attribute in Texinfo The new ~:separator~ attribute splits a tag from a description list item into multiple parts. This allows to have two-column tables with multiple entries in the first column. See manual for more details. **** ~latex-environment~ elements support ~caption~ keywords for LaTeX export *** ~org-edit-special~ can edit LaTeX environments Using ~C-c '~ on a LaTeX environment opens a sub-editing buffer. By default, major mode in that buffer is ~latex-mode~, but it can be changed by configuring ~org-src-lang-modes~. *** ~org-list-to-generic~ includes a new property: ~:ifmt~ ~:ifmt~ is a function to be called on the body of each item. See ~org-list-to-generic~ documentation for details. *** New variable : ~org-bibtex-headline-format-function~ This allow to use a different title than entry title. *** ~org-attach~ supports attaching files from URLs Using ~C-c C-a u~ prompts for a URL pointing to a file to be attached to the document. *** New option for ~org-refile-use-outline-path~ ~org-refile-use-outline-path~ now supports the setting ~buffer-name~, which causes refile targets to be prefixed with the buffer’s name. This is particularly useful when used in conjunction with ~uniquify.el~. *** ~org-file-contents~ now allows the FILE argument to be a URL. This allows ~#+SETUPFILE:~ to accept a URL instead of a local file path. The URL contents are auto-downloaded and saved to a temporary cache ~org--file-cache~. A new optional argument ~NOCACHE~ is added to ~org-file-contents~. *** ~org-mode-restart~ now resets the newly added ~org--file-cache~. Using ~C-c C-c~ on any keyword (like ~#+SETUPFILE~) will reset the that file cache. *** New option : ~org-table-duration-hour-zero-padding~ This variable allow computed durations in tables to be zero-padded. *** New mode switch for table formulas : =U= This mode omits seconds in durations. ** Removed functions *** Org Timeline This feature has been removed. Use a custom agenda view, possibly narrowed to current buffer to achieve a similar functionality. *** ~org-agenda-skip-entry-when-regexp-matches~ is obsolete Use ~org-agenda-skip-if~ instead. *** ~org-agenda-skip-subtree-when-regexp-matches~ is obsolete Use ~org-agenda-skip-if~ instead. *** ~org-agenda-skip-entry-when-regexp-matches-in-subtree~ is obsolete Use ~org-agenda-skip-if~ instead. *** ~org-minutes-to-clocksum-string~ is obsolete Use ~org-duration-from-minutes~ instead. *** ~org-hh:mm-string-to-minutes~ is obsolete Use ~org-duration-to-minutes~ instead. *** ~org-duration-string-to-minutes~ is obsolete Use ~org-duration-to-minutes~ instead. *** ~org-gnus-nnimap-cached-article-number~ is removed. This function relied on ~nnimap-group-overview-filename~, which was removed from Gnus circa September 2010. ** Removed options *** ~org-agenda-repeating-timestamp-show-all~ is removed. For an equivalent to a nil value, set ~org-agenda-show-future-repeats~ to nil and ~org-agenda-prefer-last-repeat~ to =t=. *** ~org-gnus-nnimap-query-article-no-from-file~ is removed. This variable has no effect, as it was relying on a function that was removed from Gnus circa September 2010. *** ~org-usenet-links-prefer-google~ is obsolete. Use ~org-gnus-prefer-web-links~ instead. *** ~org-publish-sitemap-file-entry-format~ is deprecated One can provide new ~:sitemap-format-entry~ property for a function equivalent to the removed format string. *** ~org-enable-table-editor~ is removed. Setting it to a nil value broke some other features (e.g., speed keys). *** ~org-export-use-babel~ cannot be set to ~inline-only~ The variable is now a boolean. *** ~org-texinfo-def-table-markup~ is obsolete Use ~org-texinfo-table-default-markup~ instead. ** New functions *** ~org-publish-find-property~ This function can be used as a tool to format entries in a site-map, in addition to ~org-publish-find-title~ and ~org-publish-find-date~. *** ~org-list-to-org~ It is the reciprocal of ~org-list-to-lisp~, which see. *** ~org-agenda-set-restriction-lock-from-agenda~ Call ~org-agenda-set-restriction-lock~ from the agenda. ** Miscellaneous *** The Library of Babel now on Worg The library-of-babel.org used to be accessible from the =doc/= directory, distributed with Org’s core. It is now accessible from the Worg community-driven documentation [[https://orgmode.org/worg/library-of-babel.html][here]]. If you want to contribute to it, please see [[https://orgmode.org/worg/org-contribute.html][how to contribute]]. *** Allow multiple columns view Columns view is not limited to a single buffer anymore. *** Org Attach obeys ~dired-dwim-target~ When a Dired buffer is opened next to the Org document being edited, the prompt for file to attach can start in the Dired buffer's directory if `dired-dwim-target' in non-nil. *** ~org-fill-paragraph~ can now fill a whole region *** More specific anniversary descriptions Anniversary descriptions (used in the agenda view, for instance) include the point in time, when the anniversary appears. This is, in its most general form, just the date of the anniversary. Or more specific terms, like "today", "tomorrow" or "in n days" are used to describe the time span. This feature allows to automatically change the description of an anniversary, depending on if it occurs in the next few days or far away in the future. *** Computed dates in tables appear as inactive time stamps *** Save point before opening a file with an unknown search option When following a file link with a search option (e.g., =::#custom-id=) that doesn't exist in the target file, save position before raising an error. As a consequence, it is possible to jump back to the original document with ~org-mark-ring-goto~ (default binding =C-c &=). *** ~org-get-heading~ accepts two more optional arguments See docstring for details. *** New option ~org-babel-uppercase-example-markers~ This variable is a ~defcustom~ and replaces the variable ~org-babel-capitalize-example-region-markers~, which is a ~defvar~ and is now obsolete. *** =INCLUDE= keywords in commented trees are now ignored. *** Default value for ~org-texinfo-text-markup-alist~ changed. Now ~=...=~ markup uses ~@samp{}~ instead of ~@verb{}~. You can use ~@verb{}~ again by customizing the variable. *** Texinfo exports example blocks as ~@example~ *** Texinfo exports inline source blocks as ~@code{}~ *** Texinfo default table markup is ~@asis~ It used to be ~@samp~ but ~@asis~ is neutral and, therefore, more suitable as a default value. *** Texinfo default process includes ~--no-split~ option *** New entities : ~\dollar~ and ~\USD~ *** Support for date style URLs in =org-protocol://open-source= URLs like =https://cool-blog.com/2017/05/20/cool-post/= are covered by rewrite rules. *** Add (C) =COMMENT= support to ~org-structure-template-alist~ * Version 9.0 ** Incompatible changes *** Emacs 23 support has been dropped From now on, Org expects at least Emacs 24.3, although Emacs 24.4 or above is suggested. *** XEmacs support has been dropped Incomplete compatibility layer with XEmacs has been removed. If you want to take over maintenance of this compatibility, please contact our mailing list. *** New syntax for export blocks Export blocks are explicitly marked as such at the syntax level to disambiguate their parsing from special blocks. The new syntax is #+BEGIN_SRC org ,#+BEGIN_EXPORT backend ... ,#+END_EXPORT #+END_SRC instead of #+BEGIN_SRC org ,#+BEGIN_backend ... ,#+END_backend #+END_SRC As a consequence, =INCLUDE= keywords syntax is modified, e.g., #+BEGIN_SRC org ,#+INCLUDE: "file.org" HTML #+END_SRC becomes #+BEGIN_SRC org ,#+INCLUDE: "file.org" export html #+END_SRC The following function repairs export blocks and =INCLUDE= keywords using previous syntax: #+BEGIN_SRC emacs-lisp (defun org-repair-export-blocks () "Repair export blocks and INCLUDE keywords in current buffer." (interactive) (when (eq major-mode 'org-mode) (let ((case-fold-search t) (back-end-re (regexp-opt '("HTML" "ASCII" "LATEX" "ODT" "MARKDOWN" "MD" "ORG" "MAN" "BEAMER" "TEXINFO" "GROFF" "KOMA-LETTER") t))) (org-with-wide-buffer (goto-char (point-min)) (let ((block-re (concat "^[ \t]*#\\+BEGIN_" back-end-re))) (save-excursion (while (re-search-forward block-re nil t) (let ((element (save-match-data (org-element-at-point)))) (when (eq (org-element-type element) 'special-block) (save-excursion (goto-char (org-element-property :end element)) (save-match-data (search-backward "_")) (forward-char) (insert "EXPORT") (delete-region (point) (line-end-position))) (replace-match "EXPORT \\1" nil nil nil 1)))))) (let ((include-re (format "^[ \t]*#\\+INCLUDE: .*?%s[ \t]*$" back-end-re))) (while (re-search-forward include-re nil t) (let ((element (save-match-data (org-element-at-point)))) (when (and (eq (org-element-type element) 'keyword) (string= (org-element-property :key element) "INCLUDE")) (replace-match "EXPORT \\1" nil nil nil 1))))))))) #+END_SRC Moreover, ~:export-block~ keyword used in ~org-export-define-backend~ and ~org-export-define-derived-backend~ is no longer used and needs to be removed. *** Footnotes changes **** [1]-like constructs are not valid footnotes Using =[1]= as a footnote was already discouraged in the manual, since it introduced too many false-positives in many Org documents. These constructs are now unsupported. If you used =[N]= in some of your documents, consider turning them into =[fn:N]=. **** /Org Footnote/ library doesn't handle non-Org buffers Commands for footnotes in an Org document no longer try to do something in non-Org ones. If you need to have footnotes there, consider using the =footnote.el= library, shipped with Emacs. In particular, ~org-footnote-tag-for-non-org-mode-files~ no longer exists. *** ~org-file-apps~ no longer accepts S-expressions as commands The variable now accepts functions of two arguments instead of plain S-expressions. Replacing an S-expression with an appropriate function is straightforward. For example : ("pdf" . (foo)) becomes : ("pdf" . (lambda (file link) (foo))) *** The ~{{{modification-time}}}~ macro can get time via =vc= The modification time will be determined via =vc.el= if the second argument is non-nil. See the manual for details. *** Preparation and completion functions in publishing projects change signature Preparation and completion functions are now called with an argument, which is the project property list. It used to be dynamically scoped through the ~project-plist~ variable. *** Old Babel header properties are no longer supported Using header arguments as property names is no longer possible. As such, the following #+BEGIN_EXAMPLE ,* Headline :PROPERTIES: :exports: code :var: a=1 b=2 :var+: c=3 :END: #+END_EXAMPLE should be written instead #+BEGIN_EXAMPLE ,* Headline :PROPERTIES: :header-args: :exports code :header-args+: :var a=1 b=2 :header-args+: :var c=3 :END: #+END_EXAMPLE Please note that, however, old properties were defined at the source block definition. Current ones are defined where the block is called. ** New features *** ~org-eww~ has been moved into core *** New org-protocol key=value syntax Org-protocol can now handle query-style parameters such as: #+begin_example org-protocol://store-link?url=http:%2F%2Flocalhost%2Findex.html&title=The%20title org-protocol://capture?template=x&title=Hello&body=World&url=http:%2F%2Fexample.com #+end_example Old-style links such as : org-protocol://store-link:/http:%2F%2Flocalhost%2Findex.html/The%20title continue to be supported. If you have defined your own handler functions for ~org-protocol-protocol-alist~, change them to accept either a property list (for new-style links) or a string (for old-style links). Use ~org-protocol-parse-parameters~ to convert old-style links into property lists. *** New Org linter library ~org-lint~ can check syntax and report common issues in Org documents. *** New option ~date-tree-last~ for ~org-agenda-insert-diary-strategy~ When ~org-agenda-insert-diary-strategy~ is set to ~date-tree-last~, diary entries are added to last in the date tree. *** New ~vbar~ entity ~\vbar~ or ~\vbar{}~ will be exported unconditionally as a =|=, unlike to existing ~\vert~, which is expanded as ~|~ when using a HTML derived export back-end. *** Export **** New =#+latex_compiler= keyword to set LaTeX compiler. PDFLaTeX, XeLaTeX, and LuaLaTeX are supported. See the manual for details. **** New option ~org-export-with-broken-links~ This option tells the export process how to behave when encountering a broken internal link. See its docstring for more information. **** Attributes support in custom language environments for LaTeX export Custom language environments for LaTeX export can now define the string to be inserted during export, using attributes to indicate the position of the elements. See variable ~org-latex-custom-lang-environments~ for more details. **** New Texinfo ~options~ attribute on special blocks Using ~:options~ as a Texinfo attribute, it is possible to add information to custom environments. See manual for details. **** New HTML ~id~ attributes on special, example and quote blocks If the block has a =#+NAME:= attribute assigned, then the HTML element will have an ~id~ attribute with that name in the HTML export. This enables one to create links to these elements in other places, e.g., ~text~. **** Listings with captions are now numbered in HTML export The class associated to the numbering is "listing-number". If you don't want these blocks to be numbered, as it was the case until now, You may want to add ~.listing-number { display: none; }~ to the CSS used. **** Line Numbering in SRC/EXAMPLE blocks support arbitrary start number The ~-n~ option to ~SRC~ and ~EXAMPLE~ blocks can now take a numeric argument to specify the staring line number for the source or example block. The ~+n~ option can now take a numeric argument that will be added to the last line number from the previous block as the starting point for the SRC/EXAMPLE block. #+BEGIN_SRC org ,#+BEGIN_SRC emacs-lisp -n 20 ;; this will export with line number 20 (message "This is line 21") ,#+END_SRC ,#+BEGIN_SRC emacs-lisp +n 10 ;; This will be listed as line 31 (message "This is line 32") ,#+END_SRC #+END_SRC **** Allow toggling center for images in LaTeX export With the global variable ~org-latex-images-centered~ or the local attribute ~:center~ it is now possible to center an image in LaTeX export. **** Default CSS class ~org-svg~ for SVG images in HTML export SVG images exported in HTML are now by default assigned a CSS class ~org-svg~ if no CSS class is specified with the ~:class~ attribute. By default, the CSS styling of class ~org-svg~ specifies an image width of 90\thinsp{}% of the container the image. **** Markdown footnote export customization Variables ~org-md-footnotes-section~ and ~org-md-footnote-format~ introduced for =ox-md.el=. Both new variables define template strings which can be used to customize the format of the exported footnotes section and individual footnotes, respectively. *** Babel **** Blocks with coderefs labels can now be evaluated The labels are removed prior to evaluating the block. **** Support for Lua language **** Support for SLY in Lisp blocks See ~org-babel-lisp-eval-fn~ to activate it. **** Support for Stan language New ob-stan.el library. Evaluating a Stan block can produce two different results. 1. Dump the source code contents to a file. This file can then be used as a variable in other blocks, which allows interfaces like RStan to use the model. 2. Compile the contents to a model file. This provides access to the CmdStan interface. To use this, set ~org-babel-stan-cmdstan-directory~ and provide a ~:file~ argument that does not end in ".stan". For more information and usage examples, visit https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-stan.html **** Support for Oracle databases via ~sqlplus~ =ob-sql= library supports running SQL blocks against an Oracle database using ~sqlplus~. Use with properties like this (all mandatory): #+BEGIN_EXAMPLE :engine oracle :dbhost :dbport <1521> :dbuser :database :dbpassword #+END_EXAMPLE **** Improved support to Microsoft SQL Server via ~sqlcmd~ =ob-sql= library removes support to the ~msosql~ engine which uses the deprecated ~osql~ command line tool, and replaces it with ~mssql~ engine which uses the ~sqlcmd~ command line tool. Use with properties like this: #+BEGIN_EXAMPLE :engine mssql :dbhost :dbuser :dbpassword :database #+END_EXAMPLE If you want to use the *trusted connection* feature, omit *both* the =dbuser= and =dbpassword= properties and add =cmdline -E= to the properties. If your Emacs is running in a Cygwin environment, the =ob-sql= library can pass the converted path to the =sqlcmd= tool. **** Improved support of header arguments for postgresql The postgresql engine in a sql code block now supports ~:dbport~ and ~:dbpassword~ as header arguments. **** Support for additional plantuml output formats The support for output formats of [[https://plantuml.com/][plantuml]] has been extended to now include: All Diagrams: - png :: - svg :: - eps :: - pdf :: - vdx :: - txt :: ASCII art - utxt :: ASCII art using unicode characters Class Diagrams: - xmi :: - html :: State Diagrams: - scxml :: The output formats are determined by the file extension specified using the :file property, e.g.: #+begin_src plantuml :file diagram.png @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response @enduml #+end_src Please note that *pdf* *does not work out of the box* and needs additional setup in addition to plantuml. See [[https://plantuml.com/pdf.html]] for details and setup information. *** Rewrite of radio lists Radio lists, i.e, Org plain lists in foreign buffers, have been rewritten to be on par with Radio tables. You can use a large set of parameters to control how a given list should be rendered. See manual for details. *** org-bbdb-anniversaries-future Used like ~org-bbdb-anniversaries~, it provides a few days warning for upcoming anniversaries (default: 7 days). *** Clear non-repeated SCHEDULED upon repeating a task If the task is repeated, and therefore done at least one, scheduling information is no longer relevant. It is therefore removed. See [[git:481719fbd5751aaa9c672b762cb43aea8ee986b0][commit message]] for more information. *** Support for ISO week trees ISO week trees are an alternative date tree format that orders entries by ISO week and not by month. For example: : * 2015 : ** 2015-W35 : ** 2015-W36 : *** 2015-08-31 Monday They are supported in org-capture via ~file+weektree~ and ~file+weektree+prompt~ target specifications. *** Accept ~:indent~ parameter when capturing column view When defining a "columnview" dynamic block, it is now possible to add an :indent parameter, much like the one in the clock table. On the other hand, stars no longer appear in an ITEM field. *** Columns view **** ~org-columns~ accepts a prefix argument When called with a prefix argument, ~org-columns~ apply to the whole buffer unconditionally. **** New variable : ~org-agenda-view-columns-initially~ The variable used to be a ~defvar~, it is now a ~defcustom~. **** Allow custom summaries It is now possible to add new summary types, or override those provided by Org by customizing ~org-columns-summary-types~, which see. **** Allow multiple summaries for any property Columns can now summarize the same property using different summary types. *** Preview LaTeX snippets in buffers not visiting files *** New option ~org-attach-commit~ When non-nil, commit attachments with git, assuming the document is in a git repository. *** Allow conditional case-fold searches in ~org-occur~ When set to ~smart~, the new variable ~org-occur-case-fold-search~ allows to mimic =isearch.el=: if the regexp searched contains any upper case character (or character class), the search is case sensitive. Otherwise, it is case insensitive. *** More robust repeated =ox-latex= footnote handling Repeated footnotes are now numbered by referring to a label in the first footnote. *** The ~org-block~ face is inherited by ~src-blocks~ This works also when =org-src-fontify-natively= is non-nil. It is also possible to specify per-languages faces. See =org-src-block-faces= and the manual for details. *** Links are now customizable Links can now have custom colors, tooltips, keymaps, display behavior, etc. Links are now centralized in ~org-link-parameters~. ** New functions *** ~org-next-line-empty-p~ It replaces the deprecated ~next~ argument to ~org-previous-line-empty-p~. *** ~org-show-children~ It is a faster implementation of ~outline-show-children~. ** Removed functions *** ~org-agenda-filter-by-tag-refine~ has been removed. Use ~org-agenda-filter-by-tag~ instead. *** ~org-agenda-todayp~ is deprecated. Use ~org-agenda-today-p~ instead. *** ~org-babel-get-header~ is removed. Use ~org-babel--get-vars~ or ~assq~ instead, as applicable. *** ~org-babel-trim~ is deprecated. Use ~org-trim~ instead. *** ~org-element-remove-indentation~ is deprecated. Use ~org-remove-indentation~ instead. *** ~org-image-file-name-regexp~ is deprecated Use ~image-file-name-regexp~ instead. The never-used-in-core ~extensions~ argument has been dropped. *** ~org-list-parse-list~ is deprecated Use ~org-list-to-lisp~ instead. *** ~org-on-heading-p~ is deprecated A comment to this effect was in the source code since 7.8.03, but now a byte-compiler warning will be generated as well. *** ~org-table-p~ is deprecated Use ~org-at-table-p~ instead. *** ~org-table-recognize-table.el~ is deprecated It was not called by any org code since 2010. *** Various reimplementations of cl-lib functions are deprecated The affected functions are: - ~org-count~ - ~org-remove-if~ - ~org-remove-if-not~ - ~org-reduce~ - ~org-every~ - ~org-some~ Additionally, ~org-sublist~ is deprecated in favor of ~cl-subseq~. Note the differences in indexing conventions: ~org-sublist~ is 1-based and end-inclusive; ~cl-subseq~ is 0-based and end-exclusive. ** Removed options *** Remove all options related to ~ido~ or ~iswitchb~ This includes ~org-completion-use-iswitchb~ and ~org-completion-use-ido~. Instead Org uses regular functions, e.g., ~completion-read~ so as to let those libraries operate. *** Remove ~org-list-empty-line-terminates-plain-lists~ Two consecutive blank lines always terminate all levels of current plain list. *** ~fixltx2e~ is removed from ~org-latex-default-packages-alist~ fixltx2e is obsolete, see LaTeX News 22. ** Miscellaneous *** Add Icelandic smart quotes *** Allow multiple receiver locations in radio tables and lists *** Allow angular links within link descriptions It is now allowed to write, e.g., ~[[http:orgmode.org][]]~ as an equivalent to ~[[http:orgmode.org][file:unicorn.png]]~. The advantage of the former is that spaces are allowed within the path. *** Beamer export back-ends uses ~org-latex-prefer-user-labels~ *** ~:preparation-function~ called earlier during publishing Functions in this list are called before any file is associated to the current project. Thus, they can be used to generate to be published Org files. *** Function ~org-remove-indentation~ changes. The new algorithm doesn't remove TAB characters not used for indentation. *** Secure placeholders in capture templates Placeholders in capture templates are no longer expanded recursively. However, ~%(...)~ constructs are expanded very late, so you can fill the contents of the S-exp with the replacement text of non-interactive placeholders. As before, interactive ones are still expanded as the very last step, so the previous statement doesn't apply to them. Note that only ~%(...)~ placeholders initially present in the template, or introduced using a file placeholder, i.e., ~%[...]~ are expanded. This prevents evaluating potentially malicious code when another placeholder, e.g., ~%i~ expands to a S-exp. *** Links stored by ~org-gnus-store-link~ in nnir groups Since gnus nnir groups are temporary, ~org-gnus-store-link~ now refers to the article's original group. *** ~org-babel-check-confirm-evaluate~ is now a function instead of a macro The calling convention has changed. *** HTML export table row customization changes Variable ~org-html-table-row-tags~ has been split into ~org-html-table-row-open-tag~ and ~org-html-table-row-close-tag~. Both new variables can be either a string or a function which will be called with 6 parameters. *** =ITEM= special property returns headline without stars *** Rename ~org-insert-columns-dblock~ into ~org-columns-insert-dblock~ The previous name is, for the time being, kept as an obsolete alias. *** ~org-trim~ can preserve leading indentation. When setting a new optional argument to a non-nil value, ~org-trim~ preserves leading indentation while removing blank lines at the beginning of the string. The behavior is identical for white space at the end of the string. *** Function ~org-info-export~ changes. HTML links created from certain info links now point to =gnu.org= URL's rather than just to local files. For example info links such as =info:emacs#List Buffers= used to be converted to HTML links like this: : emacs#List Buffers where local file =emacs.html= is referenced. For most folks this file does not exist. Thus the new behavior is to generate this HTML link instead: : emacs#List Buffers All emacs related info links are similarly translated plus few other =gnu.org= manuals. *** Repeaters with a ~++~ interval and a time can be shifted to later today Previously, if a recurring task had a timestamp of ~<2016-01-01 Fri 20:00 ++1d>~ and was completed on =2016-01-02= at =08:00=, the task would skip =2016-01-02= and would be rescheduled for =2016-01-03=. Timestamps with ~++~ cookies and a specific time will now shift to the first possible future occurrence, even if the occurrence is later the same day the task is completed. (Timestamps already in the future are still shifted one time further into the future.) *** ~org-mobile-action-alist~ is now a defconst It used to be a defcustom, with a warning that it shouldn't be modified anyway. *** ~file+emacs~ and ~file+sys~ link types are deprecated They are still supported in Org 9.0 but will eventually be removed in a later release. Use ~file~ link type along with universal arguments to force opening it in either Emacs or with system application. *** New defcustom ~org-babel-J-command~ stores the j command *** New defalias ~org-babel-execute:j~ Allows J source blocks be indicated by letter j. Previously the indication letter was solely J. *** ~org-open-line~ ignores tables at the very beginning of the buffer When ~org-special-ctrl-o~ is non-nil, it is impractical to create a blank line above a table at the beginning of the document. Now, as a special case, ~org-open-line~ behaves normally in this situation. *** ~org-babel-hash-show-time~ is now customizable The experimental variable used to be more or less confidential, as a ~defvar~. *** New ~:format~ property to parsed links It defines the format of the original link. Possible values are: ~plain~, ~bracket~ and ~angle~. * Version 8.3 ** Incompatible changes *** Properties drawers syntax changes Properties drawers are now required to be located right after a headline and its planning line, when applicable. It will break some documents as TODO states changes were sometimes logged before the property drawer. The following function will repair them: #+BEGIN_SRC emacs-lisp (defun org-repair-property-drawers () "Fix properties drawers in current buffer. Ignore non Org buffers." (when (eq major-mode 'org-mode) (org-with-wide-buffer (goto-char (point-min)) (let ((case-fold-search t) (inline-re (and (featurep 'org-inlinetask) (concat (org-inlinetask-outline-regexp) "END[ \t]*$")))) (org-map-entries (lambda () (unless (and inline-re (org-looking-at-p inline-re)) (save-excursion (let ((end (save-excursion (outline-next-heading) (point)))) (forward-line) (when (org-looking-at-p org-planning-line-re) (forward-line)) (when (and (< (point) end) (not (org-looking-at-p org-property-drawer-re)) (save-excursion (and (re-search-forward org-property-drawer-re end t) (eq (org-element-type (save-match-data (org-element-at-point))) 'drawer)))) (insert (delete-and-extract-region (match-beginning 0) (min (1+ (match-end 0)) end))) (unless (bolp) (insert "\n")))))))))))) #+END_SRC *** Using "COMMENT" is now equivalent to commenting with "#" If you used "COMMENT" in headlines to prevent a subtree from being exported, you can still do it but all information within the subtree is now commented out, i.e. no #+OPTIONS line will be parsed or taken into account when exporting. If you want to exclude a headline from export while using its contents for setting options, use =:noexport:= (see =org-export-exclude-tags=.) *** =#+CATEGORY= keywords no longer apply partially to document It was possible to use several such keywords and have them apply to the text below until the next one, but strongly deprecated since Org 5.14 (2008). =#+CATEGORY= keywords are now global to the document. You can use node properties to set category for a subtree, e.g., #+BEGIN_SRC org ,* Headline :PROPERTIES: :CATEGORY: some category :END: #+END_SRC *** New variable to control visibility when revealing a location ~org-show-following-heading~, ~org-show-siblings~, ~org-show-entry-below~ and ~org-show-hierarchy-above~ no longer exist. Instead, visibility is controlled through a single variable: ~org-show-context-detail~, which see. *** Replace disputed keys again when reading a date ~org-replace-disputed-keys~ has been ignored when reading date since version 8.1, but the former behavior is restored again. Keybinding for reading date can be customized with a new variable ~org-read-date-minibuffer-local-map~. *** No default title is provided when =TITLE= keyword is missing Skipping =TITLE= keyword no longer provides the current file name, or buffer name, as the title. Instead, simply ignore the title. *** Default bindings of =C-c C-n= and =C-c C-p= changed The key sequences =C-c C-n= and =C-c C-p= are now bound to ~org-next-visible-heading~ and ~org-previous-visible-heading~ respectively, rather than the =outline-mode= versions of these functions. The Org version of these functions skips over inline tasks (and even-level headlines when ~org-odd-levels-only~ is set). *** ~org-element-context~ no longer return objects in keywords ~org-element-context~ used to return objects on some keywords, i.e., =TITLE=, =DATE= and =AUTHOR=. It now returns only the keyword. *** ~org-timer-default-timer~ type changed from number to string If you have, in your configuration, something like =(setq org-timer-default-timer 10)= replace it with =(setq org-timer-default-timer "10")=. *** Functions signature changes The following functions require an additional argument. See their docstring for more information. - ~org-export-collect-footnote-definitions~ - ~org-html-format-headline-function~ - ~org-html-format-inlinetask-function~ - ~org-latex-format-headline-function~ - ~org-latex-format-inlinetask-function~ - ~org-link-search~ ** New features *** Default lexical evaluation of emacs-lisp source blocks Emacs-lisp source blocks in Babel are now evaluated using lexical scoping. There is a new header to control this behavior. The default results in an eval with lexical scoping. :lexical yes This turns lexical scoping off in the eval (the former behavior). :lexical no This uses the lexical environment with x=42 in the eval. :lexical '((x . 42)) *** Behavior of ~org-return~ changed If point is before or after the headline title, insert a new line without changing the headline. *** Hierarchies of tags The functionality of nesting tags in hierarchies is added to Org mode. This is the generalization of what was previously called "Tag groups" in the manual. That term is now changed to "Tag hierarchy". The following in-buffer definition: #+BEGIN_SRC org ,#+TAGS: [ Group : SubOne SubTwo ] ,#+TAGS: [ SubOne : SubOne1 SubOne2 ] ,#+TAGS: [ SubTwo : SubTwo1 SubTwo2 ] #+END_SRC Should be seen as the following tree of tags: - Group - SubOne - SubOne1 - SubOne2 - SubTwo - SubTwo1 - SubTwo2 Searching for "Group" should return all tags defined above. Filtering on SubOne filters also it's sub-tags. Etc. There is no limit on the depth for the tag hierarchy. *** Additional syntax for non-unique grouptags Additional syntax is defined for grouptags if the tags in the group don't have to be distinct on a heading. Grouptags had to previously be defined with { }. This syntax is already used for exclusive tags and Grouptags need their own, non-exclusive syntax. This behavior is achieved with [ ]. Note: { } can still be used also for Grouptags but then only one of the given tags can be used on the headline at the same time. Example: [ group : sub1 sub2 ] #+BEGIN_SRC org ,* Test :sub1:sub2: #+END_SRC This is a more general case than the already existing syntax for grouptags; { }. *** Define regular expression patterns as tags Tags can be defined as grouptags with regular expressions as "sub-tags". The regular expressions in the group must be marked up within { }. Example use: : #+TAGS: [ Project : {P@.+} ] Searching for the tag Project will now list all tags also including regular expression matches for P@.+. This is good for example for projects tagged with a common identifier, i.e. P@2014_OrgTags. *** Filtering in the agenda on grouptags (Tag hierarchies) Filtering in the agenda on grouptags filters all of the related tags. Except if a filter is applied with a (double) prefix-argument. Filtering in the agenda on subcategories does not filter the "above" levels anymore. If a grouptag contains a regular expression the regular expression is also used as a filter. *** Minor refactoring of ~org-agenda-filter-by-tag~ Now uses the argument ARG and optional argument exclude instead of strip and narrow. ARG because the argument has multiple purposes and makes more sense than strip now. The term "narrowing" is changed to exclude. The main purpose is for the function to make more logical sense when filtering on tags now when tags can be structured in hierarchies. *** Babel: support for sed scripts Thanks to Bjarte Johansen for this feature. *** Babel: support for Processing language New ob-processing.el library. This library implements necessary functions for implementing editing of Processing code blocks, viewing the resulting sketches in an external viewer, and HTML export of the sketches. Check the documentation for more details. Thanks to Jarmo Hurri for this feature. *** New behavior for ~org-toggle-latex-fragment~ The new behavior is the following: - With a double prefix argument or with a single prefix argument when point is before the first headline, toggle overlays in the whole buffer; - With a single prefix argument, toggle overlays in the current subtree; - On latex code, toggle overlay at point; - Otherwise, toggle overlays in the current section. *** Additional markup with =#+INCLUDE= keyword The content of the included file can now be optionally marked up, for instance as HTML. See the documentation for details. *** File links with =#+INCLUDE= keyword Objects can be extracted via =#+INCLUDE= using file links. It is possible to include only the contents of the object. See manual for more information. *** Drawers do not need anymore to be referenced in =#+DRAWERS= One can use a drawer without listing it in the =#+DRAWERS= keyword, which is now obsolete. As a consequence, this change also deprecates ~org-drawers~ variable. *** ~org-edit-special~ can edit export blocks Using C-c ' on an export block now opens a sub-editing buffer. Major mode in that buffer is determined by export backend name (e.g., "latex" \to "latex-mode"). You can define exceptions to this rule by configuring ~org-src-lang-modes~, which see. *** Additional =:hline= processing to ob-shell If the argument =:hlines yes= is present in a babel call, an optional argument =:hlines-string= can be used to define a string to use as a representation for the lisp symbol ='hline= in the shell program. The default is =hline=. *** Markdown export supports switches in source blocks For example, it is now possible to number lines using the =-n= switch in a source block. *** New option in ASCII export Plain lists can have an extra margin by setting ~org-ascii-list-margin~ variable to an appropriate integer. *** New blocks in ASCII export ASCII export now supports =#+BEGIN_JUSTIFYRIGHT= and =#+BEGIN_JUSTIFYLEFT= blocks. See documentation for details. *** More back-end specific publishing options The number of publishing options specific to each back-end has been increased. See manual for details. *** Export inline source blocks Inline source code was used to be removed upon exporting. They are now handled as standard code blocks, i.e., the source code can appear in the output, depending on the parameters. *** Extend ~org-export-first-sibling-p~ and ~org-export-last-sibling-p~ These functions now support any element or object, not only headlines. *** New function: ~org-export-table-row-in-header-p~ *** New function: ~org-export-get-reference~ *** New function: ~org-element-lineage~ This function deprecates ~org-export-get-genealogy~. It also provides more features. See docstring for details. *** New function: ~org-element-copy~ *** New filter: ~org-export-filter-body-functions~ Functions in this filter are applied on the body of the exported document, before wrapping it within the template. *** New :environment parameter when exporting example blocks to LaTeX : #+ATTR_LATEX: :environment myverbatim : #+BEGIN_EXAMPLE : This sentence is false. : #+END_EXAMPLE will be exported using =@samp(myverbatim)= instead of =@samp(verbatim)=. *** Various improvements on radio tables Radio tables feature now relies on Org's export framework ("ox.el"). ~:no-escape~ parameter no longer exists, but additional global parameters are now supported: ~:raw~, ~:backend~. Moreover, there are new parameters specific to some pre-defined translators, e.g., ~:environment~ and ~:booktabs~ for ~orgtbl-to-latex~. See translators docstrings (including ~orgtbl-to-generic~) for details. *** Non-floating minted listings in LaTeX export It is not possible to specify =#+attr_latex: :float nil= in conjunction with source blocks exported by the minted package. *** Field formulas can now create columns as needed Previously, evaluating formulas that referenced out-of-bounds columns would throw an error. A new variable ~org-table-formula-create-columns~ was added to adjust this behavior. It is now possible to silently add new columns, to do so with a warning or to explicitly ask the user each time. *** ASCII plot Ability to plot values in a column through ASCII-art bars. See manual for details. *** New hook: ~org-archive-hook~ This hook is called after successfully archiving a subtree, with point on the original subtree, not yet deleted. *** New option: ~org-attach-archive-delete~ When non-nil, attachments from archived subtrees are removed. *** New option: ~org-latex-caption-above~ This variable generalizes ~org-latex-table-caption-above~, which is now deprecated. In addition to tables, it applies to source blocks, special blocks and images. See docstring for more information. *** New option: ~org-latex-prefer-user-labels~ See the docstring for more information. *** Export unnumbered headlines Headlines, for which the property ~UNNUMBERED~ is non-nil, are now exported without section numbers irrespective of their levels. The property is inherited by children. *** Tables can be sorted with an arbitrary function It is now possible to specify a function, both programmatically, through a new optional argument, and interactively with ~f~ or ~F~ keys, to sort a table. *** Table of contents can be local to a section The ~TOC~ keywords now accepts an optional ~local~ parameter. See manual for details. *** Countdown timers can now be paused ~org-timer-pause-time~ now pauses and restarts both relative and countdown timers. *** New option ~only-window~ for ~org-agenda-window-setup~ When ~org-agenda-window-setup~ is set to ~only-window~, the agenda is displayed as the sole window of the current frame. *** ~{{{date}}}~ macro supports optional formatting argument It is now possible to supply and optional formatting argument to ~{{{date}}}~. See manual for details. *** ~{{{property}}}~ macro supports optional search argument It is now possible to supply an optional search option to ~{{{property}}}~ in order to retrieve remote properties optional. See manual for details. *** New option ~org-export-with-title~ It is possible to suppress the title insertion with ~#+OPTIONS: title:nil~ or globally using the variable ~org-export-with-title~. *** New entities family: "\_ " "\_ " are used to insert up to 20 contiguous spaces in various back-ends. In particular, this family can be used to introduce leading spaces within table cells. *** New MathJax configuration options Org uses the MathJax CDN by default. See the manual and the docstring of ~org-html-mathjax-options~ for details. *** New behavior in `org-export-options-alist' When defining a back-end, it is now possible to specify to give `parse' behavior on a keyword. It is equivalent to call `org-element-parse-secondary-string' on the value. However, parsed =KEYWORD= is automatically associated to an =:EXPORT_KEYWORD:= property, which can be used to override the keyword value during a subtree export. Moreover, macros are expanded in such keywords and properties. *** Viewport support in html export Viewport for mobile-optimized website is now automatically inserted when exporting to html. See ~org-html-viewport~ for details. *** New ~#+SUBTITLE~ export keyword Org can typeset a subtitle in some export backends. See the manual for details. *** Remotely edit a footnote definition Calling ~org-edit-footnote-reference~ (C-c ') on a footnote reference allows to edit its definition, as long as it is not anonymous, in a dedicated buffer. It works even if buffer is currently narrowed. *** New function ~org-delete-indentation~ bound to ~M-^~ Work as ~delete-indentation~ unless at heading, in which case text is added to headline text. *** Support for images in Texinfo export ~Texinfo~ back-end now handles images. See the manual for details. *** Support for captions in Texinfo export Tables and source blocks can now have captions. Additionally, lists of tables and lists of listings can be inserted in the document with =#+TOC= keyword. *** Countdown timer support hh:mm:ss format In addition to setting countdown timers in minutes, they can also be set using the hh:mm:ss format. *** Extend ~org-clone-subtree-with-time-shift~ ~org-clone-subtree-with-time-shift~ now accepts 0 as an argument for the number of clones, which removes the repeater from the original subtree and creates one shifted, repeating clone. *** New time block for clock tables: ~untilnow~ It encompasses all past closed clocks. *** Support for the ~polyglossia~ LaTeX package See the docstring of ~org-latex-classes~ and ~org-latex-guess-polyglossia-language~ for details. *** None-floating tables, graphics and blocks can have captions *** `org-insert-heading' can be forced to insert top-level headline ** Removed functions *** Removed function ~org-translate-time~ Use ~org-timestamp-translate~ instead. *** Removed function ~org-beamer-insert-options-template~ This function inserted a Beamer specific template at point or in current subtree. Use ~org-export-insert-default-template~ instead, as it provides more features and covers all export back-ends. It is also accessible from the export dispatcher. *** Removed function ~org-timer-cancel-timer~ ~org-timer-stop~ now stops both relative and countdown timers. *** Removed function ~org-export-solidify-link-text~ This function, being non-bijective, introduced bug in internal references. Use ~org-export-get-reference~ instead. *** Removed function ~org-end-of-meta-data-and-drawers~ The function is superseded by ~org-end-of-meta-data~, called with an optional argument. *** Removed functions ~org-table-colgroup-line-p~, ~org-table-cookie-line-p~ These functions were left-over from pre 8.0 era. They are not correct anymore. Since they are not needed, they have no replacement. ** Removed options *** ~org-list-empty-line-terminates-plain-lists~ is deprecated It will be kept in code base until next release, for backward compatibility. If you need to separate consecutive lists with blank lines, always use two of them, as if this option was nil (default value). *** ~org-export-with-creator~ is a boolean Special ~comment~ value is no longer allowed. It is possible to use a body filter to add comments about the creator at the end of the document instead. *** Removed option =org-html-use-unicode-chars= Setting this to non-nil was problematic as it converted characters everywhere in the buffer, possibly corrupting URLs. *** Removed option =org-babel-sh-command= This undocumented option defaulted to the value of =shell-file-name= at the time of loading =ob-shell=. The new behavior is to use the value of =shell-file-name= directly when the shell language is =shell=. To chose a different shell, either customize =shell-file-name= or bind this variable locally. *** Removed option =org-babel-sh-var-quote-fmt= This undocumented option was supposed to provide different quoting styles when changing the shell type. Changing the shell type can now be done directly from the source block and the quoting style has to be compatible across all shells, so a customization doesn't make sense anymore. The chosen hard coded quoting style conforms to POSIX. *** Removed option ~org-insert-labeled-timestamps-at-point~ Setting this option to anything else that the default value (nil) would create invalid planning info. This dangerous option is now removed. *** Removed option ~org-koma-letter-use-title~ Use org-export-with-title instead. See also below. *** Removed option ~org-entities-ascii-explanatory~ This variable has no effect since Org 8.0. *** Removed option ~org-table-error-on-row-ref-crossing-hline~ This variable has no effect since August 2009. *** Removed MathML-related options from ~org-html-mathjax-options~ MathJax automatically chooses the best display technology based on the end-users browser. You may force initial usage of MathML via ~org-html-mathjax-template~ or by setting the ~path~ property of ~org-html-mathjax-options~. *** Removed comment-related filters ~org-export-filter-comment-functions~ and ~org-export-filter-comment-block-functions~ variables do not exist anymore. ** Miscellaneous *** Strip all meta data from ITEM special property ITEM special property does not contain TODO, priority or tags anymore. *** File names in links accept are now compatible with URI syntax Absolute file names can now start with =///= in addition to =/=. E.g., =[[file:///home/me/unicorn.jpg]]=. *** Footnotes in included files are now local to the file As a consequence, it is possible to include multiple Org files with footnotes in a master document without being concerned about footnote labels colliding. *** Mailto links now use regular URI syntax This change deprecates old Org syntax for mailto links: =mailto:user@domain::Subject=. *** =QUOTE= keywords do not exist anymore =QUOTE= keywords have been deprecated since Org 8.2. *** Select tests to perform with the build system The build system has been enhanced to allow test selection with a regular expression by defining =BTEST_RE= during the test invocation. This is especially useful during bisection to find just when a particular test failure was introduced. *** Exact heading search for external links ignore spaces and cookies Exact heading search for links now ignore spaces and cookies. This is the case for links of the form ~file:projects.org::*task title~, as well as links of the form ~file:projects.org::some words~ when ~org-link-search-must-match-exact-headline~ is not nil. *** ~org-latex-hyperref-template~, ~org-latex-title-command~ formatting New formatting keys are supported. See the respective docstrings. Note, ~org-latex-hyperref-template~ has a new default value. *** ~float, wasysym, marvosym~ are removed from ~org-latex-default-packages-alist~ If you require any of these package add them to your preamble via ~org-latex-packages-alist~. Org also uses default LaTeX ~\tolerance~ now. *** When exporting, throw an error on unresolved id/fuzzy links and code refs This helps spotting wrong links. * Version 8.2 ** Incompatible changes *** =ob-sh.el= renamed to =ob-shell= This may require two changes in user config. 1. In =org-babel-do-load-languages=, change =(sh . t)= to =(shell . t)=. 2. Edit =local.mk= files to change the value of =BTEST_OB_LANGUAGES= to remove "sh" and include "shell". *** Combine org-mac-message.el and org-mac-link-grabber into org-mac-link.el Please remove calls to =(require 'org-mac-message)= and =(require 'org-mac-link-grabber)= in your =.emacs= initialization file. All you need now is =(require 'org-mac-link)=. Additionally, replace any calls to =ogml-grab-link= to =org-mac-grab-link=. For example, replace this line: : (define-key org-mode-map (kbd "C-c g") 'omgl-grab-link) with this: : (define-key org-mode-map (kbd "C-c g") 'org-mac-grab-link) *** HTML export: Replace =HTML_HTML5_FANCY= by =:html-html5-fancy= (...) Some of the HTML specific export options in Org <8.1 are either nil or t, like =#+HTML_INCLUDE_STYLE=. We replaced these binary options with option keywords like :html-include-style. So you need to replace : #+HTML_INCLUDE_STYLE: t by : #+OPTIONS: :html-include-style t Options affected by this change: =HTML5_FANCY=, =HTML_INCLUDE_SCRIPTS= and =HTML_INCLUDE_STYLE=. *** Add an argument to ~org-export-to-file~ and ~org-export-to-buffer~ ~org-export-to-file~ and ~org-export-to-file~ can run in a different process when provided a non-nil =ASYNC= optional argument, without relying on ~org-export-async-start~ macro. Since =ASYNC= is the first of optional arguments, you have to shift the other optional arguments accordingly. *** Export back-ends are now structures Export back-ends are now structures, and stored as such in the communication channel during an export process. In other words, from now on, ~(plist-get info :back-end)~ will return a structure instead of a symbol. Arguments in hooks and in filters are still symbols, though. ** Important bugfixes *** [[doc:org-insert-heading][org-insert-heading]] has been rewritten and bugs are now fixed *** The replacement of disputed keys is now turned of when reading a date *** Match string for sparse trees can now contain a slash in a property value You can now have searches like SOMEPROP="aaa/bbb". Until now, this would break because the slash would be interpreted as the separator starting a TOTO match string. ** New features *** =C-c ^ x= will now sort checklist items by their checked status See [[doc:org-sort-list][org-sort-list]]: hitting =C-c ^ x= will put checked items at the end of the list. *** Various LaTeX export enhancements - Support SVG images - Support for .pgf files - LaTeX Babel blocks can now be exported as =.tikz= files - Allow =latexmk= as an option for [[doc:org-latex-pdf-process][org-latex-pdf-process]] - When using =\usepackage[AUTO]{babel}=, AUTO will automatically be replaced with a value compatible with ~org-export-default-language~ or ~LANGUAGE~ keyword. - The dependency on the =latexsym= LaTeX package has been removed, we now use =amssymb= symbols by default instead. *** New functions for paragraph motion The commands =C-down= and =C-up= now invoke special commands that use knowledge from the org-elements parser to move the cursor in a paragraph-like way. *** New entities in =org-entities.el= Add support for ell, imath, jmath, varphi, varpi, aleph, gimel, beth, dalet, cdots, S (§), dag, ddag, colon, therefore, because, triangleq, leq, geq, lessgtr, lesseqgtr, ll, lll, gg, ggg, prec, preceq, preccurlyeq, succ, succeq, succurlyeq, setminus, nexist(s), mho, check, frown, diamond. Changes loz, vert, checkmark, smile and tilde. *** Anonymous export back-ends ~org-export-create-backend~ can create anonymous export back-ends, which can then be passed to export functions like ~org-export-to-file~, ~org-export-to-buffer~ or ~org-export-as~. It allows for quick translation of Org syntax without the overhead of registering a new back-end. *** New agenda fortnight view The agenda has not, in addition to day, week, month, and year views, also a fortnight view covering 14 days. ** New options *** New option [[doc:org-bookmark-names-plist][org-bookmark-names-plist]] This allows to specify the names of automatic bookmarks. *** New option [[doc:org-agenda-ignore-drawer-properties][org-agenda-ignore-drawer-properties]] This allows more flexibility when optimizing the agenda generation. See https://orgmode.org/worg/agenda-optimization.html for details. *** New option: [[doc:org-html-link-use-abs-url][org-html-link-use-abs-url]] to force using absolute URLs This is an export/publishing option, and should be used either within the =#+OPTIONS= line(s) or within a [[doc:org-publish-project-alist][org-publish-project-alist]]. Setting this option to =t= is needed when the HTML output does not allow relative URLs. For example, the =contrib/lisp/ox-rss.el= library produces a RSS feed, and RSS feeds need to use absolute URLs, so a combination of =:html-link-home "..." and :html-link-use-abs-url t= is required---see the configuration example in the comment section of =ox-rss.el=. *** New option [[doc:org-babel-ditaa-java-cmd][org-babel-ditaa-java-cmd]] This makes java executable configurable for ditaa blocks. *** New options [[doc:org-babel-latex-htlatex][org-babel-latex-htlatex]] and [[doc:org-babel-latex-htlatex-packages][org-babel-latex-htlatex-packages]] This enables SVG generation from latex code blocks. *** New option: [[doc:org-habit-show-done-always-green][org-habit-show-done-always-green]] See [[https://lists.gnu.org/r/emacs-orgmode/2013-05/msg00214.html][this message]] from Max Mikhanosha. *** New option: [[doc:org-babel-inline-result-wrap][org-babel-inline-result-wrap]] If you set this to the following : (setq org-babel-inline-result-wrap "$%s$") then inline code snippets will be wrapped into the formatting string. *** New option: [[doc:org-special-ctrl-o][org-special-ctrl-o]] This variable can be used to turn off the special behavior of =C-o= in tables. ** New contributed packages - =ox-bibtex.el= by Nicolas Goaziou :: an utility to handle BibTeX export to both LaTeX and HTML exports. It uses the [[https://www.lri.fr/~filliatr/bibtex2html/][bibtex2html]] software. - =org-screenshot.el= by Max Mikhanosha :: an utility to handle screenshots easily from Org, using the external tool [[https://freecode.com/projects/scrot][scrot]]. ** Miscellaneous *** "QUOTE" keywords in headlines are deprecated "QUOTE" keywords are an undocumented feature in Org. When a headline starts with the keyword "QUOTE", its contents are parsed as a ~quote-section~ and treated as an example block. You can achieve the same with example blocks. This feature is deprecated and will be removed in the next Org release. * Version 8.0.1 ** Installation Installation instructions have been updated and simplified. If you have troubles installing or updating Org, focus on these instructions: - when updating via a =.zip/.tar.gz= file, you only need to set the =load-path= in your =.emacs=. Set it before any other Org customization that would call autoloaded Org functions. - when updating by pulling Org's Git repository, make sure to create the correct autoloads. You can do this by running =~$ make autoloads= (to only create the autoloads) or by running =~$ make= (to also compile the Emacs lisp files.) =~$ make help= and =~$ make helpall= gives you detailed explanations. - when updating through ELPA (either from GNU ELPA or from Org ELPA), you have to install Org's ELPA package in a session where no Org function has been called already. When in doubt, run =M-x org-version RET= and see if you have a mixed-up installation. See https://orgmode.org/org.html#Installation for details. ** Incompatible changes Org 8.0 is the most disruptive major version of Org. If you configured export options, you will have to update some of them. If you used =#+ATTR_*= keywords, the syntax of the attributes changed and you will have to update them. Below is a list of changes for which you need to take action. See https://orgmode.org/worg/org-8.0.html for the most recent version of this list and for detailed instructions on how to migrate. **** New export engine Org 8.0 comes with a new export engine written by Nicolas Goaziou. This export engine relies on ~org-element.el~ (Org's syntax parser), which was already in Org's core. This new export engine triggered the rewriting of /all/ export back-ends. The most visible change is the export dispatcher, accessible through the keybinding =C-c C-e=. By default, this menu only shows some of the built-in export formats, but you can add more formats by loading them directly (e.g., =(require 'ox-texinfo)= or by configuring the option [[doc:org-export-backends][org-export-backends]]. More contributed back-ends are available from the =contrib/= directory, the corresponding files start with the =ox-= prefix. If you customized an export back-end (like HTML or LaTeX), you will need to rename some options so that your customization is not lost. Typically, an option starting with =org-export-html-= is now named =org-html-=. See the manual for details and check [[https://orgmode.org/worg/org-8.0.html][this Worg page]] for directions. **** New syntax for #+ATTR_HTML/LaTeX/... options : #+ATTR_HTML width="200px" should now be written : #+ATTR_HTML :width 200px Keywords like =#+ATTR_HTML= and =#+ATTR_LaTeX= are defined in their respective back-ends, and the list of supported parameters depends on each backend. See Org's manual for details. **** ~org-remember.el~ has been removed You cannot use =remember.el= anymore to capture notes. Support for remember templates has been obsoleted since long, it is now fully removed. Use =M-x org-capture-import-remember-templates RET= to import your remember templates into capture templates. **** ~org-jsinfo.el~ has been merged into ~ox-html.el~ If you were requiring ~ox-jsinfo.el~ in your ~.emacs.el~ file, you will have to remove this requirement from your initialization file. **** Note for third-party developers The name of the files for export back-end have changed: we now use the prefix =ox-= for those files (like we use the =ob-= prefix for Babel files.) For example ~org-html.el~ is now ~ox-html.el~. If your code relies on these files, please update the names in your code. **** Packages moved from core to contrib Since packages in Org's core are meant to be part of GNU Emacs, we try to be minimalist when it comes to adding files into core. For 8.0, we moved some contributions into the =contrib/= directory. The rationale for deciding that these files should live in =contrib/= is either because they rely on third-party software that is not included in Emacs, or because they are not targeting a significant user-base. - org-colview-xemacs.el - org-mac-message.el - org-mew.el - org-wl.el - ox-freedmind.el - ox-taskjuggler.el Note that ~ox-freedmind.el~ has been rewritten by Jambunathan, ~org-mew.el~ has been enhanced by Tokuya Kameshima and ~ox-taskjuggler.el~ by Nicolas Goaziou and others. Also, the Taskjuggler exporter now uses TJ3 by default. John Hendy wrote [[https://orgmode.org/worg/org-tutorials/org-taskjuggler3.html][a tutorial on Worg]] for the TJ3 export. ** New packages in core *** ~ob-makefile.el~ by Eric Schulte and Thomas S. Dye =ob-makefile.el= implements Org Babel support for Makefile tangling. *** ~ox-man.el~ by Luis Anaya =ox-man.el= allows you to export Org files to =man= pages. *** ~ox-md.el~ by Nicolas Goaziou =ox-md.el= allows you to export Org files to Markdown files, using the vanilla [[https://daringfireball.net/projects/markdown/][Markdown syntax]]. *** ~ox-texinfo.el~ by Jonathan Leech-Pepin =ox-texinfo.el= allows you to export Org files to [[https://www.gnu.org/software/texinfo/][Texinfo]] files. ** New packages in contrib *** ~ob-julia.el~ by G. Jay Kerns [[https://julialang.org/][Julia]] is a new programming language. =ob-julia.el= provides Org Babel support for evaluating Julia source code. *** ~ob-mathomatic.el~ by Luis Anaya [[https://www.mathomatic.org/][mathomatic]] a portable, command-line, educational CAS and calculator software, written entirely in the C programming language. ~ob-mathomatic.el~ provides Org Babel support for evaluating mathomatic entries. *** ~ob-tcl.el~ by Luis Anaya ~ob-tcl.el~ provides Org Babel support for evaluating [[https://www.tcl.tk/][Tcl]] source code. *** ~org-bullets.el~ by Evgeni Sabof Display bullets instead of stars for headlines. Also see [[https://orgmode.org/worg/org-faq.html#sec-8-12][this updated FAQ]] on how to display another character than "*" for starting headlines. *** ~org-favtable.el~ by Marc-Oliver Ihm ~org-favtable.el~ helps you to create and update a table of favorite locations in org, keeping the most frequently visited lines right at the top. This table is called "favtable". See the documentation on [[https://orgmode.org/worg/org-contrib/org-favtable.html][Worg]]. *** ~ox-confluence.el~ by Sébastien Delafond ~ox-confluence.el~ lets you convert Org files to [[https://confluence.atlassian.com/display/DOC/Confluence%2BWiki%2BMarkup][Confluence Wiki]] files. *** ~ox-deck.el~ and ~ox-s5.el~ by Rick Frankel [[http://imakewebthings.com/deck.js/][deck.js]] is a javascript library for displaying HTML ages as presentations. ~ox-deck.el~ exports Org files to HTML presentations using =deck.js=. [[https://meyerweb.com/eric/tools/s5/][s5]] is a set of scripts which also allows to display HTML pages as presentations. ~ox-s5.el~ exports Org files to HTML presentations using =s5=. *** ~ox-groff.el~ by Luis Anaya and Nicolas Goaziou The [[https://www.gnu.org/software/groff/][groff]] (GNU troff) software is a typesetting package which reads plain text mixed with formatting commands and produces formatted output. Luis Anaya and Nicolas Goaziou implemented ~ox-groff.el~ to allow conversion from Org files to groff. *** ~ox-koma-letter.el~ by Nicolas Goaziou and Alan Schmitt This back-end allow to export Org pages to the =KOMA Scrlttr2= format. *** ~ox-rss.el~ by Bastien This back-end lets you export Org pages to RSS 2.0 feeds. Combined with the HTML publishing feature, this allows you to build a blog entirely with Org. ** New features *** Export **** New export generic options If you use Org exporter, we advise you to re-read [[https://orgmode.org/org.html#Exporting][the manual section about it]]. It has been updated and includes new options. Among the new/updated export options, three are of particular importance: - [[doc:org-export-allow-bind-keywords][org-export-allow-bind-keywords]] :: This option replaces the old option =org-export-allow-BIND= and the default value is =nil=, not =confirm=. You will need to explicitly set this to =t= in your initialization file if you want to allow =#+BIND= keywords. - [[doc:org-export-with-planning][org-export-with-planning]] :: This new option controls the export of =SCHEDULED:, DEADLINE:, CLOSED:= lines, and planning information is now skipped by default during export. This use to be the job of [[doc:org-export-with-timestamps][org-export-with-timestamps]], but this latter option has been given a new role: it controls the export of /standalone time-stamps/. When set to =nil=, Org will not export active and inactive time-stamps standing on a line by themselves or within a paragraph that only contains time-stamps. To check if an option has been introduced or its default value changed in Org 8.0, do =C-h v [option] RET= and check if the documentation says that the variable has been introduced (or changed) in version 24.4 of Emacs. **** Enhanced default stylesheet for the HTML exporter See the new default value of [[doc:org-html-style-default][org-html-style-default]]. **** New tags, classes and ids for the HTML exporter See the new default value of [[doc:org-html-divs][org-html-divs]]. **** Support for tikz pictures in LaTeX export **** ~org-man.el~: New export function for "man" links **** ~org-docview.el~: New export function for docview links *** Structure editing **** =C-u C-u M-RET= inserts a heading at the end of the parent subtree **** Cycling to the =CONTENTS= view keeps inline tasks folded [[doc:org-cycle-hook][org-cycle-hook]] as a new function [[doc:org-cycle-hide-inline-tasks][org-cycle-hide-inline-tasks]] which prevents the display of inline tasks when showing the content of a subtree. **** =C-c -= in a region makes a list item for each line This is the opposite of the previous behavior, where =C-c -= on a region would create one item for the whole region, and where =C-u C-c -= would create an item for each line. Now =C-c -= on the selected region creates an item per line, and =C-u C-c -= creates a single item for the whole region. **** When transposing words, markup characters are now part of the words In Emacs, you can transpose words with =M-t=. Transposing =*these* _words__= will preserve markup. **** New command [[doc:org-set-property-and-value][org-set-property-and-value]] bound to =C-c C-x P= This command allows you to quickly add both the property and its value. It is useful in buffers where there are many properties and where =C-c C-x p= can slow down the flow of editing too much. **** New commands [[doc:org-next-block][org-next-block]] and [[doc:org-previous-block][org-previous-block]] These commands allow you to go to the previous block (=C-c M-b= or the speedy key =B=) or to the next block (=C-c M-f= or the speedy key =F=.) **** New commands [[doc:org-drag-line-forward][org-drag-line-forward]] and [[doc:org-drag-line-backward][org-drag-line-backward]] These commands emulate the old behavior of =M-= and =M-= but are now bound to =S-M-= and =S-M-= respectively, since =M-= and =M-= now drag the whole element at point (a paragraph, a table, etc.) forward and backward. **** When a list item has a checkbox, inserting a new item uses a checkbox too **** When sorting entries/items, only the description of links is considered Now Org will sort this list : - [[https://abc.org][B]] : - [[https://def.org][A]] like this: : - [[https://def.org][A]] : - [[https://abc.org][B]] by comparing the descriptions, not the links. Same when sorting headlines instead of list items. **** New option =orgstruct-heading-prefix-regexp= For example, setting this option to "^;;; " in Emacs lisp files and using =orgstruct-mode= in those files will allow you to cycle through visibility states as if lines starting with ";;; *..." where headlines. In general, you want to set =orgstruct-heading-prefix-regexp= as a file local variable. **** New behavior of [[doc:org-clone-subtree-with-time-shift][org-clone-subtree-with-time-shift]] The default is now to ask for a time-shift only when there is a time-stamp. When called with a universal prefix argument =C-u=, it will not ask for a time-shift even if there is a time-stamp. **** New option [[doc:org-agenda-restriction-lock-highlight-subtree][org-agenda-restriction-lock-highlight-subtree]] This defaults to =t= so that the whole subtree is highlighted when you restrict the agenda view to it with =C-c C-x <= (or the speed command =<=). The default setting helps ensuring that you are not adding tasks after the restricted region. If you find this highlighting too intrusive, set this option to =nil=. **** New option [[doc:org-closed-keep-when-no-todo][org-closed-keep-when-no-todo]] When switching back from a =DONE= keyword to a =TODO= keyword, Org now removes the =CLOSED= planning information, if any. It also removes this information when going back to a non-TODO state (e.g., with =C-c C-t SPC=). If you want to keep the =CLOSED= planning information when removing the TODO keyword, set [[doc:org-closed-keep-when-no-todo][org-closed-keep-when-no-todo]] to =t=. **** New option [[doc:org-image-actual-width][org-image-actual-width]] This option allows you to change the width of in-buffer displayed images. The default is to use the actual width of the image, but you can use a fixed value for all images, or fall back on an attribute like : #+attr_html: :width 300px *** Scheduled/deadline **** Implement "delay" cookies for scheduled items If you want to delay the display of a scheduled task in the agenda, you can now use a delay cookie like this: =SCHEDULED: <2004-12-25 Sat -2d>=. The task is still scheduled on the 25th but will appear in your agenda starting from two days later (i.e. from March 27th.) Imagine for example that your co-workers are not done in due time and tell you "we need two more days". In that case, you may want to delay the display of the task in your agenda by two days, but you still want the task to appear as scheduled on March 25th. In case the task contains a repeater, the delay is considered to affect all occurrences; if you want the delay to only affect the first scheduled occurrence of the task, use =--2d= instead. See [[doc:org-scheduled-delay-days][org-scheduled-delay-days]] and [[doc:org-agenda-skip-scheduled-delay-if-deadline][org-agenda-skip-scheduled-delay-if-deadline]] for details on how to control this globally or per agenda. **** Use =C-u C-u C-c C-s= will insert a delay cookie for scheduled tasks See the previous section for why delay cookies may be useful. **** Use =C-u C-u C-c C-d= will insert a warning delay for deadline tasks =C-u C-u C-c C-d= now inserts a warning delay to deadlines. *** Calendar, diary and appts **** New variable [[doc:org-read-date-minibuffer-local-map][org-read-date-minibuffer-local-map]] By default, this new local map uses "." to go to today's date, like in the normal =M-x calendar RET=. If you want to deactivate this and to reassign the "@" key to =calendar-goto-today=, use this: #+BEGIN_SRC emacs-lisp ;; Unbind "." in Org's calendar: (define-key org-read-date-minibuffer-local-map (kbd ".") nil) ;; Bind "@" to `calendar-goto-today': (define-key org-read-date-minibuffer-local-map (kbd "@") (lambda () (interactive) (org-eval-in-calendar '(calendar-goto-today)))) #+END_SRC **** In Org's calendar, =!= displays diary entries of the date at point This is useful when you want to check if you don't already have an appointment when setting new ones with =C-c .= or =C-c s=. =!= will call =diary-view-entries= and display the diary in a separate buffer. **** [[doc:org-diary][org-diary]]: only keep the descriptions of links [[doc:org-diary][org-diary]] returns diary information from Org files, but it returns it in a diary buffer, not in an Org mode buffer. When links are displayed, only show their description, not the full links. *** Agenda **** New agenda type =agenda*= and entry types =:scheduled* :deadline*= When defining agenda custom commands, you can now use =agenda*=: this will list entries that have both a date and a time. This is useful when you want to build a list of appointments. You can also set [[doc:org-agenda-entry-types][org-agenda-entry-types]] either globally or locally in each agenda custom command and use =:timestamp*= and/or =:deadline*= there. Another place where this is useful is your =.diary= file: : %%(org-diary :scheduled*) ~/org/rdv.org This will list only entries from =~/org/rdv.org= that are scheduled with a time value (i.e. appointments). **** New agenda sorting strategies [[doc:org-agenda-sorting-strategy][org-agenda-sorting-strategy]] allows these new sorting strategies: | Strategy | Explanations | |----------------+------------------------------------------| | timestamp-up | Sort by any timestamp, early first | | timestamp-down | Sort by any timestamp, late first | | scheduled-up | Sort by scheduled timestamp, early first | | scheduled-down | Sort by scheduled timestamp, late first | | deadline-up | Sort by deadline timestamp, early first | | deadline-down | Sort by deadline timestamp, late first | | ts-up | Sort by active timestamp, early first | | ts-down | Sort by active timestamp, late first | | tsia-up | Sort by inactive timestamp, early first | | tsia-down | Sort by inactive timestamp, late first | **** New options to limit the number of agenda entries You can now limit the number of entries in an agenda view. This is different from filters: filters only /hide/ the entries in the agenda, while limits are set while generating the list of agenda entries. These new options are available: - [[doc:org-agenda-max-entries][org-agenda-max-entries]] :: limit by number of entries. - [[doc:org-agenda-max-todos][org-agenda-max-todos]] :: limit by number of TODOs. - [[doc:org-agenda-max-tags][org-agenda-max-tags]] :: limit by number of tagged entries. - [[doc:org-agenda-max-effort][org-agenda-max-effort]] :: limit by effort (minutes). For example, if you locally set [[doc:org-agenda-max-todos][org-agenda-max-todos]] to 3 in an agenda view, the agenda will be limited to the first three todos. Other entries without a TODO keyword or beyond the third TODO headline will be ignored. When setting a limit (e.g. about an effort's sum), the default behavior is to exclude entries that cannot be checked against (e.g. entries that have no effort property.) To include other entries too, you can set the limit to a negative number. For example =(setq org-agenda-max-tags -3)= will not show the fourth tagged headline (and beyond), but it will also show non-tagged headlines. **** =~= in agenda view sets temporary limits You can hit =~= in the agenda to temporarily set limits: this will regenerate the agenda as if the limits were set. This is useful for example when you want to only see a list of =N= tasks, or a list of tasks that take only =N= minutes. **** "=" in agenda view filters by regular expressions You can now filter agenda entries by regular expressions using ~=~. =C-u == will filter entries out. Regexp filters are cumulative. You can set [[doc:org-agenda-regexp-filter-preset][org-agenda-regexp-filter-preset]] to suit your needs in each agenda view. **** =|= in agenda view resets all filters Since it's common to combine tag filters, category filters, and now regexp filters, there is a new command =|= to reset all filters at once. **** Allow writing an agenda to an =.org= file You can now write an agenda view to an =.org= file. It copies the headlines and their content (but not subheadings) into the new file. This is useful when you want to quickly share an agenda containing the full list of notes. **** New commands to drag an agenda line forward (=M-=) or backward (=M-=) It sometimes handy to move agenda lines around, just to quickly reorganize your tasks, or maybe before saving the agenda to a file. Now you can use =M-= and =M-= to move the line forward or backward. This does not persist after a refresh of the agenda, and this does not change the =.org= files who contribute to the agenda. **** Use =%b= for displaying "breadcrumbs" in the agenda view [[doc:org-agenda-prefix-format][org-agenda-prefix-format]] now allows to use a =%b= formatter to tell Org to display "breadcrumbs" in the agenda view. This is useful when you want to display the task hierarchy in your agenda. **** Use =%l= for displaying the headline's level in the agenda view [[doc:org-agenda-prefix-format][org-agenda-prefix-format]] allows to use a =%l= formatter to tell Org to display entries with additional spaces corresponding to their level in the outline tree. **** [[doc:org-agenda-write][org-agenda-write]] will ask before overwriting an existing file =M-x org-agenda-write RET= (or =C-c C-w= from an agenda buffer) used to overwrite preexisting file with the same name without confirmation. It now asks for a confirmation. **** New commands =M-m= and =M-*= to toggle (all) mark(s) for bulk action - [[doc:org-agenda-bulk-toggle][org-agenda-bulk-toggle]] :: this command is bound to =M-m= and toggles the mark of the entry at point. - [[doc:org-agenda-bulk-toggle-all][org-agenda-bulk-toggle-all]] :: this command is bound to =M-*= and toggles all the marks in the current agenda. **** New option [[doc:org-agenda-search-view-max-outline-level][org-agenda-search-view-max-outline-level]] This option sets the maximum outline level to display in search view. E.g. when this is set to 1, the search view will only show headlines of level 1. **** New option [[doc:org-agenda-todo-ignore-time-comparison-use-seconds][org-agenda-todo-ignore-time-comparison-use-seconds]] This allows to compare times using seconds instead of days when honoring options like =org-agenda-todo-ignore-*= in the agenda display. **** New option [[doc:org-agenda-entry-text-leaders][org-agenda-entry-text-leaders]] This allows you to get rid of the ">" character that gets added in front of entries excerpts when hitting =E= in the agenda view. **** New formatting string for past deadlines in [[doc:org-agenda-deadline-leaders][org-agenda-deadline-leaders]] The default formatting for past deadlines is ="%2d d. ago: "=, which makes it explicit that the deadline is in the past. You can configure this via [[doc:org-agenda-deadline-leaders][org-agenda-deadline-leaders]]. Note that the width of the formatting string is important to keep the agenda alignment clean. **** New allowed value =repeated-after-deadline= for [[doc:org-agenda-skip-scheduled-if-deadline-is-shown][org-agenda-skip-scheduled-if-deadline-is-shown]] When [[doc:org-agenda-skip-scheduled-if-deadline-is-shown][org-agenda-skip-scheduled-if-deadline-is-shown]] is set to =repeated-after-deadline=, the agenda will skip scheduled items if they are repeated beyond the current deadline. **** New option for [[doc:org-agenda-skip-deadline-prewarning-if-scheduled][org-agenda-skip-deadline-prewarning-if-scheduled]] This variable may be set to nil, t, the symbol `pre-scheduled', or a number which will then give the number of days before the actual deadline when the prewarnings should resume. The symbol `pre-scheduled' eliminates the deadline prewarning only prior to the scheduled date. Read the full docstring for details. **** [[doc:org-class][org-class]] now supports holiday strings in the skip-weeks parameter For example, this task will now be skipped only on new year's day: : * Task : <%%(org-class 2012 1 1 2013 12 12 2 "New Year's Day")> *** Capture **** Allow =C-1= as a prefix for [[doc:org-agenda-capture][org-agenda-capture]] and [[doc:org-capture][org-capture]] With a =C-1= prefix, the capture mechanism will use the =HH:MM= value at point (if any) or the current =HH:MM= time as the default time for the capture template. **** Expand keywords within %(sexp) placeholder in capture templates If you use a =%:keyword= construct within a =%(sexp)= construct, Org will expand the keywords before expanding the =%(sexp)=. **** Allow to contextualize capture (and agenda) commands by checking the name of the buffer [[doc:org-capture-templates-contexts][org-capture-templates-contexts]] and [[doc:org-agenda-custom-commands-contexts][org-agenda-custom-commands-contexts]] allow you to define what capture templates and what agenda commands should be available in various contexts. It is now possible for the context to check against the name of the buffer. *** Tag groups Using =#+TAGS: { Tag1 : Tag2 Tag3 }= will define =Tag1= as a /group tag/ (note the colon after =Tag1=). If you search for =Tag1=, it will return headlines containing either =Tag1=, =Tag2= or =Tag3= (or any combination of those tags.) You can use group tags for sparse tree in an Org buffer, for creating agenda views, and for filtering. See https://orgmode.org/org.html#Tag-groups for details. *** Links **** =C-u C-u M-x org-store-link RET= will ignore non-core link functions Org knows how to store links from Org buffers, from info files and from other Emacs buffers. Org can be taught how to store links from any buffer through new link protocols (see [[https://orgmode.org/org.html#Adding-hyperlink-types]["Adding hyperlink types"]] in the manual.) Sometimes you want Org to ignore added link protocols and store the link as if the protocol was not known. You can now do this with =C-u C-u M-x org-store-link RET=. **** =C-u C-u C-u M-x org-store-link RET= on an active region will store links for each lines Imagine for example that you want to store a link for every message in a Gnus summary buffer. In that case =C-x h C-u C-u C-u M-x org-store-link RET= will store a link for every line (i.e. message) if the region is active. **** =C-c C-M-l= will add a default description for links which don't have one =C-c C-M-l= inserts all stored links. If a link does not have a description, this command now adds a default one, so that we are not mixing with-description and without-description links when inserting them. **** No curly braces to bracket links within internal links When storing a link to a headline like : * See [[https://orgmode.org][Org website]] [[doc:org-store-link][org-store-link]] used to convert the square brackets into curly brackets. It does not anymore, taking the link description or the link path, when there is no description. *** Table **** Switching between #+TBLFM lines If you have several =#+TBLFM= lines below a table, =C-c C-c= on a line will apply the formulas from this line, and =C-c C-c= on another line will apply those other formulas. **** You now use "nan" for empty fields in Calc formulas If empty fields are of interest, it is recommended to reread the section [[https://orgmode.org/org.html#Formula-syntax-for-Calc][3.5.2 Formula syntax for Calc]] of the manual because the description for the mode strings has been clarified and new examples have been added towards the end. **** Handle localized time-stamps in formulas evaluation If your =LOCALE= is set so that Org time-stamps use another language than english, and if you make time computations in Org's table, it now works by internally converting the time-stamps with a temporary =LOCALE=C= before doing computation. **** New lookup functions There are now three lookup functions: - [[doc:org-lookup-first][org-lookup-first]] - [[doc:org-lookup-last][org-lookup-last]] - [[doc:org-lookup-all][org-lookup-all]] See [[https://orgmode.org/org.html#Lookup-functions][the manual]] for details. *** Startup keywords These new startup keywords are now available: | Startup keyword | Option | |----------------------------------+---------------------------------------------| | =#+STARTUP: logdrawer= | =(setq org-log-into-drawer t)= | | =#+STARTUP: nologdrawer= | =(setq org-log-into-drawer nil)= | |----------------------------------+---------------------------------------------| | =#+STARTUP: logstatesreversed= | =(setq org-log-states-order-reversed t)= | | =#+STARTUP: nologstatesreversed= | =(setq org-log-states-order-reversed nil)= | |----------------------------------+---------------------------------------------| | =#+STARTUP: latexpreview= | =(setq org-startup-with-latex-preview t)= | | =#+STARTUP: nolatexpreview= | =(setq org-startup-with-latex-preview nil)= | *** Clocking **** New option [[doc:org-clock-rounding-minutes][org-clock-rounding-minutes]] E.g. if [[doc:org-clock-rounding-minutes][org-clock-rounding-minutes]] is set to 5, time is 14:47 and you clock in: then the clock starts at 14:45. If you clock out within the next 5 minutes, the clock line will be removed; if you clock out 8 minutes after your clocked in, the clock out time will be 14:50. **** New option [[doc:org-time-clocksum-use-effort-durations][org-time-clocksum-use-effort-durations]] When non-nil, =C-c C-x C-d= uses effort durations. E.g., by default, one day is considered to be a 8 hours effort, so a task that has been clocked for 16 hours will be displayed as during 2 days in the clock display or in the clocktable. See [[doc:org-effort-durations][org-effort-durations]] on how to set effort durations and [[doc:org-time-clocksum-format][org-time-clocksum-format]] for more on time clock formats. **** New option [[doc:org-clock-x11idle-program-name][org-clock-x11idle-program-name]] This allows to set the name of the program which prints X11 idle time in milliseconds. The default is to use =x11idle=. **** New option [[doc:org-use-last-clock-out-time-as-effective-time][org-use-last-clock-out-time-as-effective-time]] When non-nil, use the last clock out time for [[doc:org-todo][org-todo]]. Note that this option has precedence over the combined use of [[doc:org-use-effective-time][org-use-effective-time]] and [[doc:org-extend-today-until][org-extend-today-until]]. **** =S-= on a clocksum column will update the sum by updating the last clock **** =C-u 3 C-S-= will update clock timestamps synchronously by 3 units **** New parameter =:wstart= for clocktables to define the week start day **** New parameter =:mstart= to state the starting day of the month **** Allow relative times in clocktable tstart and tend options **** The clocktable summary is now a caption **** =:tstart= and =:tend= and friends allow relative times like "<-1w>" or "" *** Babel **** You can now use =C-c C-k= for [[doc:org-edit-src-abort][org-edit-src-abort]] This allows you to quickly cancel editing a source block. **** =C-u C-u M-x org-babel-tangle RET= tangles by the target file of the block at point This is handy if you want to tangle all source code blocks that have the same target than the block at point. **** New options for auto-saving the base buffer or the source block editing buffer When [[doc:org-edit-src-turn-on-auto-save][org-edit-src-turn-on-auto-save]] is set to =t=, editing a source block in a new window will turn on =auto-save-mode= and save the code in a new file under the same directory than the base Org file. When [[doc:org-edit-src-auto-save-idle-delay][org-edit-src-auto-save-idle-delay]] is set to a number of minutes =N=, the base Org buffer will be saved after this number of minutes of idle time. **** New =:post= header argument post-processes results This header argument may be used to pass the results of the current code block through another code block for post-processing. See the manual for a usage example. **** Commented out heading are ignored when collecting blocks for tangling If you comment out a heading (with =C-c ;= anywhere on the heading or in the subtree), code blocks from within this heading are now ignored when collecting blocks for tangling. **** New option [[doc:org-babel-hash-show-time][org-babel-hash-show-time]] to show a time-stamp in the result hash **** Do not ask for confirmation if cached value is current Do not run [[doc:org-babel-confirm-evaluate][org-babel-confirm-evaluate]] if source block has a cache and the cache value is current as there is no evaluation involved in this case. **** =ob-sql.el= and =ob-python.el= have been improved. **** New Babel files only need to =(require 'ob)= When writing a new Babel file, you now only need to use =(require 'ob)= instead of requiring each Babel library one by one. *** Faces - Org now fontifies radio link targets by default - In the agenda, use [[doc:org-todo-keyword-faces][org-todo-keyword-faces]] to highlight selected TODO keywords - New face [[doc:org-priority][org-priority]], enhanced fontification of priority cookies in agenda - New face [[doc:org-tag-group][org-tag-group]] for group tags ** Miscellaneous - New speedy key =s= pour [[doc:org-narrow-to-subtree][org-narrow-to-subtree]] - Handling of [[doc:org-html-table-row][org-html-table-row]] has been updated (incompatible change) - [[doc:org-export-html-table-tag][org-export-html-table-tag]] is replaced by [[doc:org-html-table-default-attributes][org-html-table-default-attributes]] - Support using =git-annex= with Org attachments - org-protocol: Pass optional value using query in url to capture from protocol - When the refile history is empty, use the current filename as default - When you cannot change the TODO state of a task, Org displays the blocking task - New option [[doc:org-mobile-allpriorities][org-mobile-allpriorities]] - org-bibtex.el now use =visual-line-mode= instead of the deprecated =longlines-mode= - [[doc:org-format-latex-options][org-format-latex-options]] allows to set the foreground/background colors automatically - New option [[doc:org-archive-file-header-format][org-archive-file-header-format]] - New "neg" entity in [[doc:org-entities][org-entities]] - New function [[doc:org-docview-export][org-docview-export]] to export docview links - New =:eps= header argument for ditaa code blocks - New option [[doc:org-gnus-no-server][org-gnus-no-server]] to start Gnus with =gnus-no-server= - Org is now distributed with =htmlize.el= version 1.43 - ~org-drill.el~ has been updated to version 2.3.7 - ~org-mac-iCal.el~ now supports OS X versions up to 10.8 - Various improvements to ~org-contacts.el~ and =orgpan.el= ** Outside Org *** Spanish translation of the Org guide by David Arroyo Menéndez David (and others) translated the Org compact guide in spanish: You can read the [[https://orgmode.org/worg/orgguide/orgguide.es.pdf][PDF guide]]. *** ~poporg.el~ and ~outorg.el~ Two new libraries (~poporg.el~ by François Pinard and ~outorg.el~ by Thorsten Jolitz) now enable editing of comment-sections from source-code buffers in temporary Org-mode buffers, making the full editing power of Org-mode available. ~outorg.el~ comes together with ~outshine.el~ and ~navi-mode.el~, two more libraries by Thorsten Jolitz with the goal to give source-code buffers the /look & feel/ of Org-mode buffers while greatly improving navigation and structure editing. A detailed description can be found here: https://orgmode.org/worg/org-tutorials/org-outside-org.html Here are two screencasts demonstrating Thorsten's tools: - [[https://youtu.be/nqE6YxlY0rw]["Modern conventions for Emacs Lisp files"]] - [[https://www.youtube.com/watch?v%3DII-xYw5VGFM][Exploring Bernt Hansen's Org-mode tutorial with 'navi-mode']] *** MobileOrg for iOS MobileOrg for iOS back in the App Store The 1.6.0 release was focused on the new Dropbox API and minor bug fixes but also includes a new ability to launch in Capture mode. Track development and contribute [[https://github.com/MobileOrg/mobileorg/issues][on github]]. * Version 7.9.3 ** New option [[doc::org-agenda-use-tag-inheritance][org-agenda-use-tag-inheritance]] [[doc::org-use-tag-inheritance][org-use-tag-inheritance]] controls whether tags are inherited when org-tags-view is called (either in =tags=, =tags-tree= or =tags-todo= agenda views.) When generating other agenda types such as =agenda=, =todo= and =todo-tree=, tags inheritance is not used when selecting the entries to display. Still, you might want to have all tag information correct in the agenda buffer, e.g. for tag filtering. In that case, add the agenda type to this variable. Setting this variable to nil should considerably speeds up the agenda generation. Note that the default was to display inherited tags in the agenda lines even if `org-use-tag-inheritance' was nil. The default is now to *never* display inherited tags in agenda lines, but to /know/ about them when the agenda type is listed in [[doc::org-agenda-use-tag-inheritance][org-agenda-use-tag-inheritance]]. ** New default value =nil= for [[doc::org-agenda-dim-blocked-tasks][org-agenda-dim-blocked-tasks]] Using `nil' as the default value speeds up the agenda generation. You can hit `#' (or `C-u #') in agenda buffers to temporarily dim (or turn invisible) blocked tasks. ** New speedy keys for [[doc::org-speed-commands-default][org-speed-commands-default]] You can now use `:' (instead of `;') for setting tags---this is consistent with using the `:' key in agenda view. You can now use `=' for [[doc::org-columns][org-columns]]. ** =org-float= is now obsolete, use =diary-float= instead ** No GPL manual anymore There used to be a GPL version of the Org manual, but this is not the case anymore, the Free Software Foundation does not permit this. The GNU FDL license is now included in the manual directly. ** Enhanced compatibility with Emacs 22 and XEmacs Thanks to Achim for his work on enhancing Org's compatibility with various Emacsen. Things may not be perfect, but Org should work okay in most environments. * Version 7.9.2 ** New ELPA repository for Org packages You can now add the Org ELPA repository like this: #+BEGIN_SRC emacs-lisp (add-to-list 'package-archives '("org" . "https://orgmode.org/elpa/") t) #+END_SRC It contains both the =org-*.tar= package (the core Org distribution, also available through https://elpa.gnu.org) and the =org-plus*.tar= package (the extended Org distribution, with non-GNU packages from the =contrib/= directory.) See https://orgmode.org/elpa/ ** Overview of the new keybindings | Keybinding | Speedy | Command | |-----------------+--------+-----------------------------| | =C-c C-x C-z= | | [[doc::org-clock-resolve][org-clock-resolve]] | | =C-c C-x C-q= | | [[doc::org-clock-cancel][org-clock-cancel]] | | =C-c C-x C-x= | | [[doc::org-clock-in-last][org-clock-in-last]] | | =M-h= | | [[doc::org-mark-element][org-mark-element]] | | =*= | | [[doc::org-agenda-bulk-mark-all][org-agenda-bulk-mark-all]] | | =C-c C-M-l= | | [[doc::org-insert-all-links][org-insert-all-links]] | | =C-c C-x C-M-v= | | [[doc::org-redisplay-inline-images][org-redisplay-inline-images]] | | =C-c C-x E= | =E= | [[doc::org-inc-effort][org-inc-effort]] | | | =#= | [[doc::org-toggle-comment][org-toggle-comment]] | | | =:= | [[doc::org-columns][org-columns]] | | | =W= | Set =APPT_WARNTIME= | | =k= | | [[doc::org-agenda-capture][org-agenda-capture]] | | C-c , | , | [[doc::org-priority][org-priority]] | ** New package and Babel language *** =org-eshell.el= by Konrad Hinsen is now in Org =org-eshell.el= allows you to create links from [[https://www.gnu.org/software/emacs/manual/html_node/eshell/index.html][Eshell]]. *** Support for execution of Scala code blocks (see ob-scala.el) *** Support for execution of IO code blocks (see ob-io.el) ** Incompatible changes - If your code relies on =org-write-agenda=, please use [[doc::org-agenda-write][org-agenda-write]] from now on. - If your code relies on =org-make-link=, please use =concat= instead. - =org-link-to-org-use-id= has been renamed to =org-id-link-to-org-use-id= and its default value is nil. The previous default was =create-if-interactive-and-no-custom-id=. ** New features and user-visible changes *** Org Element =org-element.el= is a toolbox for parsing and analyzing "elements" in an Org-mode buffer. This has been written by Nicolas Goaziou and has been tested for quite some time. It is now part of Org's core and many core functions rely on this package. Two functions might be particularly handy for users: =org-element-at-point= and =org-element-context=. See the docstrings for more details. Below is a list of editing and navigating commands that now rely on =org-element.el=. **** [[doc::org-fill-paragraph][org-fill-paragraph]] has been completely rewritten The filling mechanisms now rely on org-element, trying to do the right thing on each element in various contexts. E.g. filling in a list item will preserve indentation; filling in message-mode will fall back on the relevant filling functions; etc. **** [[doc::org-metaup][org-metaup]] and [[doc::org-metadown][org-metadown]] will drag the element backward/forward If you want to get the old behavior (i.e. moving a line up and down), you can first select the line as an active region, then =org-metaup= or =org-metadown= to move the region backward or forward. This also works with regions bigger than just one line. **** [[doc::org-up-element][org-up-element]] and [[doc::org-down-element][org-down-element]] (respectively =C-c C-^= and =C-c C-_=) This will move the point up/down in the hierarchy of elements. **** [[doc::org-backward-element][org-backward-element]] and [[doc::org-forward-element][org-forward-element]] (respectively =M-{= and =M-}=) This will move the point backward/forward in the hierarchy of elements. **** [[doc::org-narrow-to-element][org-narrow-to-element]] will narrow to the element at point **** [[doc::org-mark-element][org-mark-element]] will mark the element at point This command is bound to =M-h= and will mark the element at point. If the point is at a paragraph, it will mark the paragraph. If the point is at a list item, it will mark the list item. Etc. Note that if point is at the beginning of a list, it will mark the whole list. To mark a subtree, you can either use =M-h= on the headline (since there is no ambiguity about the element you're at) or [[doc::org-mark-subtree][org-mark-subtree]] (=C-c @=) anywhere in the subtree. Invoking [[doc::org-mark-element][org-mark-element]] repeatedly will try to mark the next element on top of the previous one(s). E.g. hitting =M-h= twice on a headline will mark the current subtree and the next one on the same level. *** Org Agenda **** New option [[doc::org-agenda-sticky][org-agenda-sticky]] There is a new option =org-agenda-sticky= which enables "sticky" agendas. Sticky agendas remain opened in the background so that you don't need to regenerate them each time you hit the corresponding keystroke. This is a big time saver. When [[doc::org-agenda-sticky][org-agenda-sticky]] is =non-nil=, the agenda buffer will be named using the agenda key and its description. In sticky agendas, the =q= key will just bury the agenda buffers and further agenda commands will show existing buffer instead of generating new ones. If [[doc::org-agenda-sticky][org-agenda-sticky]] is set to =nil=, =q= will kill the single agenda buffer. **** New option [[doc::org-agenda-custom-commands-contexts][org-agenda-custom-commands-contexts]] Setting this option allows you to define specific context where agenda commands should be available from. For example, when set to this value #+BEGIN_SRC emacs-lisp (setq org-agenda-custom-commands-contexts '(("p" (in-file . "\\.txt")))) #+END_SRC then the =p= agenda command will only be available from buffers visiting *.txt files. See the docstring and the manual for more details on how to use this. **** Changes in bulk actions The set of commands starting with =k ...= as been deleted and the features have been merged into the "bulk action" feature. After you marked some entries in the agenda, if you call =B s=, the agenda entries will be rescheduled using the date at point if on a date header. If you are on an entry with a timestamp, you will be prompted for a date to reschedule your marked entries to, using the timestamp at point as the default prompt. You can now use =k= to capture the marked entry and use the date at point as an overriding date for the capture template. To bind this behavior to =M-x org-capture RET= (or its keybinding), set the new option [[doc::org-capture-use-agenda-date][org-capture-use-agenda-date]] to =t=. **** =N= and =P= in the agenda will move to the next/previous item **** New command [[doc::org-agenda-bulk-mark-all][org-agenda-bulk-mark-all]] to mark all items This new command is bound to =*= in agenda mode. There is also a new option [[doc::org-agenda-bulk-mark-char][org-agenda-bulk-mark-char]] to set the character to use as a mark for bulk actions. **** New option [[doc::org-agenda-persistent-marks][org-agenda-persistent-marks]] When set to =non-nil=, marks will remain visible after a bulk action. You can temporarily toggle this by pressing =p= when invoking [[doc::org-agenda-bulk-action][org-agenda-bulk-action]]. Marks are deleted if your rebuild the agenda buffer or move to another date/span (e.g. with =f= or =w=). **** New option [[doc::org-agenda-skip-timestamp-if-deadline-is-shown][org-agenda-skip-timestamp-if-deadline-is-shown]] =Non-nil= means skip timestamp line if same entry shows because of deadline. In the agenda of today, an entry can show up multiple times because it has both a plain timestamp and has a nearby deadline. When this variable is t, then only the deadline is shown and the fact that the entry has a timestamp for or including today is not shown. When this variable is =nil=, the entry will be shown several times. **** New =todo-unblocked= and =nottodo-unblocked= skip conditions See the [[https://orgmode.org/cgit.cgi/org-mode.git/commit/?id=f426da][git commit]] for more explanations. **** Allow category filtering in the agenda You can now filter the agenda by category. Pressing "<" will filter by the category of the item on the current line, and pressing "<" again will remove the filter. You can combine tag filters and category filters. You can use =org-agenda-category-filter= in your custom agenda views and =org-agenda-category-filter-preset= in your main configuration. See also the new command [[doc::org-agenda-filter-by-top-category][org-agenda-filter-by-top-category]]: hitting =^= will filter by "Top" category: only show entries that are of the same category than the Top category of the entry at point. *** Org Links **** Inserting links When inserting links through [[doc::org-insert-link][org-insert-link]], the description is now displayed first, followed by the literal link, as the description is often more useful when you look for the link you want to insert. Completion now complete both literal links and description. If you complete a description, the literal link and its description will be inserted directly, whereas when you complete the literal link, you will be prompted for a description (as with Org 7.8.) In the completion buffer, links to the current buffer are now highlighted. **** New templates =%h= and =%(sexp)= for abbreviated links On top of =%s= template, which is replaced by the link tag in abbreviated links, you can now use =%h= (which does the same than =%s= but does not hexify the tag) and =%(sexp)= (which can run a function that takes the tag as its own argument.) **** New link type =help= You can now create links from =help= buffers. For example, if you request help for the command [[doc::org-agenda][org-agenda]] with =C-h f org-agenda RET=, creating a link from this buffer will let you go back to the same buffer. **** New command [[doc::org-insert-all-links][org-insert-all-links]] This will insert all links as list items. With a universal prefix argument, links will not be deleted from the variable =org-stored-links=. This new command is bound to =C-c C-M-l=. **** New option [[doc::org-url-hexify-p][org-url-hexify-p]] When set to =nil=, the =URL= part of a link will not be hexified. **** Org can now open multiple shell links **** New option [[doc::org-doi-server-url][org-doi-server-url]] to specify an alternate DOI server **** RET now follows time stamps links *** Org Editing **** [[doc::org-todo][org-todo]] and =org-archive-*= can now loop in the active region When [[doc::org-loop-over-headlines-in-active-region][org-loop-over-headlines-in-active-region]] is =non-nil=, using [[doc::org-todo][org-todo]] or =org-archive-*= commands in the active region will loop over headlines. This is handy if you want to set the TODO keyword for several items, or archive them quickly. **** You can now set tags for headlines in a region If [[doc::org-loop-over-headlines-in-active-region][org-loop-over-headlines-in-active-region]] is =non-nil=, then selecting the region and hitting =C-c C-q= will set the tags for all headlines in the region. **** New command [[doc::org-insert-drawer][org-insert-drawer]] to insert a drawer interactively **** Comments start with "^[ \t]*# " anywhere on a line Note that the space after the hashtag is mandatory. Comments with "^#+" are not supported anymore. **** New speed key =#= to toggle the COMMENT cookie on a headline **** =indent-region-function= is now set to [[doc::org-indent-region][org-indent-region]] =C-M-\= should now produce useful results. You can unindent the buffer with [[doc::org-unindent-buffer][org-unindent-buffer]]. **** New option [[doc::org-allow-promoting-top-level-subtree][org-allow-promoting-top-level-subtree]] When =non-nil=, =S-M-= will promote level-1 subtrees containing other subtrees. The level-1 headline will be commented out. You can revert to the previous state with =M-x undo RET=. *** Org Clock **** New keybinding =C-c C-x C-z= for [[doc::org-clock-resolve][org-clock-resolve]] **** New keybinding =C-c C-x C-q= for [[doc::org-clock-cancel][org-clock-cancel]] **** New command [[doc::org-clock-in-last][org-clock-in-last]] to clock in the last clocked item This command is bound to =C-c C-x C-x= and will clock in the last clocked entry, if any. **** =C-u M-x= [[doc::org-clock-out][org-clock-out]] =RET= now prompts for a state to switch to **** =S-M-= on a clock timestamps adjusts the previous/next clock **** New option [[doc::org-clock-continuously][org-clock-continuously]] When set to =nil=, clocking in a task will first try to find the last clocked out task and restart from when that task was clocked out. You can temporarily activate continuous clocking with =C-u C-u C-u M-x= [[doc::org-clock-in][org-clock-in]] =RET= (three universal prefix arguments) and =C-u C-u M-x= [[doc::org-clock-in-last][org-clock-in-last]] =RET= (two universal prefix arguments). **** New option [[doc::org-clock-frame-title-format][org-clock-frame-title-format]] This option sets the value of =frame-title-format= when clocking in. **** New options for controlling the clockreport display [[doc::org-clock-file-time-cell-format][org-clock-file-time-cell-format]]: Format string for the file time cells in clockreport. [[doc::org-clock-total-time-cell-format][org-clock-total-time-cell-format]]: Format string for the total time cells in clockreport. **** New options for controlling the clock/timer display [[doc::org-clock-clocked-in-display][org-clock-clocked-in-display]]: control whether the current clock is displayed in the mode line and/or frame title. [[doc::org-timer-display][org-timer-display]]: control whether the current timer is displayed in the mode line and/or frame title. This allows the clock and timer to be displayed in the frame title instead of, or as well as, the mode line. This is useful for people with limited space in the mode line but with ample space in the frame title. *** Org Appearance **** New option [[doc::org-custom-properties][org-custom-properties]] The visibility of properties listed in this options can be turn on/off with [[doc::org-toggle-custom-properties-visibility][org-toggle-custom-properties-visibility]]. This might be useful for properties used by third-part tools or that you don't want to see temporarily. **** New command [[doc::org-redisplay-inline-images][org-redisplay-inline-images]] This will redisplay all images. It is bound to =C-c C-x C-M-v=. **** New entities in =org-entities.el= There are these new entities: : ("tilde" "\\~{}" nil "˜" "~" "~" "~") : ("slash" "/" nil "/" "/" "/" "/") : ("plus" "+" nil "+" "+" "+" "+") : ("under" "\\_" nil "_" "_" "_" "_") : ("equal" "=" nil "=" "=" "=" "=") : ("asciicirc" "\\textasciicircum{}" nil "^" "^" "^" "^") **** New face =org-list-dt= for definition terms **** New face =org-date-selected= for the selected calendar day **** New face value for =org-document-title= The face is back to a normal height. *** Org Columns **** New speed command =:= to activate the column view **** New special property =CLOCKSUM_T= to display today's clocked time You can use =CLOCKSUM_T= the same way you use =CLOCKSUM=. It will display the time spent on tasks for today only. **** Use the =:COLUMNS:= property in columnview dynamic blocks If the =:COLUMNS:= is set in a subtree, the columnview dynamic block will use its value as the column format. **** Consider inline tasks when computing a sum *** Org Dates and Time Stamps **** Enhanced [[doc::org-sparse-tree][org-sparse-tree]] =C-c /= can now check for time ranges. When checking for dates with =C-c /= it is useful to change the type of dates that you are interested in. You can now do this interactively with =c= after =C-c /= and/or by setting [[doc::org-sparse-tree-default-date-type][org-sparse-tree-default-date-type]] to the default value you want. **** Support for hourly repeat cookies You can now use : SCHEDULED: <2012-08-20 lun. 08:00 +1h> if you want to add an hourly repeater to an entry. **** =C-u C-u C-c .= inserts a time-stamp with no prompt **** When (setq [[doc::org-read-date-prefer-future][org-read-date-prefer-future]] 'time), accept days in the prompt "8am Wed" and "Wed 8am" are now acceptable values when entering a date from the prompt. If [[doc::org-read-date-prefer-future][org-read-date-prefer-future]] is set to =time=, this will produce the expected prompt indication. **** New option [[doc::org-datetree-add-timestamp][org-datetree-add-timestamp]] When set to =non-nil=, datetree entries will also have a timestamp. This is useful if you want to see these entries in a sparse tree with =C-c /=. *** Org Capture **** New command [[doc::org-capture-string][org-capture-string]] M-x [[doc::org-capture-string][org-capture-string]] RET will prompt for a string and a capture template. The string will be used as an annotation for the template. This is useful when capturing in batch mode as it lets you define the content of the template without being in Emacs. **** New option [[doc::org-capture-templates-contexts][org-capture-templates-contexts]] Setting this option allows you to define specific context where capture templates should be available from. For example, when set to this value #+BEGIN_SRC emacs-lisp (setq org-capture-templates-contexts '(("c" (in-mode . "message-mode")))) #+END_SRC then the =c= capture template will only be available from =message-mode= buffers. See the docstring and the manual for more details on how to use this. **** New =%l= template to insert the literal link **** New option [[doc::org-capture-bookmark][org-capture-bookmark]] Org used to automatically add a bookmark with capture a note. You can now turn this on by setting [[doc::org-capture-bookmark][org-capture-bookmark]] to =nil=. **** Expand =%= escape sequences into text entered for 'th =%^{PROMPT}= escape See the manual for more explanations. **** More control over empty lines You can use =:empty-lines-before= and =:empty-lines-after= to control the insertion of empty lines. Check the manual for more explanations. **** New hook [[doc::org-capture-prepare-finalize-hook][org-capture-prepare-finalize-hook]] This new hook runs before the finalization process starts. *** Org Export **** New functions =orgtbl-to-table.el= and =orgtbl-to-unicode= =orgtbl-to-table.el= convert the table to a =table.el= table, and =orgtbl-to-unicode= will use =ascii-art-to-unicode.el= (when available) to print beautiful tables. **** [[doc::org-table-export][org-table-export]] now a bit clever about the target format When you specify a file name like =table.csv=, [[doc::org-table-export][org-table-export]] will now suggest =orgtbl-to-csv= the default method for exporting the table. **** New option [[doc::org-export-date-timestamp-format][org-export-date-timestamp-format]] The option allows to set a time string format for Org timestamps in the #+DATE option. **** LaTeX: New options for exporting table rules :tstart, :hline and :tend See [[doc::org-export-latex-tables-hline][org-export-latex-tables-hline]] and [[doc::org-export-latex-tables-tend][org-export-latex-tables-tend]]. **** LaTeX: You can now set =:hfmt= from =#+ATTR_LaTeX= **** Beamer: Add support and keybinding for the =exampleblock= environment Add support for these languages in [[doc::org-export-language-setup][org-export-language-setup]]. More languages are always welcome. **** Beamer: New option [[doc::org-beamer-inherited-properties][org-beamer-inherited-properties]] This option allows Beamer export to inherit some properties. Thanks to Carsten for implementing this. **** ODT: Add support for ODT export in org-bbdb.el **** ODT: Add support for indented tables (see [[https://orgmode.org/cgit.cgi/org-mode.git/commit/?id=e9fd33][this commit]] for details) **** ODT: Improve the conversion from ODT to other formats **** ASCII: Swap the level-1/level-2 characters to underline the headlines **** Support for Chinese, simplified Chinese, Russian, Ukrainian and Japanese **** HTML: New option [[doc::org-export-html-date-format-string][org-export-html-date-format-string]] Format string to format the date and time in HTML export. Thanks to Sébastien Vauban for this patch. *** Org Babel **** New =:results drawer= parameter =:results drawer= replaces =:results wrap=, which is deprecated but still supported. **** =:results org= now put results in a =#+BEGIN_SRC org= block =:results org= used to put results in a =#+BEGIN_ORG= block but it now puts results in a =#+BEGIN_SRC org= block, with comma-escaped lines. =#+BEGIN_ORG= blocks are obsolete. **** Exporting =#+BEGIN_SRC org= blocks exports the code It used to exports the results of the code. *** Miscellaneous **** New menu entry for [[doc::org-refile][org-refile]] **** Allow capturing to encrypted entries If you capture to an encrypted entry, it will be decrypted before inserting the template then re-encrypted after finalizing the capture. **** Inactive timestamps are now handled in tables Calc can do computation on active time-stamps like <2012-09-29 sat.>. Inactive time-stamps in a table's cell are now internally deactivated so that Calc formulas can operate on them. **** [[doc::org-table-number-regexp][org-table-number-regexp]] can now accept comma as decimal mark **** Org allows a new property =APPT_WARNTIME= You can set it with the =W= speedy key or set it manually. When set, exporting to iCalendar and [[doc::org-agenda-to-appt][org-agenda-to-appt]] will use the value of this property as the number of minutes for the warning alarm. **** New command [[doc::org-inc-effort][org-inc-effort]] This will increment the effort value. It is bound to =C-c C-x E= and to =E= as a speedy command. **** Attach: Add support for creating symbolic links =org-attach-method= now supports a new method =lns=, allowing to attach symbolic links. **** Archive: you can now archive to a datetree **** New option [[doc::org-inlinetask-show-first-star][org-inlinetask-show-first-star]] =Non-nil= means display the first star of an inline task as additional marker. When =nil=, the first star is not shown. **** New option [[doc::org-latex-preview-ltxpng-directory][org-latex-preview-ltxpng-directory]] This lets you define the path for the =ltxpng/= directory. **** You can now use imagemagick instead of dvipng to preview LaTeX fragments **** You can now turn off [[doc::orgstruct++-mode][orgstruct++-mode]] safely **** =C-u C-c C-c= on list items to add check boxes =C-u C-c C-c= will add an empty check box on a list item. When hit from the top of the list, it will add check boxes for all top level list items. **** =org-list-ending-method= and =org-list-end-regexp= are now obsolete Fall back on using =org-list-end-re= only, which see. **** org-feed.el now expands =%(sexp)= templates **** New option [[doc::org-protocol-data-separator][org-protocol-data-separator]] **** New option [[doc::org-ditaa-jar-option][org-ditaa-jar-option]] to specify the ditaa jar file **** New possible value for [[doc::org-loop-over-headlines-in-active-region][org-loop-over-headlines-in-active-region]] When [[doc::org-loop-over-headlines-in-active-region][org-loop-over-headlines-in-active-region]] is set to =start-level=, the command will loop over the active region but will only act upon entries that are of the same level than the first headline in the region. **** New option [[doc::org-habit-show-all-today][org-habit-show-all-today]] When set to =t=, show all (even unscheduled) habits on today's agenda. ** Important bug fixes *** M-TAB on options keywords perform completion correctly again If you hit =M-TAB= on keywords like =#+TITLE=, Org will try to perform completion with meaningful values. *** Add licenses to javascript embedded and external code snippets Embedded javascript code produced when exporting an Org file to HTML is now licensed under GPLv3 (or later), and the copyright is owned by the Free Software Foundation, Inc. The javascript code for embedding MathJax in the browser mentions the MathJax copyright and the Apache 2.0 license. The javascript code for embedding =org-injo.js= in the browser mentions the copyright of Sebastian Rose and the GPLv3 (or later) license. =org-export-html-scripts= is now a variable, so that you can adapt the code and the license to your needs. See https://www.gnu.org/philosophy/javascript-trap.html for explanations on why these changes were necessary. * Version 7.8.11 ** Incompatible changes *** Emacs 21 support has been dropped Do not use Org mode 7.xx with Emacs 21, use [[https://orgmode.org/org-6.36c.zip][version 6.36c]] instead. *** XEmacs support requires the XEmacs development version To use Org mode 7.xx with XEmacs, you need to run the developer version of XEmacs. We were about to drop XEmacs support entirely, but Michael Sperber stepped in and made changes to XEmacs that made it easier to keep the support. Thanks to Michael for this last-minute save. *** New keys for TODO sparse trees The key =C-c C-v= is now reserved for Org Babel action. TODO sparse trees can still be made with =C-c / t= (all not-done states) and =C-c / T= (specific states). *** The Agenda =org-agenda-ndays= is now obsolete The variable =org-agenda-ndays= is obsolete - please use =org-agenda-span= instead. Thanks to Julien Danjou for this. *** Changes to the intended use of =org-export-latex-classes= So far this variable has been used to specify the complete header of the LaTeX document, including all the =\usepackage= calls necessary for the document. This setup makes it difficult to maintain the list of packages that Org itself would like to call, for example for the special symbol support it needs. First of all, you can *opt out of this change* in the following way: You can say: /I want to have full control over headers, and I will take responsibility to include the packages Org needs/. If that is what you want, add this to your configuration and skip the rest of this section (except maybe for the description of the =[EXTRA]= place holder): #+begin_src emacs-lisp (setq org-export-latex-default-packages-alist nil org-export-latex-packages-alist nil) #+end_src /Continue to read here if you want to go along with the modified setup./ There are now two variables that should be used to list the LaTeX packages that need to be included in all classes. The header definition in =org-export-latex-classes= should then not contain the corresponding =\usepackage= calls (see below). The two new variables are: 1. =org-export-latex-default-packages-alist= :: This is the variable where Org-mode itself puts the packages it needs. Normally you should not change this variable. The only reason to change it anyway is when one of these packages causes a conflict with another package you want to use. Then you can remove that packages and hope that you are not using Org-mode functionality that needs it. 2. =org-export-latex-packages-alist= :: This is the variable where you can put the packages that you'd like to use across all classes. The sequence how these customizations will show up in the LaTeX document are: 1. Header from =org-export-latex-classes= 2. =org-export-latex-default-packages-alist= 3. =org-export-latex-packages-alist= 4. Buffer-specific things set with =#+LaTeX_HEADER:= If you want more control about which segment is placed where, or if you want, for a specific class, have full control over the header and exclude some of the automatic building blocks, you can put the following macro-like place holders into the header: #+begin_example [DEFAULT-PACKAGES] \usepackage statements for default packages [NO-DEFAULT-PACKAGES] do not include any of the default packages [PACKAGES] \usepackage statements for packages [NO-PACKAGES] do not include the packages [EXTRA] the stuff from #+LaTeX_HEADER [NO-EXTRA] do not include #+LaTeX_HEADER stuff #+end_example If you have currently customized =org-export-latex-classes=, you should revise that customization and remove any package calls that are covered by =org-export-latex-default-packages-alist=. This applies to the following packages: - inputenc - fontenc - fixltx2e - graphicx - longtable - float - wrapfig - soul - t1enc - textcomp - marvosym - wasysym - latexsym - amssymb - hyperref If one of these packages creates a conflict with another package you are using, you can remove it from =org-export-latex-default-packages-alist=. But then you risk that some of the advertised export features of Org will not work properly. You can also consider moving packages that you use in all classes to =org-export-latex-packages-alist=. If necessary, put the place holders so that the packages get loaded in the right sequence. As said above, for backward compatibility, if you omit the place holders, all the variables will dump their content at the end of the header. *** The constant =org-html-entities= is obsolete Its content is now part of the new constant =org-entities=, which is defined in the file org-entities.el. =org-html-entities= was an internal variable, but it is possible that some users did write code using it. *** =org-bbdb-anniversary-format-alist= has changed Please check the docstring and update your settings accordingly. *** Deleted =org-mode-p= This function has been deleted: please update your code. ** Important new features *** New Org to ODT exporter Jambunathan's Org to ODT exporter is now part of Org. To use it, it `C-c C-e o' in an Org file. See the documentation for more information on how to customize it. *** org-capture.el is now the default capture system This replaces the earlier system org-remember. The manual only describes org-capture, but for people who prefer to continue to use org-remember, we keep a static copy of the former manual section [[https://orgmode.org/org-remember.pdf][chapter about remember]]. The new system has a technically cleaner implementation and more possibilities for capturing different types of data. See [[msg:C46F10DC-DE51-43D4-AFFE-F71E440D1E1F@gmail.com][Carsten's announcement]] for more details. To switch over to the new system: 1. Run : M-x org-capture-import-remember-templates RET to get a translated version of your remember templates into the new variable =org-capture-templates=. This will "mostly" work, but maybe not for all cases. At least it will give you a good place to modify your templates. After running this command, enter the customize buffer for this variable with : M-x customize-variable RET org-capture-templates RET and convince yourself that everything is OK. Then save the customization. 2. Bind the command =org-capture= to a key, similar to what you did with org-remember: : (define-key global-map "\C-cc" 'org-capture) If your fingers prefer =C-c r=, you can also use this key once you have decided to move over completely to the new implementation. During a test time, there is nothing wrong with using both system in parallel. ** New libraries *** New Org libraries **** org-eshell.el (Konrad Hinsen) Implement links to eshell buffers. **** org-special-blocks (Carsten Dominik) This package generalizes the #+begin_foo and #+end_foo tokens. To use, put the following in your init file: #+BEGIN_EXAMPLE (require 'org-special-blocks) #+END_EXAMPLE The tokens #+begin_center, #+begin_verse, etc. existed previously. This package generalizes them (at least for the LaTeX and html exporters). When a #+begin_foo token is encountered by the LaTeX exporter, it is expanded into \begin{foo}. The text inside the environment is not protected, as text inside environments generally is. When #+begin_foo is encountered by the html exporter, a div with class foo is inserted into the HTML file. It is up to the user to add this class to his or her stylesheet if this div is to mean anything. **** org-taskjuggler.el (Christian Egli) Christian Egli's /org-taskjuggler.el/ module is now part of Org. He also wrote a [[https://orgmode.org/worg/org-tutorials/org-taskjuggler.php][tutorial]] for it. **** org-ctags.el (Paul Sexton) Targets like =<>= can now be found by Emacs's etag functionality, and Org-mode links can be used to link to etags, also in non-Org-mode files. For details, see the file /org-ctags.el/. This feature uses a new hook =org-open-link-functions= which will call function to do something special with text links. Thanks to Paul Sexton for this contribution. **** org-docview.el (Jan Böcker) This new module allows links to various file types using docview, where Emacs displays images of document pages. Docview link types can point to a specific page in a document, for example to page 131 of the Org-mode manual: : [[docview:~/.elisp/org/doc/org.pdf::131][Org-Mode Manual]] Thanks to Jan Böcker for this contribution. *** New Babel libraries - ob-picolisp.el (Thorsten Jolitz) - ob-fortran.el (Sergey Litvinov) - ob-shen.el (Eric Schulte) - ob-maxima.el (Eric S Fraga) - ob-java.el (Eric Schulte) - ob-lilypond.el (Martyn Jago) - ob-awk.el (Eric Schulte) ** Other new features and various enhancements *** Hyperlinks **** Org-BibTeX -- major improvements Provides support for managing bibtex bibliographical references data in headline properties. Each headline corresponds to a single reference and the relevant bibliographic meta-data is stored in headline properties, leaving the body of the headline free to hold notes and comments. Org-bibtex is aware of all standard bibtex reference types and fields. The key new functions are - org-bibtex-check :: queries the user to flesh out all required (and with prefix argument optional) bibtex fields available for the specific reference =type= of the current headline. - org-bibtex-create :: Create a new entry at the given level, using org-bibtex-check to flesh out the relevant fields. - org-bibtex-yank :: Yank a bibtex entry on the kill ring as a formatted Org-mode headline into the current buffer - org-bibtex-export-to-kill-ring :: Export the current headline to the kill ring as a formatted bibtex entry. **** org-gnus.el now allows link creation from messages You can now create links from messages. This is particularly useful when the user wants to stored messages that he sends, for later check. Thanks to Ulf Stegemann for the patch. **** Modified link escaping David Maus worked on `org-link-escape'. See [[msg:87k4gysacq.wl%dmaus@ictsoc.de][his message]]: : Percent escaping is used in Org mode to escape certain characters : in links that would either break the parser (e.g. square brackets : in link target or description) or are not allowed to appear in : a particular link type (e.g. non-ascii characters in a http: : link). : : With this change in place Org will apply percent escaping and : unescaping more consistently especially for non-ascii characters. : Additionally some of the outstanding bugs or glitches concerning : percent escaped links are solved. Thanks a lot to David for this work. **** Make =org-store-link= point to directory in a dired buffer When, in a dired buffer, the cursor is not in a line listing a file, `org-store-link' will store a link to the directory. Patch by Stephen Eglen. **** Allow regexps in =org-file-apps= to capture link parameters The way extension regexps in =org-file-apps= are handled has changed. Instead of matching against the file name, the regexps are now matched against the whole link, and you can use grouping to extract link parameters which you can then use in a command string to be executed. For example, to allow linking to PDF files using the syntax =file:/doc.pdf::=, you can add the following entry to org-file-apps: #+begin_example Extension: \.pdf::\([0-9]+\)\' Command: evince "%s" -p %1 #+end_example Thanks to Jan Böcker for a patch to this effect. *** Dates and time **** Allow relative time when scheduling/adding a deadline You can now use relative duration strings like "-2d" or "++3w" when calling =org-schedule= or =org-deadline=: it will schedule (or set the deadline for) the item respectively two days before today and three weeks after the current timestamp, if any. You can use this programmatically: =(org-schedule nil "+2d")= will work on the current entry. You can also use this while (bulk-)rescheduling and (bulk-)resetting the deadline of (several) items from the agenda. Thanks to Memnon Anon for a heads up about this! **** American-style dates are now understood by =org-read-date= So when you are prompted for a date, you can now answer like this #+begin_example 2/5/3 --> 2003-02-05 2/5 --> -02-05 #+end_example *** Agenda **** =org-agenda-custom-commands= has a default value This option used to be `nil' by default. This now has a default value, displaying an agenda and all TODOs. See the docstring for details. Thanks to Carsten for this. **** Improved filtering through =org-agenda-to-appt= The new function allows the user to refine the scope of entries to pass to =org-agenda-get-day-entries= and allows to filter out entries using a function. Thanks to Peter Münster for raising a related issue and to Tassilo Horn for this idea. Also thanks to Peter Münster for [[git:68ffb7a7][fixing a small bug]] in the final implementation. **** Allow ap/pm times in agenda time grid Times in the agenda can now be displayed in am/pm format. See the new variable =org-agenda-timegrid-use-ampm=. Thanks to C. A. Webber for a patch to this effect. **** Agenda: Added a bulk "scattering" command =B S= in the agenda buffer will cause tasks to be rescheduled a random number of days into the future, with 7 as the default. This is useful if you've got a ton of tasks scheduled for today, you realize you'll never deal with them all, and you just want them to be distributed across the next N days. When called with a prefix arg, rescheduling will avoid weekend days. Thanks to John Wiegley for this. *** Exporting **** Simplification of org-export-html-preamble/postamble When set to `t', export the preamble/postamble as usual, honoring the =org-export-email/author/creator-info= variables. When set to a formatting string, insert this string. See the docstring of these variable for details about available %-sequences. You can set =:html-preamble= in publishing project in the same way: `t' means to honor =:email/creator/author-info=, and a formatting string will insert a string. **** New exporters to Latin-1 and UTF-8 While Ulf Stegemann was going through the entities list to improve the LaTeX export, he had the great idea to provide representations for many of the entities in Latin-1, and for all of them in UTF-8. This means that we can now export files rich in special symbols to Latin-1 and to UTF-8 files. These new exporters can be reached with the commands =C-c C-e n= and =C-c C-e u=, respectively. When there is no representation for a given symbol in the targeted coding system, you can choose to keep the TeX-macro-like representation, or to get an "explanatory" representation. For example, =\simeq= could be represented as "[approx. equal to]". Please use the variable =org-entities-ascii-explanatory= to state your preference. **** HTML export: Add class to outline containers using property The =HTML_CONTAINER_CLASS= property can now be used to add a class name to the outline container of a node in HTML export. **** Throw an error when creating an image from a LaTeX snippet fails This behavior can be configured with the new option variable =org-format-latex-signal-error=. **** Support for creating BEAMER presentations from Org-mode documents Org-mode documents or subtrees can now be converted directly in to BEAMER presentation. Turning a tree into a simple presentations is straight forward, and there is also quite some support to make richer presentations as well. See the [[https://orgmode.org/manual/Beamer-class-export.html#Beamer-class-export][BEAMER section]] in the manual for more details. Thanks to everyone who has contributed to the discussion about BEAMER support and how it should work. This was a great example for how this community can achieve a much better result than any individual could. *** Refiling **** Refile targets can now be cached You can turn on caching of refile targets by setting the variable =org-refile-use-cache=. This should speed up refiling if you have many eligible targets in many files. If you need to update the cache because Org misses a newly created entry or still offers a deleted one, press =C-0 C-c C-w=. **** New logging support for refiling Whenever you refile an item, a time stamp and even a note can be added to this entry. For details, see the new option =org-log-refile=. Thanks to Charles Cave for this idea. *** Completion **** In-buffer completion is now done using John Wiegley's pcomplete.el Thanks to John Wiegley for much of this code. *** Tables **** New command =org-table-transpose-table-at-point= See the docstring. This hack from Juan Pechiar is now part of Org's core. Thanks to Juan! **** Display field's coordinates when editing it with =C-c `= When editing a field with =C-c `=, the field's coordinate will the displayed in the buffer. Thanks to Michael Brand for a patch to this effect. **** Spreadsheet computation of durations and time values If you want to compute time values use the =T= flag, either in Calc formulas or Elisp formulas: | Task 1 | Task 2 | Total | |--------+--------+---------| | 35:00 | 35:00 | 1:10:00 | #+TBLFM: @2$3=$1+$2;T Values must be of the form =[HH:]MM:SS=, where hours are optional. Thanks to Martin Halder, Eric Schulte and Carsten for code and feedback on this. **** Implement formulas applying to field ranges Carsten implemented this field-ranges formulas. : A frequently requested feature for tables has been to be able to define : row formulas in a way similar to column formulas. The patch below allows : things like : : @3= : @2$2..@5$7= : @I$2..@II$4= : : as the left hand side for table formulas in order to write a formula that : is valid for an entire column or for a rectangular section in a : table. Thanks a lot to Carsten for this. **** Sending radio tables from org buffers is now allowed Org radio tables can no also be sent inside Org buffers. Also, there is a new hook which get called after a table has been sent. Thanks to Seweryn Kokot. *** Lists **** Improved handling of lists Nicolas Goaziou extended and improved the way Org handles lists. 1. Indentation of text determines again end of items in lists. So, some text less indented than the previous item doesn't close the whole list anymore, only all items more indented than it. 2. Alphabetical bullets are implemented, through the use of the variable `org-alphabetical-lists'. This also adds alphabetical counters like [@c] or [@W]. 3. Lists can now safely contain drawers, inline tasks, or various blocks, themselves containing lists. Two variables are controlling this: `org-list-forbidden-blocks', and `org-list-export-context'. 4. Improve `newline-and-indent' (C-j): used in an item, it will keep text from moving at column 0. This allows to split text and make paragraphs and still not break the list. 5. Improve `org-toggle-item' (C-c -): used on a region with standard text, it will change the region into one item. With a prefix argument, it will fallback to the previous behavior and make every line in region an item. It permits to easily integrate paragraphs inside a list. 6. `fill-paragraph' (M-q) now understands lists. It can freely be used inside items, or on text just after a list, even with no blank line around, without breaking list structure. Thanks a lot to Nicolas for all this! *** Inline display of linked images Images can now be displayed inline. The key C-c C-x C-v does toggle the display of such images. Note that only image links that have no description part will be inlined. *** Implement offsets for ordered lists If you want to start an ordered plain list with a number different from 1, you can now do it like this: : 1. [@start:12] will star a lit a number 12 *** Babel: code block body expansion for table and preview In org-babel, code is "expanded" prior to evaluation. I.e. the code that is actually evaluated comprises the code block contents, augmented with the extra code which assigns the referenced data to variables. It is now possible to preview expanded contents, and also to expand code during tangling. This expansion takes into account all header arguments, and variables. A new keybinding `C-c M-b p' bound to `org-babel-expand-src-block' can be used from inside of a source code block to preview its expanded contents (which can be very useful for debugging). tangling The expanded body can now be tangled, this includes variable values which may be the results of other source-code blocks, or stored in headline properties or tables. One possible use for this is to allow those using org-babel for their emacs initialization to store values (e.g. usernames, passwords, etc...) in headline properties or in tables. Org-babel now supports three new header arguments, and new default behavior for handling horizontal lines in tables (hlines), column names, and rownames across all languages. *** Editing Convenience and Appearance **** New command =org-copy-visible= (=C-c C-x v=) This command will copy the visible text in the region into the kill ring. Thanks to Florian Beck for this function and to Carsten for adding it to org.el and documenting it! **** Make it possible to protect hidden subtrees from being killed by =C-k= See the new variable =org-ctrl-k-protect-subtree=. This was a request by Scott Otterson. **** Implement pretty display of entities, sub-, and superscripts. The command =C-c C-x \= toggles the display of Org's special entities like =\alpha= as pretty unicode characters. Also, sub and superscripts are displayed in a pretty way (raised/lower display, in a smaller font). If you want to exclude sub- and superscripts, see the variable =org-pretty-entities-include-sub-superscripts=. Thanks to Eric Schulte and Ulf Stegeman for making this possible. **** New faces for title, date, author and email address lines The keywords in these lines are now dimmed out, and the title is displayed in a larger font, and a special font is also used for author, date, and email information. This is implemented by the following new faces: =org-document-title= =org-document-info= =org-document-info-keyword= In addition, the variable =org-hidden-keywords= can be used to make the corresponding keywords disappear. Thanks to Dan Davison for this feature. **** Simpler way to specify faces for tags and todo keywords The variables =org-todo-keyword-faces=, =org-tag-faces=, and =org-priority-faces= now accept simple color names as specifications. The colors will be used as either foreground or background color for the corresponding keyword. See also the variable =org-faces-easy-properties=, which governs which face property is affected by this setting. This is really a great simplification for setting keyword faces. The change is based on an idea and patch by Ryan Thompson. **** in tables now means fixed width, not maximum width Requested by Michael Brand. **** Better level cycling function =TAB= in an empty headline cycles the level of that headline through likely states. Ryan Thompson implemented an improved version of this function, which does not depend upon when exactly this command is used. Thanks to Ryan for this improvement. **** Adaptive filling For paragraph text, =org-adaptive-fill-function= did not handle the base case of regular text which needed to be filled. This is now fixed. Among other things, it allows email-style ">" comments to be filled correctly. Thanks to Dan Hackney for this patch. **** `org-reveal' (=C-c C-r=) also decrypts encrypted entries (org-crypt.el) Thanks to Richard Riley for triggering this change. **** Better automatic letter selection for TODO keywords When all first letters of keywords have been used, Org now assigns more meaningful characters based on the keywords. Thanks to Mikael Fornius for this patch. *** Clocking **** Clock: Allow synchronous update of timestamps in CLOCK log Using =S-M-= on CLOCK log timestamps will increase/decrease the two timestamps on this line so that duration will keep the same. Note that duration can still be slightly modified in case a timestamp needs some rounding. Thanks to Rainer Stengele for this idea. **** Localized clock tables Clock tables now support a new =:lang= parameter, allowing the user to customize the localization of the table headers. See the variable =org-clock-clocktable-language-setup= which controls available translated strings. **** Show clock overruns in mode line When clocking an item with a planned effort, overrunning the planned time is now made visible in the mode line, for example using the new face =org-mode-line-clock-overrun=, or by adding an extra string given by =org-task-overrun-text=. Thanks to Richard Riley for a patch to this effect. **** Clock reports can now include the running, incomplete clock If you have a clock running, and the entry being clocked falls into the scope when creating a clock table, the time so far spent can be added to the total. This behavior depends on the setting of =org-clock-report-include-clocking-task=. The default is =nil=. Thanks to Bernt Hansen for this useful addition. *** Misc **** Improvements with inline tasks and indentation There is now a configurable way on how to export inline tasks. See the new variable =org-inlinetask-export-templates=. Thanks to Nicolas Goaziou for coding these changes. **** A property value of =nil= now means to unset a property This can be useful in particular with property inheritance, if some upper level has the property, and some grandchild of it would like to have the default settings (i.e. not overruled by a property) back. Thanks to Robert Goldman and Bernt Hansen for suggesting this change. **** New helper functions in org-table.el There are new functions to access and write to a specific table field. This is for hackers, and maybe for the org-babel people. #+begin_example org-table-get org-table-put org-table-current-line org-table-goto-line #+end_example **** Archiving: Allow to reverse order in target node The new option =org-archive-reversed-order= allows to have archived entries inserted in a last-on-top fashion in the target node. This was requested by Tom. **** Org-reveal: Double prefix arg shows the entire subtree of the parent This can help to get out of an inconsistent state produced for example by viewing from the agenda. This was a request by Matt Lundin. * License This file is part of GNU Emacs. GNU Emacs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. GNU Emacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Emacs. If not, see .