mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-11-21 06:55:35 +00:00
Code
bb4b0d7efc
org-mode/lisp/org-info.el

131 lines
5.0 KiB
EmacsLisp
Raw Normal View History

Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
;;; org-info.el --- Support for links to Info nodes from within Org-Mode
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
Update copyright years
2016-01-09 22:12:03 +00:00
;; Copyright (C) 2004-2016 Free Software Foundation, Inc.
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;;
;; This file is part of GNU Emacs.
;;
Sync copyright fixes from downstream Emacs
2008-05-06 12:45:52 +00:00
;; GNU Emacs is free software: you can redistribute it and/or modify
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
;; it under the terms of the GNU General Public License as published by
Sync copyright fixes from downstream Emacs
2008-05-06 12:45:52 +00:00
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
;; 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
Sync copyright fixes from downstream Emacs
2008-05-06 12:45:52 +00:00
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
;; This file implements links to Info nodes from within Org-mode.
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
;; Org-mode loads this module by default - if this is not what you want,
;; configure the variable `org-modules'.
Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
;;; Code:
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(require 'org)
;; Declare external functions and variables
Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
Backport commit 65c8c7c from Emacs * lisp/ob-awk.el (orgtbl-to-generic): * lisp/ob-core.el (orgtbl-to-generic): * lisp/ob-exp.el (org-element-context): * lisp/ob-gnuplot.el (org-time-string-to-time) (orgtbl-to-generic): * lisp/ob-haskell.el (org-export-to-file): * lisp/ob-latex.el (org-create-formula-image) (org-latex-compile): * lisp/ob-python.el (run-python): * lisp/ob-tangle.el (org-link-escape, org-back-to-heading): * lisp/org-colview.el (org-agenda-redo): * lisp/org-feed.el (url-retrieve-synchronously): * lisp/org-info.el (Info-find-node): * lisp/org-list.el (org-previous-line-empty-p): * lisp/org-macs.el (org-string-match-p): * lisp/org.el (org-beamer-mode): Fix prototype to match current definition. * lisp/ob-comint.el (tramp-flush-directory-property): * lisp/ob-tangle.el (org-babel-update-block-body): * lisp/org-bibtex.el (org-babel-trim): * lisp/org-pcomplete.el (org-export-backend-options): * lisp/org-protocol.el (org-publish-get-project-from-filename): Fix file name in declare-function. * lisp/ob-comint.el (with-parsed-tramp-file-name) * lisp/ob-core.el (with-parsed-tramp-file-name): * lisp/org.el (org-beamer-mode): Append ‘t’ to declare-function, since the declaration isn’t a defun. * lisp/ob-core.el (org-save-outline-visibility): Remove; not needed. * lisp/ob-scheme.el (run-geiser, geiser-mode) (geiser-eval-region, geiser-repl-exit): * lisp/ox-org.el (htmlize-buffer): Prepend "ext:" to file name, since it is not part of Emacs. * lisp/org-gnus.el (nnimap-group-overview-filename): Remove decl, since function was removed. * lisp/org-macro.el (org-with-wide-buffer): Omit unnecessary (and mismatching) decl. * lisp/org-clock.el (calendar-iso-to-absolute): Declare calendar-iso-to-absolute instead, since it is the non-obsolete version of this function. * lisp/org-compat.el (w32-focus-frame): Remove decl, since function is now obsolete. Pacify ‘make check-declare’ 65c8c7cb96c14f9c6accd03cc8851b5a3459049e Paul Eggert Sat May 14 19:57:44 2016 -0700
2016-05-15 02:56:53 +00:00
(declare-function Info-find-node "info"
(filename nodename &optional no-going-back strict-case))
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(defvar Info-current-file)
(defvar Info-current-node)
;; Install the link type
org-info: Correctly export info links to HTML * lisp/org-info.el (org-info-export): New function. Reported-by: Richard Y. Kim <emacs18@gmail.com> <http://permalink.gmane.org/gmane.emacs.orgmode/96779>
2015-04-10 08:38:06 +00:00
(org-add-link-type "info" 'org-info-open 'org-info-export)
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(add-hook 'org-store-link-functions 'org-info-store-link)
;; Implementation
(defun org-info-store-link ()
Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
"Store a link to an Info file and node."
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(when (eq major-mode 'Info-mode)
(let (link desc)
Delete `org-make-link' and replace previous occurrences by `concat'. * org.el (org-make-link): Delete. (org-store-link, org-insert-link) (org-file-complete-link): Don't use `org-make-link'. * org-wl.el (org-wl-store-link-folder) (org-wl-store-link-message): Ditto. * org-vm.el (org-vm-store-link): Ditto. * org-rmail.el (org-rmail-store-link): Ditto. * org-mhe.el (org-mhe-store-link): Ditto. * org-mew.el (org-mew-store-link): Ditto. * org-irc.el (org-irc-erc-store-link): Ditto. * org-info.el (org-info-store-link): Ditto. * org-id.el (org-id-store-link): Ditto. * org-gnus.el (org-gnus-group-link, org-gnus-article-link): Ditto. * org-eshell.el (org-eshell-store-link): Ditto. * org-bbdb.el (org-bbdb-store-link): Ditto.
2012-08-03 17:03:21 +00:00
(setq link (concat "info:"
Massive code clean-up. Delete trailing whitespaces. Indent all sexps correctly. Sentences end with double spaces.
2012-08-11 17:10:44 +00:00
(file-name-nondirectory Info-current-file)
"#" Info-current-node))
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(setq desc (concat (file-name-nondirectory Info-current-file)
Use # to separate the info file and the node in Org links. * org-info.el (org-info-store-link): use "#" to separate the info file and the node. (org-info-follow-link): use both "#" to separate the info file and the node. Continue to use ":" for backward compatibility.
2011-02-11 12:38:39 +00:00
"#" Info-current-node))
Make sure the link-storing function returns non-nil.
2008-03-15 20:34:06 +00:00
(org-store-link-props :type "info" :file Info-current-file
:node Info-current-node
:link link :desc desc)
link)))
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(defun org-info-open (path)
Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
"Follow an Info file and node link specified by PATH."
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(org-info-follow-link path))
(defun org-info-follow-link (name)
Doc fixes by Philip Rooke <phil@yax.org.uk> A number of small changes. Mainly they are to pacify 'checkdoc-ispell' (if it seems appropriate) and to standardise the names of the packages you can link to from within Org-mode. I am using the package names as spelt or abbreviated in their own documentation (if I have been able to find it easily). Thus, for example, prefer MH-E over MHE, Rmail over RMAIL etc.
2008-03-21 16:10:23 +00:00
"Follow an Info file and node link specified by NAME."
Use # to separate the info file and the node in Org links. * org-info.el (org-info-store-link): use "#" to separate the info file and the node. (org-info-follow-link): use both "#" to separate the info file and the node. Continue to use ":" for backward compatibility.
2011-02-11 12:38:39 +00:00
(if (or (string-match "\\(.*\\)[#:]:?\\(.*\\)" name)
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(string-match "\\(.*\\)" name))
org-info: Try info index if info node is not found * lisp/org-info.el (org-info-follow-link): Attempt index lookup if node lookup fails. * doc/org.texi (External links): Update info links. Info index is almost always finer grain than info nodes. For example with this change, [[info:libc#close]] brings up not only "(libc)Opening and Closing Files" info node, but also place the cursor on the line that documents "close" function within the node. This is done by looking up "close"in the index upon failing to find a node named "close". Hence one can now link function, variable and other names that are in the index rather than being limited to info node names. Typically there are far more index items than there are node names. For example libc manual has about 700 nodes, but over 4000 concept, type, function, and variables index items. More examples of new ways to create links are shown using org.info as example - [[info:org#org-clock-idle-time]] uses "Variable Index" - [[info:org#org-capture]] uses "Command and Function Index". - [[info:org#timestamp]] uses "Main Index" - [[info:org#C-c C-c]] uses "Key Index" TINYCHANGE
2014-11-15 18:37:39 +00:00
(let ((filename (match-string 1 name))
(nodename-or-index (or (match-string 2 name) "Top")))
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(require 'info)
org-info: Try info index if info node is not found * lisp/org-info.el (org-info-follow-link): Attempt index lookup if node lookup fails. * doc/org.texi (External links): Update info links. Info index is almost always finer grain than info nodes. For example with this change, [[info:libc#close]] brings up not only "(libc)Opening and Closing Files" info node, but also place the cursor on the line that documents "close" function within the node. This is done by looking up "close"in the index upon failing to find a node named "close". Hence one can now link function, variable and other names that are in the index rather than being limited to info node names. Typically there are far more index items than there are node names. For example libc manual has about 700 nodes, but over 4000 concept, type, function, and variables index items. More examples of new ways to create links are shown using org.info as example - [[info:org#org-clock-idle-time]] uses "Variable Index" - [[info:org#org-capture]] uses "Command and Function Index". - [[info:org#timestamp]] uses "Main Index" - [[info:org#C-c C-c]] uses "Key Index" TINYCHANGE
2014-11-15 18:37:39 +00:00
;; 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)))))
org-info: Throw an error when following an info link fails * lisp/org-info.el (org-info-follow-link): Throw an error instead of a message when search fails.
2014-11-15 23:18:24 +00:00
(user-error "Could not open: %s" name)))
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
org-info.el: Generate HTML links to gnu.org * lisp/org-info.el (org-info-export): Convert info links to HTML URL's that point to appropriate gnu.org or other pages. User's can customize the behavior using `org-info-emacs-documents' and `org-info-other-documets' new variables. TINYCHANGE
2016-03-10 14:29:48 +00:00
(defconst org-info-emacs-documents
'("ada-mode" "auth" "autotype" "bovine" "calc" "ccmode" "cl" "dbus" "dired-x"
"ebrowse" "ede" "ediff" "edt" "efaq-w32" "efaq" "eieio" "eintr" "elisp"
"emacs-gnutls" "emacs-mime" "emacs" "epa" "erc" "ert" "eshell" "eudc" "eww"
"flymake" "forms" "gnus" "htmlfontify" "idlwave" "ido" "info" "mairix-el"
"message" "mh-e" "newsticker" "nxml-mode" "octave-mode" "org" "pcl-cvs"
"pgg" "rcirc" "reftex" "remember" "sasl" "sc" "semantic" "ses" "sieve"
"smtpmail" "speedbar" "srecode" "todo-mode" "tramp" "url" "vip" "viper"
"widget" "wisent" "woman")
"List of emacs documents available.
Taken from <http://www.gnu.org/software/emacs/manual/html_mono/.>")
(defconst org-info-other-documents
'(("libc" . "http://www.gnu.org/software/libc/manual/html_mono/libc.html")
("make" . "http://www.gnu.org/software/make/manual/make.html"))
"Alist of documents generated from texinfo source.
When converting info links to html, links to any one of these manuals are
converted to use these URL's.")
(defun org-info-map-html-url (filename)
"Given info FILENAME, either return it (plus '.html' suffix added) or convert
it to URL pointing to the official page on internet, e.g., use gnu.org for all
emacs related documents. See `org-info-official-gnu-document' and
`org-info-other-documents' for details."
(if (member filename org-info-emacs-documents)
(format "http://www.gnu.org/software/emacs/manual/html_mono/%s.html"
filename)
(let ((url (cdr (assoc filename org-info-other-documents))))
(or url (concat filename ".html")))))
org-info: Correctly export info links to HTML * lisp/org-info.el (org-info-export): New function. Reported-by: Richard Y. Kim <emacs18@gmail.com> <http://permalink.gmane.org/gmane.emacs.orgmode/96779>
2015-04-10 08:38:06 +00:00
(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")))
org-info.el: Generate HTML links to gnu.org * lisp/org-info.el (org-info-export): Convert info links to HTML URL's that point to appropriate gnu.org or other pages. User's can customize the behavior using `org-info-emacs-documents' and `org-info-other-documets' new variables. TINYCHANGE
2016-03-10 14:29:48 +00:00
(format "<a href=\"%s#%s\">%s</a>"
(org-info-map-html-url filename)
org-info: Correctly export info links to HTML * lisp/org-info.el (org-info-export): New function. Reported-by: Richard Y. Kim <emacs18@gmail.com> <http://permalink.gmane.org/gmane.emacs.orgmode/96779>
2015-04-10 08:38:06 +00:00
(replace-regexp-in-string " " "-" node)
(or desc path)))))
Moved most of the linking code to separate files. This files are stil all loaded automatically, but the user can turn individual files off. Also, this makes maintaining the link stuff easier, because everything related to a specific link type is in one place.
2008-03-14 17:22:03 +00:00
(provide 'org-info)
;;; org-info.el ends here
Copy Permalink