GNU-devel ELPA - org

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-2022 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.6 (not yet released)

** Important announcements and breaking changes

*** Element cache is enabled by default and work 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 optimised 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 optimisation can be enabled by customising
=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 behaviour.  The new features and changes are listed below.

**** Hidden parts of the links can now be searched and revealed during isearch

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 behaviour 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.
...
...