mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-07-15 21:46:27 +00:00
41e9733d2f
* lisp/org-bibtex.el (org-bibtex-fields): * lisp/org-docview.el (org-docview-export): * lisp/org-entities.el (org-entities): * lisp/ox-icalendar.el (org-icalendar-cleanup-string): Fix typo by replacing ‘\’ with ‘\\’ in a string literal. For example, to get the regular expression ‘\.’ use the string literal "\\.", not "\." (which is equivalent to "."). Fix several backslash typos in Elisp strings 753fbfbef484272bcde5214f75fb0846ee3f33df Paul Eggert Thu Sep 17 12:39:54 2015 -0700
103 lines
3.5 KiB
EmacsLisp
103 lines
3.5 KiB
EmacsLisp
;;; org-docview.el --- support for links to doc-view-mode buffers
|
|
|
|
;; Copyright (C) 2009-2015 Free Software Foundation, Inc.
|
|
|
|
;; Author: Jan Böcker <jan.boecker at jboecker dot de>
|
|
;; Keywords: outlines, hypermedia, calendar, wp
|
|
;; Homepage: http://orgmode.org
|
|
;;
|
|
;; This file is part of GNU Emacs.
|
|
;;
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;;
|
|
;;; Commentary:
|
|
|
|
;; This file implements links to open files in doc-view-mode.
|
|
;; Org-mode loads this module by default - if this is not what you want,
|
|
;; configure the variable `org-modules'.
|
|
|
|
;; The links take the form
|
|
;;
|
|
;; docview:<file path>::<page number>
|
|
;;
|
|
;; for example: [[docview:~/.elisp/org/doc/org.pdf::1][Org-Mode Manual]]
|
|
;;
|
|
;; Autocompletion for inserting links is supported; you will be
|
|
;; prompted for a file and a page number.
|
|
;;
|
|
;; If you use org-store-link in a doc-view mode buffer, the stored
|
|
;; link will point to the current page.
|
|
|
|
;;; Code:
|
|
|
|
|
|
(require 'org)
|
|
(require 'doc-view)
|
|
|
|
(declare-function doc-view-goto-page "doc-view" (page))
|
|
(declare-function image-mode-window-get "image-mode" (prop &optional winprops))
|
|
|
|
(org-add-link-type "docview" 'org-docview-open 'org-docview-export)
|
|
(add-hook 'org-store-link-functions 'org-docview-store-link)
|
|
|
|
(defun org-docview-export (link description format)
|
|
"Export a docview link from Org files."
|
|
(let* ((path (if (string-match "\\(.+\\)::.+" link) (match-string 1 link)
|
|
link))
|
|
(desc (or description link)))
|
|
(when (stringp path)
|
|
(setq path (org-link-escape (expand-file-name path)))
|
|
(cond
|
|
((eq format 'html) (format "<a href=\"%s\">%s</a>" path desc))
|
|
((eq format 'latex) (format "\\href{%s}{%s}" path desc))
|
|
((eq format 'ascii) (format "%s (%s)" desc path))
|
|
(t path)))))
|
|
|
|
(defun org-docview-open (link)
|
|
(string-match "\\(.*?\\)\\(?:::\\([0-9]+\\)\\)?$" link)
|
|
(let ((path (match-string 1 link))
|
|
(page (and (match-beginning 2)
|
|
(string-to-number (match-string 2 link)))))
|
|
;; Let Org mode open the file (in-emacs = 1) to ensure
|
|
;; org-link-frame-setup is respected.
|
|
(org-open-file path 1)
|
|
(when page (doc-view-goto-page page))))
|
|
|
|
(defun org-docview-store-link ()
|
|
"Store a link to a docview buffer."
|
|
(when (eq major-mode 'doc-view-mode)
|
|
;; This buffer is in doc-view-mode
|
|
(let* ((path buffer-file-name)
|
|
(page (image-mode-window-get 'page))
|
|
(link (concat "docview:" path "::" (number-to-string page)))
|
|
(description ""))
|
|
(org-store-link-props
|
|
:type "docview"
|
|
:link link
|
|
:description path))))
|
|
|
|
(defun org-docview-complete-link ()
|
|
"Use the existing file name completion for file.
|
|
Links to get the file name, then ask the user for the page number
|
|
and append it."
|
|
(concat (replace-regexp-in-string "^file:" "docview:" (org-file-complete-link))
|
|
"::"
|
|
(read-from-minibuffer "Page:" "1")))
|
|
|
|
|
|
(provide 'org-docview)
|
|
|
|
;;; org-docview.el ends here
|