From: Oleg Pykhalov <go.wigust@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] Implement Org pdfview
Date: Wed, 20 Sep 2017 18:47:12 +0300 [thread overview]
Message-ID: <87r2v15q4f.fsf@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 459 bytes --]
Hello Emacs Org,
I prepared pdf-view based on doc-view for org-capture.
--8<---------------cut here---------------start------------->8---
guix environment emacs-org -- make test
…
org-pdfview.el:102:1:Warning: the function ‘pdf-view-current-page’ is not
known to be defined.
…
Ran 738 tests, 738 results as expected (2017-09-20 18:39:25+0300)
13 expected failures
--8<---------------cut here---------------end--------------->8---
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: [PATCH] Implement Org pdfview --]
[-- Type: text/x-patch, Size: 4131 bytes --]
From 4d1a7452f9dfd06e9730ceafd3fefb5bea52e3ec Mon Sep 17 00:00:00 2001
From: Oleg Pykhalov <go.wigust@gmail.com>
Date: Wed, 20 Sep 2017 18:14:26 +0300
Subject: [PATCH] Implement Org pdfview
* lisp/org-pdfview.el: New file.
---
lisp/org-pdfview.el | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 101 insertions(+)
create mode 100644 lisp/org-pdfview.el
diff --git a/lisp/org-pdfview.el b/lisp/org-pdfview.el
new file mode 100644
index 000000000..ebfcfef14
--- /dev/null
+++ b/lisp/org-pdfview.el
@@ -0,0 +1,101 @@
+;;; org-pdfview.el --- Support for links to pdf-view-mode buffers -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2009-2017 Free Software Foundation, Inc.
+
+;; Author: Oleg Pykhalov <go.wigust at gmail dot com>
+;; 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 pdf-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
+;;
+;; pdfview:<file path>::<page number>
+;;
+;; for example: [[pdfview:~/.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 pdf-view mode buffer, the stored
+;; link will point to the current page.
+
+;;; Code:
+
+
+(require 'org)
+
+(declare-function pdf-view-goto-page "pdf-view" (page))
+
+(org-link-set-parameters "pdfview"
+ :follow #'org-pdfview-open
+ :export #'org-pdfview-export
+ :store #'org-pdfview-store-link)
+
+(defun org-pdfview-export (link description format)
+ "Export a pdfview 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-pdfview-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 (pdf-view-goto-page page))))
+
+(defun org-pdfview-store-link ()
+ "Store a link to a pdfview buffer."
+ (when (eq major-mode 'pdf-view-mode)
+ ;; This buffer is in pdf-view-mode
+ (let* ((path buffer-file-name)
+ (page (pdf-view-current-page))
+ (link (concat "pdfview:" path "::" (number-to-string page))))
+ (org-store-link-props
+ :type "pdf-view"
+ :link link
+ :description path))))
+
+(defun org-pdfview-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:" "pdfview:" (org-file-complete-link))
+ "::"
+ (read-from-minibuffer "Page:" "1")))
+
+
+(provide 'org-pdfview)
+
+;;; org-pdfview.el ends here
--
2.14.1
next reply other threads:[~2017-09-20 15:47 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-20 15:47 Oleg Pykhalov [this message]
[not found] ` <87bmm5qoux.fsf@oscarnajera.com>
2017-09-21 11:02 ` [PATCH] Implement Org pdfview Oleg Pykhalov
2017-09-21 20:17 ` Oscar Najera
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87r2v15q4f.fsf@gmail.com \
--to=go.wigust@gmail.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).