Next: , Up: Tools   [Index]


18.3.3.1 org-element-map

Function: org-element-map data types fun &optional info first-match no-recursion with-affiliated

Map a function on selected elements or objects.

DATA

is one of:

  • parse tree
  • element
  • object
  • string
  • list of constructs
TYPES

is one of:

  • symbol
  • list of symbols of elements or objects types
FUN

is the function called on the matching element or object; it must accept one argument: the element or object itself. nil values returned from FUN do not appear in results.

INFO

when non-nil, is a plist holding export options, in which case those parts of the parse tree not exportable according to that property list will be skipped.

FIRST-MATCH

when non-nil, stop at the first match for which FUN doesn’t return nil; return that value;

NO-RECURSION

is a symbol or a list of symbols representing element or objects types. The FUN will not enter any recursive element or object whose type belongs to that list. FUN can still be applied on them.

WITH-AFFILIATED

when non-nil, FUN will also apply to matching objects within parsed affiliated keywords. See org-element-parsed-keywords.