100 lines
3.4 KiB
EmacsLisp
100 lines
3.4 KiB
EmacsLisp
|
;;; org-info.el --- Support for links to Info nodes from within Org-Mode
|
||
|
|
|
||
|
|
;; Copyright (C) 2004-2016 Free Software Foundation, Inc.
|
||
|
|
|
||
|
|
;; Author: Carsten Dominik <carsten at orgmode dot org>
|
||
|
|
;; 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 Info nodes from within Org-mode.
|
||
|
|
;; Org-mode loads this module by default - if this is not what you want,
|
||
|
|
;; configure the variable `org-modules'.
|
||
|
|
|
||
|
|
;;; Code:
|
||
|
|
|
||
|
|
(require 'org)
|
||
|
|
|
||
|
|
;; Declare external functions and variables
|
||
|
|
|
||
|
|
(declare-function Info-find-node "info"
|
||
|
|
(filename nodename &optional no-going-back strict-case))
|
||
|
|
(defvar Info-current-file)
|
||
|
|
(defvar Info-current-node)
|
||
|
|
|
||
|
|
;; Install the link type
|
||
|
|
(org-add-link-type "info" 'org-info-open 'org-info-export)
|
||
|
|
(add-hook 'org-store-link-functions 'org-info-store-link)
|
||
|
|
|
||
|
|
;; Implementation
|
||
|
|
(defun org-info-store-link ()
|
||
|
|
"Store a link to an Info file and node."
|
||
|
|
(when (eq major-mode 'Info-mode)
|
||
|
|
(let (link desc)
|
||
|
|
(setq link (concat "info:"
|
||
|
|
(file-name-nondirectory Info-current-file)
|
||
|
|
"#" Info-current-node))
|
||
|
|
(setq desc (concat (file-name-nondirectory Info-current-file)
|
||
|
|
"#" Info-current-node))
|
||
|
|
(org-store-link-props :type "info" :file Info-current-file
|
||
|
|
:node Info-current-node
|
||
|
|
:link link :desc desc)
|
||
|
|
link)))
|
||
|
|
|
||
|
|
(defun org-info-open (path)
|
||
|
|
"Follow an Info file and node link specified by PATH."
|
||
|
|
(org-info-follow-link path))
|
||
|
|
|
||
|
|
|
||
|
|
(defun org-info-follow-link (name)
|
||
|
|
"Follow an Info file and node link specified by NAME."
|
||
|
|
(if (or (string-match "\\(.*\\)[#:]:?\\(.*\\)" name)
|
||
|
|
(string-match "\\(.*\\)" name))
|
||
|
|
(let ((filename (match-string 1 name))
|
||
|
|
(nodename-or-index (or (match-string 2 name) "Top")))
|
||
|
|
(require 'info)
|
||
|
|
;; If nodename-or-index is invalid node name, then look it up
|
||
|
|
;; in the index.
|
||
|
|
(condition-case nil
|
||
|
|
(Info-find-node filename nodename-or-index)
|
||
|
|
(user-error (Info-find-node filename "Top")
|
||
|
|
(condition-case nil
|
||
|
|
(Info-index nodename-or-index)
|
||
|
|
(user-error "Could not find '%s' node or index entry"
|
||
|
|
nodename-or-index)))))
|
||
|
|
(user-error "Could not open: %s" name)))
|
||
|
|
|
||
|
|
(defun org-info-export (path desc format)
|
||
|
|
"Export an info link.
|
||
|
|
See `org-add-link-type' for details about PATH, DESC and FORMAT."
|
||
|
|
(when (eq format 'html)
|
||
|
|
(or (string-match "\\(.*\\)[#:]:?\\(.*\\)" path)
|
||
|
|
(string-match "\\(.*\\)" path))
|
||
|
|
(let ((filename (match-string 1 path))
|
||
|
|
(node (or (match-string 2 path) "Top")))
|
||
|
|
(format "<a href=\"%s.html#%s\">%s</a>"
|
||
|
|
filename
|
||
|
|
(replace-regexp-in-string " " "-" node)
|
||
|
|
(or desc path)))))
|
||
|
|
|
||
|
|
(provide 'org-info)
|
||
|
|
|
||
|
|
;;; org-info.el ends here
|