-
Notifications
You must be signed in to change notification settings - Fork 45
/
ORG-NEWS
9020 lines (6267 loc) · 332 KB
/
ORG-NEWS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
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:[email protected].
* 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-toggle-inline-images-command~, which uses different defaults:
1. By default, it toggles image at point or, if there is no image at
point, images in current entry
2. When region is active, it is honored
3. =C-u= argument changed its meaning. Now, it forces toggling images
in the whole buffer
4. =C-u C-u= argument unconditionally hides all the images in buffer
5. 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 old ~org-toggle-inline-images~ command is still available. You
can bind it back to =C-c C-x C-v= by adding the following to you 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.
*** 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.
*** 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.
*** 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 ~<head>~ tag in
the resulting HTML document.
** 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/[email protected]/
#+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
: <point>* Heading 2
yielded
: * Heading 1
: ** <point>
: * 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
: ** <point>
*** 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:<lang>~
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:<lang>~. 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-<down>=/=M-<up>= 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~.