[ESS] Hyperlinks in help pages

Frede Aakmann Tøgersen FredeA.Togersen at agrsci.dk
Tue Mar 21 10:43:54 CET 2006



In both Emacs 21.3 and 22.0 I have tried following.

Start Emacs with command line option --no-init-file.

No variable ess-help-keys-alist yet defined.

In the *scratch* buffer evaluate each lisp expression

(add-to-list 'load-path "C:/cygwin/usr/local/ess-svn/lisp")
(require 'ess-site)
(setq-default inferior-R-program-name 
 	      "c:/Programmer/R/R-2.2.1/bin/Rterm.exe")

by doing C-M-x at each expression (ess-svn updated yesterday via subversion and thus the dev. version).

Now the variable ess-help-keys-alist is defined and set to nil.

Doing M-x R <return> launches Rterm in a *R* buffer as an inferior process.

Now doing C-h ess-help-keys-alist <return> opens a *Help* buffer with content:

	ess-help-sec-keys-alist is a variable defined in `ess-cust.el'.
	Its value is shown below.

	Documentation:
	Alist of (key . string) pairs for use in section searching.

	Value:
	((97 . "\\s *Arguments:")
	 (100 . "\\s *Description:")
	(68 . "\\s *Details:")
	(101 . "\\s *Examples:")
	(110 . "\\s *Note:")
	(114 . "\\s *References:")
	(115 . "\\s *See Also:")
	(117 . "\\s *Usage:")
	(118 . "\\s *Value[s]?"))

	ocal in buffer *R*; global value is 
	(97 . "\\s *Arguments:")
	(100 . "\\s *Description:")
	(68 . "\\s *Details:")
	(101 . "\\s *Examples:")
	(110 . "\\s *Note:")
	(114 . "\\s *References:")
	(115 . "\\s *See Also:")
	(117 . "\\s *Usage:")
	(118 . "\\s *Value[s]?"))

	utomatically becomes buffer-local when set in any fashion.

	[back]

C-c C-v prompts "Help on:" in the minibuffer. Typing lm <return> opens a new buffer with the help page for 'lm'. Typing s s (after an C-x o) does nothing in 21.3 but throws an error in 22.0 in the minibuffer: 's s is not defined'.

At this stage the *Messages* buffer contains:

(c:\Programmer\Emacs\emacs\bin\emacs.exe --no-init-file)
Loading encoded-kb...done
Adding c:/Programmer/Emacs/EmacsW32/lisp/ to load-path
For information about the GNU Project and its goals, type C-h C-p.
Mark set
Mark saved where search started
Mark set [2 times]
Mark activated
("C:/cygwin/usr/local/ess-svn/lisp" "c:/Programmer/Emacs/EmacsW32/lisp/" "c:/Programmer/Emacs/emacs/site-lisp" "c:/Programmer/Emacs/emacs/../site-lisp" "c:/Programmer/Emacs/emacs/lisp" "c:/Programmer/Emacs/emacs/lisp/calc" "c:/Programmer/Emacs/emacs/lisp/calendar" "c:/Programmer/Emacs/emacs/lisp/emacs-lisp" "c:/Programmer/Emacs/emacs/lisp/emulation" "c:/Programmer/Emacs/emacs/lisp/eshell" "c:/Programmer/Emacs/emacs/lisp/gnus" "c:/Programmer/Emacs/emacs/lisp/international" ...)
Loading regexp-opt...done
enabling speedbar support
ess-site
"c:/Programmer/R/R-2.2.1/bin/Rterm.exe"
Quit
Loading help-fns...done
next-history-element: Beginning of history; no preceding item
Loading pp...done
Type C-x 1 to remove help window.  
Type C-h m for help on ESS version 5.2.13
Cannot read history file c:/Documents and Settings/FAT/My Documents/fat/.Rhistory

and the *ESS* buffer:

[ess-site.el]: ess-customize-alist=nil 
[ess-site.el _2_]: ess-customize-alist=nil 
(R): ess-rterm-versions-create making M-x defuns for c:/progra~1/Rrw1091/bin/Rterm.exe c:/progra~1/Rrw2000/bin/Rterm.exe
(R): ess-dialect=nil, buf=*scratch*, start-arg=nil
 current-prefix-arg=nil
(inferior-ess 0): ess-start-args=--ess   
ess-setq-vars-default 0: ess-language=Initial, -dialect=nil, buf=nil, comint..echoes=nil, comint..sender=comint-simple-send
ess-setq-vars-default 1: ess-language=S, -dialect=R, buf=nil, comint..echoes=nil, comint..sender=comint-simple-send
(inf-ess 1): lang=S, dialect=R, tmp-dialect=R, buf=*scratch*
(inf-ess 1.1): procname=R temp-dialect=R, buf-name=*R* 
(inferior-ess) Method #3 start=c:/Documents and Settings/FAT/My Documents/fat/ buf=*R*
(ess-setq-vars-LOCAL): language=S, dialect=R, buf=nil, comint..echoes=nil, comint..sender=comint-simple-send
(inf-ess 2.1): ess-language=S, ess-dialect=R buf=*R* 
(inf-ess 2.2): start args = --ess  , inf-ess-start-args=--ess   
(inf-ess finish [S(R), c:/Programmer/R/R-2.2.1/bin/Rterm.exe(nil,nil)]
(ess-multi 0):  inf-ess-start-args=--ess  , comint-..echoes=nil
(i-ess 1): buf=*R*, lang=S, comint..echo=nil, comint..sender=comint-simple-send,
(i-ess 2): buf=*R*, lang=S, comint..echo=t, comint..sender=inferior-R-input-sender,
(ess-setq-vars-LOCAL): language=S, dialect=R, buf=nil, comint..echoes=t, comint..sender=inferior-R-input-sender
(i-ess 3): curr-buf=*R*, comint..echo=t, comint..sender=inferior-R-input-sender,
(ess-multi post inf-ess: start-args=--ess  , comint-echoes=t
(ess-multi 1):  start-args=--ess   
Making Process...Buf *R*, Proc R, Prog c:/Programmer/R/R-2.2.1/bin/Rterm.exe
 Start File=nil, Args= --ess  .
(R): inferior-ess-language-start=options(STERM='iESS', editor='gnuclient.exe')
(ess-setq-vars-LOCAL): language=S, dialect=R, buf=nil, comint..echoes=nil, comint..sender=comint-simple-send


Best regards

Frede Aakmann Tøgersen
Scientist


Danish Institute of Agricultural Sciences
Research Centre Foulum
Dept. of Genetics and Biotechnology
Blichers Allé 20, P.O. BOX 50
DK-8830 Tjele

Phone:   +45 8999 1900
Direct:  +45 8999 1878

E-mail:  FredeA.Togersen at agrsci.dk
Web:	   http://www.agrsci.org				

This email may contain information that is confidential.
Any use or publication of this email without written permission from DIAS is not allowed.
If you are not the intended recipient, please notify DIAS immediately and delete this email.


 

> -----Oprindelig meddelelse-----
> Fra: ess-help-bounces at stat.math.ethz.ch 
> [mailto:ess-help-bounces at stat.math.ethz.ch] På vegne af 
> Martin Maechler
> Sendt: 21. marts 2006 09:21
> Til: Kiermeier, Andreas
> Cc: ess-help at stat.math.ethz.ch
> Emne: Re: [ESS] Hyperlinks in help pages
> 
> >>>>> "AndrK" == Kiermeier, Andreas 
> <Kiermeier.Andreas at saugov.sa.gov.au>
> >>>>>     on Tue, 21 Mar 2006 09:24:09 +1030 writes:
> 
>     AndrK> Martin, two things for me (I guess they are the same
>     AndrK> as for several others):
> 
>     AndrK> 1) ss does nothing, in fact, I get a message saying
>     AndrK> that "s s is undefined".
> 
>     AndrK> 2) If I move down manually to summary.lm and press h
>     AndrK> I get the message "Help on:"
> 
> Yes. I understood;  and the same applies to Frede.
> But it means there's a considerable problem / bug in your 
> Emacs/ESS setup.
> 
> The help-mode section commands are governed by the variable
>   ess-help-sec-keys-alist
> 
> This should be 'nil' after starting Emacs and should become 
> [C-h v ess-help-sec-keys-alist]
> 
>   >> ess-help-sec-keys-alist's value is shown below.
>   >>
>   >> Documentation:
>   >> Alist of (key . string) pairs for use in section searching.
>   >>
>   >> Defined in `ess-cust'.
>   >>
>   >> Value:
>   >> ((97 . "\\s *Arguments:")
>   >>  (100 . "\\s *Description:")
>   >>  (68 . "\\s *Details:")
>   >>  (101 . "\\s *Examples:")
>   >>  (110 . "\\s *Note:")
>   >>  (114 . "\\s *References:")
>   >>  (115 . "\\s *See Also:")
>   >>  (117 . "\\s *Usage:")
>   >>  (118 . "\\s *Value[s]?"))
> 
> after M-x R
> (M-x S or M-x S+ or ...
>  will define a different list, since the S-plus help  pages 
> look a bit different).
> 
> ---
> 
> I guess something is badly wrong in your emacs initialization 
> if you don't get the above; but I don't know.
> Could it be that you are accidentally mixing two different 
> installations of ESS, e.g. one that ``comes with your system''
> and one that you set up yourself?
> 
>     AndrK> Andreas
> 
> ______________________________________________
> ESS-help at stat.math.ethz.ch mailing list
> https://stat.ethz.ch/mailman/listinfo/ess-help
> 
>




More information about the ESS-help mailing list