[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org 9249275738 089/101: fixup! etc/ORG-NEWS: Document O
From: |
ELPA Syncer |
Subject: |
[elpa] externals/org 9249275738 089/101: fixup! etc/ORG-NEWS: Document Org API changes |
Date: |
Sat, 1 Jul 2023 09:59:16 -0400 (EDT) |
branch: externals/org
commit 9249275738c356d9fa7e729df35c445cd6bd72ff
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>
fixup! etc/ORG-NEWS: Document Org API changes
---
etc/ORG-NEWS | 26 ++++++++++++++++++++++----
1 file changed, 22 insertions(+), 4 deletions(-)
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 6568eef3ef..5510e95e1c 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -25,12 +25,13 @@ 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 for
+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)=
@@ -42,6 +43,9 @@ 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 getters.
@@ -143,7 +147,8 @@ 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 elements as
=POM= argument
+
+**** =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~
@@ -176,10 +181,12 @@ 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~,
~org-get-tags~
+~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
@@ -513,6 +520,7 @@ When =TYPES= is symbol, only check syntax nodes of that
type.
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
@@ -522,10 +530,15 @@ 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.
+~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.
@@ -539,10 +552,13 @@ 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~
@@ -560,7 +576,9 @@ 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=
+
** Miscellaneous
*** =org-crypt.el= now applies initial visibility settings to decrypted entries
- [elpa] externals/org 6266197bbd 051/101: org-at-item-p: Use org-element API, (continued)
- [elpa] externals/org 6266197bbd 051/101: org-at-item-p: Use org-element API, ELPA Syncer, 2023/07/01
- [elpa] externals/org 6938857369 052/101: org-goto-first-child: Switch to org-element API, ELPA Syncer, 2023/07/01
- [elpa] externals/org 7c549f4841 060/101: org-babel-tangle-collect-blocks: Switch to org-element API, ELPA Syncer, 2023/07/01
- [elpa] externals/org b2482d9cc4 070/101: * testing/lisp/test-org-element.el: Add new tests, ELPA Syncer, 2023/07/01
- [elpa] externals/org b0a2deaec6 073/101: org-element--current-element: Faster property drawer check, ELPA Syncer, 2023/07/01
- [elpa] externals/org 110601ce74 074/101: org-element--current-element: Add FIXME, ELPA Syncer, 2023/07/01
- [elpa] externals/org 48e4a76b99 079/101: org-element: Avoid computing static regexps dynamically, ELPA Syncer, 2023/07/01
- [elpa] externals/org f895be1ad9 086/101: org-element--properties-mapc: Small refactoring, ELPA Syncer, 2023/07/01
- [elpa] externals/org a04e16bd11 082/101: lisp/org-macs.el: Restructure file outline, fixing compiler warning, ELPA Syncer, 2023/07/01
- [elpa] externals/org 5a3224a325 085/101: etc/ORG-NEWS: Document Org API changes, ELPA Syncer, 2023/07/01
- [elpa] externals/org 9249275738 089/101: fixup! etc/ORG-NEWS: Document Org API changes,
ELPA Syncer <=
- [elpa] externals/org f97aeaa243 099/101: org-fold-core--isearch-setup: Use `add-function', ELPA Syncer, 2023/07/01
- [elpa] externals/org 55ba9f05a7 018/101: org-element-map: Refactor using `org-element-ast-map', ELPA Syncer, 2023/07/01
- [elpa] externals/org 29cb0b370b 022/101: org-element-headline-parser: Defer property drawer values, ELPA Syncer, 2023/07/01
- [elpa] externals/org 44baf8f2b8 030/101: org-element-parse-buffer: New optional argument to not force undefer, ELPA Syncer, 2023/07/01
- [elpa] externals/org 13ae9b95f8 045/101: org-narrow-to-subtree: Use org-element API, ELPA Syncer, 2023/07/01
- [elpa] externals/org 3024e933c0 053/101: org-get-buffer-tags: Switch to org-element API, ELPA Syncer, 2023/07/01
- [elpa] externals/org def4bfa9c1 055/101: org-scan-tag: Switch to pure use of `org-element-cache-map', ELPA Syncer, 2023/07/01
- [elpa] externals/org 2efc7fcfdc 058/101: org-agenda-get-scheduled: Switch to org-element API, ELPA Syncer, 2023/07/01
- [elpa] externals/org 598d7bbcf2 062/101: Remove APPT_WARNTIME text property cache, ELPA Syncer, 2023/07/01
- [elpa] externals/org 39466ecf47 065/101: org-element-cache: Do not check for deferred :parent unnecessarily, ELPA Syncer, 2023/07/01