org-elisp-help　20161121.1655(in MELPA)
org links to emacs-lisp documentation

概要

org-elisp-help.el は、2つの新しいorg-modeのハイパーリンクを提供します。
elisp-functionとelisp-variableはそれぞれ関数と変数へのリンクです。

たとえば、M-x find-fileへのリンクはこのように記述します。

elisp-function::find-file
[[elisp-function::find-file]]
[[elisp-function::find-file][link to find-file]]

外部ライブラリを読み込む必要がある場合は、このように記述します。
たとえばorg-drill-entry-statusはorg-drill.elに定義されています。

elisp-function:org-drill:org-drill-entry-status
[[elisp-function:org-drill:org-drill-entry-status]]
[[elisp-function:org-drill:org-drill-entry-status][link to org-drill-entry-status]]

変数についても同様です。

elisp-variable::auto-mode-alist
[[elisp-variable::auto-mode-alist][link to auto-mode-alist]
[[elisp-variable:org-drill:org-drill-card-type-alist]]

リンクをたどると、関数・変数の説明(describe-function/describe-variable)が表示されます。

なお、org-plus-contrib に含まれている org-elisp-symbol.el にも elisp-symbol リンクが定義されています。

インストール

パッケージシステムを初めて使う人は
以下の設定を ~/.emacs.d/init.el の
先頭に加えてください。

(package-initialize)
(setq package-archives
      '(("gnu" . "http://elpa.gnu.org/packages/")
        ("melpa" . "http://melpa.org/packages/")
        ("org" . "http://orgmode.org/elpa/")))

初めてorg-elisp-helpを使う方は
以下のコマンドを実行します。

M-x package-install org-elisp-help

アップグレードする方は、
以下のコマンドでアップグレードしてください。
そのためにはpackage-utilsパッケージが必要です。

M-x package-install package-utils (初めてアップグレードする場合のみ)
M-x package-utils-upgrade-by-name org-elisp-help

関数・変数定義にジャンプするようにカスタマイズする

定義にジャンプするようにカスタマイズできます。

変数 org-elisp-help-function-open-function で関数へのリンクを、
変数 org-elisp-help-variable-open-function で変数へのリンクを
find-function/find-variable系列に変更できます。

;;; 関数定義
;; 現在のウィンドウ
(setq org-elisp-help-function-open-function 'find-function)
;; 別ウィンドウ
(setq org-elisp-help-function-open-function 'find-function-other-window)
;; 別フレーム
(setq org-elisp-help-function-open-function 'find-function-other-frame)

;;; 変数定義も同様
(setq org-elisp-help-variable-open-function 'find-variable)
(setq org-elisp-help-variable-open-function 'find-variable-other-window)
(setq org-elisp-help-variable-open-function 'find-variable-other-frame)


本日もお読みいただき、ありがとうございました。参考になれば嬉しいです。