Function: doc-view--outline

doc-view--outline is a byte-compiled function defined in doc-view.el.gz.

Signature

(doc-view--outline &optional FILE-NAME)

Documentation

Return the outline for the file FILE-NAME.

If FILE-NAME is nil, use the current file instead.

Source Code

;; Defined in /usr/src/emacs/lisp/doc-view.el.gz
(defun doc-view--outline (&optional file-name)
  "Return the outline for the file FILE-NAME.
If FILE-NAME is nil, use the current file instead."
  (unless file-name (setq file-name (buffer-file-name)))
  (let ((outline
         (pcase doc-view-doc-type
           ('djvu
            (when doc-view-djvused-program
              (doc-view--djvu-outline file-name)))
           ('odf
            (doc-view--pdf-outline (doc-view-current-cache-doc-pdf)))
           (_
            (doc-view--pdf-outline file-name)))))
    (when outline (imenu-add-to-menubar "Outline"))
    ;; When the outline could not be made due to unavailability of the
    ;; required program, or its absence from the document, return
    ;; 'unavailable'.
    (or outline 'unavailable)))