Function: org-export-get-caption

org-export-get-caption is a byte-compiled function defined in ox.el.gz.

Signature

(org-export-get-caption ELEMENT &optional SHORT)

Documentation

Return caption from ELEMENT as a secondary string.

When optional argument SHORT is non-nil, return short caption, as a secondary string, instead.

Caption lines are separated by a white space.

Source Code

;; Defined in /usr/src/emacs/lisp/org/ox.el.gz
(defun org-export-get-caption (element &optional short)
  "Return caption from ELEMENT as a secondary string.

When optional argument SHORT is non-nil, return short caption, as
a secondary string, instead.

Caption lines are separated by a white space."
  (let ((full-caption (org-element-property :caption element))
	(get (if short #'cdr #'car))
	caption)
    (dolist (line full-caption)
      (pcase (funcall get line)
	(`nil nil)
	(c
	 (setq caption
	       (nconc (list " ")
		      (copy-sequence c) caption)))))
    (cdr caption)))