1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-04 02:51:31 -08:00
emacs/lisp/org/org-docview.el
Paul Eggert 753fbfbef4 Fix several backslash typos in Elisp strings
* lisp/calendar/todo-mode.el (todo-files, todo-rename-file)
(todo-find-filtered-items-file, todo-reset-nondiary-marker)
(todo-reset-done-string, todo-reset-comment-string)
(todo-reset-highlight-item):
* lisp/erc/erc-networks.el (erc-networks-alist):
* lisp/gnus/gnus-art.el (gnus-button-handle-library):
* lisp/gnus/gnus-group.el (gnus-read-ephemeral-gmane-group-url):
* lisp/gnus/nntp.el (nntp-via-shell-prompt)
(nntp-telnet-shell-prompt):
* lisp/gnus/spam-report.el (spam-report-gmane-regex):
* lisp/image-dired.el (image-dired-rotate-original):
(image-dired-get-exif-file-name):
* lisp/international/latin1-disp.el (latin1-display-ucs-per-lynx):
* lisp/mail/undigest.el (rmail-digest-parse-rfc1153strict):
* lisp/mh-e/mh-letter.el (mh-file-is-vcard-p):
* lisp/mh-e/mh-mime.el (mh-file-mime-type-substitutions):
* lisp/net/shr-color.el (shr-color->hexadecimal):
* lisp/org/org-bibtex.el (org-bibtex-fields):
* lisp/org/org-docview.el (org-docview-export):
* lisp/org/org-entities.el (org-entities):
* lisp/org/ox-icalendar.el (org-icalendar-cleanup-string):
* lisp/progmodes/cperl-mode.el (cperl-indent-exp):
* lisp/progmodes/ebnf2ps.el (ebnf-file-suffix-regexp)
(ebnf-style-database):
* lisp/progmodes/idlw-help.el (idlwave-do-context-help1):
* lisp/progmodes/ruby-mode.el (ruby-imenu-create-index-in-block):
* lisp/progmodes/sql.el (sql-product-alist):
* lisp/progmodes/verilog-mode.el (verilog-error-regexp-emacs-alist)
(verilog-error-font-lock-keywords)
(verilog-assignment-operator-re):
* lisp/progmodes/vhdl-mode.el (vhdl-compiler-alist):
* lisp/textmodes/reftex-parse.el (reftex-parse-from-file):
* lisp/vc/add-log.el (change-log-version-number-regexp-list):
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 ".").
* lisp/emulation/viper-util.el (viper-glob-unix-files):
Remove stray ‘\j’ from string.
* lisp/gnus/nntp.el (nntp-via-shell-prompt)
(nntp-telnet-shell-prompt):
Treat > like $ when matching a shell prompt.
* lisp/progmodes/make-mode.el (makefile-browse):
Properly quote a diagnostic.
2015-09-17 12:39:54 -07:00

101 lines
3.4 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 (when (string-match "\\(.+\\)::.+" link)
(match-string 1 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)
(when (string-match "\\(.*\\)::\\([0-9]+\\)$" link)
(let* ((path (match-string 1 link))
(page (string-to-number (match-string 2 link))))
(org-open-file path 1) ;; let org-mode open the file (in-emacs = 1)
;; to ensure org-link-frame-setup is respected
(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