forked from mirrors/org-mode
ox: Clarify a docstring
* lisp/ox.el (org-export-get-all-options): Specify return value for unknown back-ends. (org-export--parse-option-keyword): (org-export--get-subtree-options): (org-export--get-inbuffer-options): (org-export--get-global-options): Remove useless check.
This commit is contained in:
parent
4b4ccdc3fa
commit
aadde88799
12
lisp/ox.el
12
lisp/ox.el
|
@ -1069,7 +1069,9 @@ BACKEND is an export back-end, as return by, e.g,,
|
||||||
for the shape of the return value.
|
for the shape of the return value.
|
||||||
|
|
||||||
Unlike to `org-export-backend-options', this function also
|
Unlike to `org-export-backend-options', this function also
|
||||||
returns options inherited from parent back-ends, if any."
|
returns options inherited from parent back-ends, if any.
|
||||||
|
|
||||||
|
Return nil if BACKEND is unknown."
|
||||||
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
|
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
|
||||||
(when backend
|
(when backend
|
||||||
(let ((options (org-export-backend-options backend))
|
(let ((options (org-export-backend-options backend))
|
||||||
|
@ -1373,7 +1375,7 @@ specific items to read, if any."
|
||||||
alist))
|
alist))
|
||||||
alist))
|
alist))
|
||||||
;; Priority is given to back-end specific options.
|
;; Priority is given to back-end specific options.
|
||||||
(all (append (and backend (org-export-get-all-options backend))
|
(all (append (org-export-get-all-options backend)
|
||||||
org-export-options-alist))
|
org-export-options-alist))
|
||||||
(plist))
|
(plist))
|
||||||
(when line
|
(when line
|
||||||
|
@ -1410,7 +1412,7 @@ for export. Return options as a plist."
|
||||||
(match-string-no-properties 4))))))
|
(match-string-no-properties 4))))))
|
||||||
;; Look for both general keywords and back-end specific
|
;; Look for both general keywords and back-end specific
|
||||||
;; options, with priority given to the latter.
|
;; options, with priority given to the latter.
|
||||||
(options (append (and backend (org-export-get-all-options backend))
|
(options (append (org-export-get-all-options backend)
|
||||||
org-export-options-alist)))
|
org-export-options-alist)))
|
||||||
;; Handle other keywords. Then return PLIST.
|
;; Handle other keywords. Then return PLIST.
|
||||||
(dolist (option options plist)
|
(dolist (option options plist)
|
||||||
|
@ -1446,7 +1448,7 @@ Assume buffer is in Org mode. Narrowing, if any, is ignored."
|
||||||
(let* ((case-fold-search t)
|
(let* ((case-fold-search t)
|
||||||
(options (append
|
(options (append
|
||||||
;; Priority is given to back-end specific options.
|
;; Priority is given to back-end specific options.
|
||||||
(and backend (org-export-get-all-options backend))
|
(org-export-get-all-options backend)
|
||||||
org-export-options-alist))
|
org-export-options-alist))
|
||||||
(regexp (format "^[ \t]*#\\+%s:"
|
(regexp (format "^[ \t]*#\\+%s:"
|
||||||
(regexp-opt (nconc (delq nil (mapcar #'cadr options))
|
(regexp-opt (nconc (delq nil (mapcar #'cadr options))
|
||||||
|
@ -1583,7 +1585,7 @@ which back-end specific export options should also be read in the
|
||||||
process."
|
process."
|
||||||
(let (plist
|
(let (plist
|
||||||
;; Priority is given to back-end specific options.
|
;; Priority is given to back-end specific options.
|
||||||
(all (append (and backend (org-export-get-all-options backend))
|
(all (append (org-export-get-all-options backend)
|
||||||
org-export-options-alist)))
|
org-export-options-alist)))
|
||||||
(dolist (cell all plist)
|
(dolist (cell all plist)
|
||||||
(let ((prop (car cell)))
|
(let ((prop (car cell)))
|
||||||
|
|
Loading…
Reference in New Issue