emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob f2d0bf285607d56f9a1aa265f04fb4aa8d59ebdf 3884 bytes (raw)
name: lisp/org-docview.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
;;; org-docview.el --- support for links to doc-view-mode buffers

;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
;;   Free Software Foundation, Inc.

;; Author: Jan Böcker <jan.boecker at jboecker dot de>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;; Version: 6.33trans
;;
;; 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)

(declare-function doc-view-goto-page "doc-view" (page))
(declare-function doc-view-current-page "doc-view"  (&optional win))

(org-add-link-type "docview" 'org-docview-open)
(add-hook 'org-store-link-functions 'org-docview-store-link)

(defcustom org-docview-pdf-app
  'emacs
  "External application to open docview: links pointing to a pdf file.
Possible values:

    'emacs:    Visit the file with emacs using doc-view-mode.
    string:    An external PDF viewer application.
               %s will be replaced by the file name.
               %p will be replaced by the page number.

               Example:
               evince %s -p %p"
  :group 'org-link-follow
  :type '(choice (const :tag "Visit with Emacs" emacs)
		 (string :tag "Command")))

(defun org-docview-open (link)
  (when (string-match "\\(.*\\)::\\([0-9]+\\)$"  link)
    (let* ((path (match-string 1 link))
	   (page-string (match-string 2 link))
	   (page (string-to-number page-string)))

      (if (and (not (eq org-docview-pdf-app 'emacs))
	       (string-match "\.pdf$" path))
	  (let ((cmd (with-temp-buffer
		       (insert org-docview-pdf-app)
		       (goto-char 1)
		       (replace-string "%s" path)
		       (goto-char 1)
		       (replace-string "%p" page-string)
		       (buffer-string))))
	    (message cmd)
	    (start-process-shell-command cmd nil cmd))

	(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 (doc-view-current-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)

debug log:

solving f2d0bf2 ...
found f2d0bf2 in https://list.orgmode.org/orgmode/4B3F9D2A.4050408@jboecker.de/
found 98da615 in https://git.savannah.gnu.org/cgit/emacs/org-mode.git
preparing index
index prepared:
100644 98da6159d01ddc8f362c4ea01fb511969a8b9c40	lisp/org-docview.el

applying [1/1] https://list.orgmode.org/orgmode/4B3F9D2A.4050408@jboecker.de/
diff --git a/lisp/org-docview.el b/lisp/org-docview.el
index 98da615..f2d0bf2 100644

Checking patch lisp/org-docview.el...
Applied patch lisp/org-docview.el cleanly.

index at:
100644 f2d0bf285607d56f9a1aa265f04fb4aa8d59ebdf	lisp/org-docview.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).