all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Juri Linkov'" <juri@jurta.org>
Cc: emacs-devel@gnu.org
Subject: RE: adding manual cross-ref links to *Help*
Date: Tue, 14 Jun 2011 11:11:49 -0700	[thread overview]
Message-ID: <75746CA9510E4927940436FA1F4E066A@us.oracle.com> (raw)
In-Reply-To: <87mxhk1fuq.fsf@mail.jurta.org>

[-- Attachment #1: Type: text/plain, Size: 223 bytes --]

> Thanks, I'll look into this.

BTW, to make this feature complete, you will also want to add the attached patch
of `help.el', for `describe-mode'.  It adds links to manuals for each of the
modes described (major & minor).

[-- Attachment #2: help-2011-06-14.patch --]
[-- Type: application/octet-stream, Size: 2045 bytes --]

diff -c -w help.el help-patched-2011-06-14.el
*** help.el	Tue Jun 14 11:07:36 2011
--- help-patched-2011-06-14.el	Tue Jun 14 11:09:18 2011
***************
*** 852,858 ****
  				     "no indicator"
  				   (format "indicator%s"
  					   indicator))))
! 		  (princ (documentation mode-function)))
  		(insert-button pretty-minor-mode
  			       'action (car help-button-cache)
  			       'follow-link t
--- 852,859 ----
                                       "no indicator"
                                     (format "indicator%s"
                                             indicator))))
!                   (princ (documentation mode-function))
!                   (Info-make-manuals-xref mode-function t)) ; Link to manuals.
                  (insert-button pretty-minor-mode
                                 'action (car help-button-cache)
                                 'follow-link t
***************
*** 880,890 ****
  		(re-search-backward "`\\([^`']+\\)'" nil t)
  		(help-xref-button 1 'help-function-def mode file-name)))))
  	(princ ":\n")
! 	(princ (documentation major-mode)))))
    ;; For the sake of IELM and maybe others
    nil)
  
- 
  (defun describe-minor-mode (minor-mode)
    "Display documentation of a minor mode given as MINOR-MODE.
  MINOR-MODE can be a minor mode symbol or a minor mode indicator string
--- 881,893 ----
                  (re-search-backward "`\\([^`']+\\)'" nil t)
                  (help-xref-button 1 'help-function-def mode file-name)))))
          (princ ":\n")
!         (princ (documentation major-mode))
!         (let ((maj  major-mode))
!           (with-current-buffer standard-output
!             (Info-make-manuals-xref maj t)))))) ; Link to manuals.
    ;; For the sake of IELM and maybe others
    nil)
  
  (defun describe-minor-mode (minor-mode)
    "Display documentation of a minor mode given as MINOR-MODE.
  MINOR-MODE can be a minor mode symbol or a minor mode indicator string

Diff finished.  Tue Jun 14 11:10:14 2011

      reply	other threads:[~2011-06-14 18:11 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-06-11 15:57 adding manual cross-ref links to *Help* Drew Adams
2011-06-11 18:07 ` Juri Linkov
2011-06-13 21:01   ` Drew Adams
2011-06-14 17:29     ` Juri Linkov
2011-06-14 18:11       ` Drew Adams [this message]

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=75746CA9510E4927940436FA1F4E066A@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=juri@jurta.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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.