Emacs manual URL citations for use in mail

Emacs manual URL citations for use in mail

[reader]

I know there is a format one can use to cite a section of the emacs
manual inside mail or a post, but could not find that format in the
emacs manual with a few (possibly badly aimed) regex searches.

Can someone aim me at the section that describes the format of those
URL type citations of the m?

Re: Emacs manual URL citations for use in mail

[Reiner Steib]

On Wed, Jun 11 2008, reader@newsguy.com wrote:

> I know there is a format one can use to cite a section of the emacs
> manual inside mail or a post, but could not find that format in the
> emacs manual with a few (possibly badly aimed) regex searches.

Does this help?

,----[ <f1> f rs-info-insert-current-node RET ]
| rs-info-insert-current-node is an interactive Lisp function in `rs-info'.
| (rs-info-insert-current-node style &optional noinsert)
| 
| Insert reference to current Info node using style in buffer.
| 
| If noinsert (the prefix), return the string instead.
| 
| Possible styles (must be a symbol):
| - `emacs' (Emacs style): (info "(file)node")
| - `emacs-press': as `emacs' plus a note about `C-x C-e'
| - `emacs-keys-goto' (Emacs key sequence): `C-h i g (file)node RET'
| - `emacs-keys-menu' (Emacs menu key sequence): `C-h i d m file RET m node RET'
| - `custom-manual': ":link '(custom-manual "(file)node")" for `defcustom'
| - `info-link': ":link '(info-link "(file)node")" for `defcustom'
| - `texinfo-ref-full': A full "@ref{...}" for Texinfo
| - `texinfo-ref': "@ref{...}" for Texinfo within the same file
| - `gnus' (the Gnus home brewed style): <info://foo/bar+baz> (deprecated)
| - `gnome' (GNOME style): <info:foo#bar_baz>
| - `kde' (KDE style): <info:(foo)bar baz>
| - `konqueror' (Konqueror style): <info:/foo/bar baz>
| 
| When used interactively, the default is taken from `rs-info-style-alist'.
| 
| For `emacs' and `emacs-press' style see the variable
| `rs-info-goto-node-string'.
`----

See:
;; rs-info.el -- Some info related functions
;; Author: Reiner Steib <Reiner.Steib@gmx.de>
;; Keywords: info
;; X-URL: http://theotp1.physik.uni-ulm.de/~ste/comp/emacs/misc/rs-info.el

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Emacs manual URL citations for use in mail

[reader]

Reiner Steib <reinersteib+gmane@imap.cc> writes:

> On Wed, Jun 11 2008, reader@newsguy.com wrote:
>
>> I know there is a format one can use to cite a section of the emacs
>> manual inside mail or a post, but could not find that format in the
>> emacs manual with a few (possibly badly aimed) regex searches.
>
> Does this help?
>
> ,----[ <f1> f rs-info-insert-current-node RET ]
> | rs-info-insert-current-node is an interactive Lisp function in `rs-info'.
> | (rs-info-insert-current-node style &optional noinsert)
> | 
> | Insert reference to current Info node using style in buffer.
> | 
> | If noinsert (the prefix), return the string instead.
> | 
> | Possible styles (must be a symbol):
> | - `emacs' (Emacs style): (info "(file)node")
> | - `emacs-press': as `emacs' plus a note about `C-x C-e'
> | - `emacs-keys-goto' (Emacs key sequence): `C-h i g (file)node RET'
> | - `emacs-keys-menu' (Emacs menu key sequence): `C-h i d m file RET m node RET'
> | - `custom-manual': ":link '(custom-manual "(file)node")" for `defcustom'
> | - `info-link': ":link '(info-link "(file)node")" for `defcustom'
> | - `texinfo-ref-full': A full "@ref{...}" for Texinfo
> | - `texinfo-ref': "@ref{...}" for Texinfo within the same file
> | - `gnus' (the Gnus home brewed style): <info://foo/bar+baz> (deprecated)
> | - `gnome' (GNOME style): <info:foo#bar_baz>
> | - `kde' (KDE style): <info:(foo)bar baz>
> | - `konqueror' (Konqueror style): <info:/foo/bar baz>
> | 
> | When used interactively, the default is taken from `rs-info-style-alist'.
> | 
> | For `emacs' and `emacs-press' style see the variable
> | `rs-info-goto-node-string'.
> `----
>
> See:
> ;; rs-info.el -- Some info related functions
> ;; Author: Reiner Steib <Reiner.Steib@gmx.de>
> ;; Keywords: info
> ;; X-URL: http://theotp1.physik.uni-ulm.de/~ste/comp/emacs/misc/rs-info.el


Reiner, thanks.. lots of info there... sorry to be so dense but I'm
still not getting how these urls are generated.  Is it only done
manually? That is, one simply types out the url (info "(file)node") By
reading the top of an info page?

Trying a few of those using something like:
    M-x rs-info-insert-current-node 
or
    M-x rs-info-goto-node-string
Just shows no-match while inside info.



Evans Winner <thorne@timbral.net> writes:

> reader@newsguy.com writes:
>
>     I know there is a format one can use to cite a section
>     of the emacs manual inside mail or a post, but could not
>     find that format in the emacs manual with a few
>     (possibly badly aimed) regex searches.
>  
>     Can someone aim me at the section that describes the
>     format of those URL type citations of the m?
>
> I am not sure about a reference to that, but maybe you mean
> things like this --
>
>     (info "(cl)Assertions")
>
> -- which can be evaluated inside Emacs and will start info
> in the ``cl'' section, in the subsection ``Assertions,'' for
> instance.  It is sort of an odd syntax, I suppose.

Yes, thats the one.  Can that be generated somehow or do we have to
type it out while referencing those elements on the top of an info
page? 

Re: Emacs manual URL citations for use in mail

[William Xu]

reader@newsguy.com writes:

> Is it only done manually? 

I do.  Maybe Reiner's method will be faster.  

> That is, one simply types out the url (info "(file)node") By reading
> the top of an info page?

There is a commmand for killing/copying current title in *info* buffer,
namely "c":

,----
| c runs the command Info-copy-current-node-name
|   which is an interactive compiled Lisp function in `info.el'.
| It is bound to w, c, <menu-bar> <Info> <Copy Node Name>.
| (Info-copy-current-node-name &optional arg)
| 
| Put the name of the current Info node into the kill ring.
| The name of the Info file is prepended to the node name in parentheses.
| With a zero prefix arg, put the name inside a function call to `info'.
`----

-- 
William

http://williamxu.net9.org

<taniwha> Knghtbrd: we should do a quake episode :knee deep in the code":
          you run around shooting at bugs:)
<Knghtbrd> taniwha: I'll pass the idea on to OpenQuartz  ;>

Re: Emacs manual URL citations for use in mail

[Reiner Steib]

On Fri, Jun 13 2008, reader@newsguy.com wrote:

> Reiner, thanks.. lots of info there... sorry to be so dense but I'm
> still not getting how these urls are generated.  

[ Internally, they are constructed using the values of
`Info-current-file' and `Info-current-node' in the info mode buffer. ]

> Is it only done manually? That is, one simply types out the url
> (info "(file)node") By reading the top of an info page?
>
> Trying a few of those using something like:
>     M-x rs-info-insert-current-node 

The doc string says "Insert reference to current Info node [...] in
buffer".  Inserting something in info mode should just signal an error
("Buffer is read-only").  The typical use case is:

- Navigate to the manual node in question

- Go (back) to the other buffer (mail buffer, ...) where you want to
  place the reference.

- Do `M-x rs-info-insert-current-node RET'

> or
>     M-x rs-info-goto-node-string
> Just shows no-match while inside info.

`rs-info-goto-node-string' is a variable, not a command.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Emacs manual URL citations for use in mail

[reader]

Reiner Steib <reinersteib+gmane@imap.cc> writes:

> - Navigate to the manual node in question
>
> - Go (back) to the other buffer (mail buffer, ...) where you want to
>   place the reference.
>
> - Do `M-x rs-info-insert-current-node RET'

All I get is M-x rs-info<spc> NO MATCH

Thanks I see how it works now but apparently I have to `require'
rs-info first or should it just be loaded when info is accessed?

Without M-x load-library rs-info  it doesn't work here with just info
and gnus loaded normally.

Re: Emacs manual URL citations for use in mail

[Reiner Steib]

On Wed, Jun 18 2008, reader@newsguy.com wrote:

> Reiner Steib <reinersteib+gmane@imap.cc> writes:
[...]
>> - Do `M-x rs-info-insert-current-node RET'
>
> All I get is M-x rs-info<spc> NO MATCH
>
> Thanks I see how it works now but apparently I have to `require'
> rs-info first or should it just be loaded when info is accessed?
>
> Without M-x load-library rs-info  it doesn't work here with just info
> and gnus loaded normally.

`rs-info.el' is not included in Emacs.  If you like to use, you need
to download if from the URL posted previously:

;; X-URL: http://theotp1.physik.uni-ulm.de/~ste/comp/emacs/misc/rs-info.el

Installation instructions are included in the file.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: Emacs manual URL citations for use in mail

[Evans Winner]

reader@newsguy.com writes:

    Yes, thats the one.  Can that be generated somehow or do
    we have to type it out while referencing those elements
    on the top of an info page?

Maybe something like this would work (below).  It's quick
and dirty but seems to work.  Maybe there's already the same
functionality somewhere.  It seems like an obvious feature
and I see people posting links of this form all the time.


(defun Info-make-evalable-link ()
  "Make a link to the current Info node and add it to the kill ring.
Point must be in the Info buffer.  Produces a string of the form:
\(info \"\(file\)node\"\) that can be yanked info a buffer and
evaluated."
  (interactive)
  (kill-new
   (let ((file (if (stringp Info-current-file)
		   (file-name-nondirectory Info-current-file)
		 " "))
	 (node (if (stringp Info-current-node)
		   Info-current-node
		 " ")))
     (concat "(info \"(" file "\)" node "\")"))))

Re: Emacs manual URL citations for use in mail

[reader]

Evans Winner <thorne@timbral.net> writes:

> Maybe something like this would work (below).  It's quick
> and dirty but seems to work.  Maybe there's already the same
> functionality somewhere.  It seems like an obvious feature
> and I see people posting links of this form all the time.

Yes, that is nice.  
From Reiners post you can see that rs-info.el provides this
functionality or at least the same result.

But apparently it is not automatically loaded when info is accessed
with out a require or similar.
Thanks.

Re: Emacs manual URL citations for use in mail

[Evans Winner]

reader@newsguy.com writes:

    I know there is a format one can use to cite a section
    of the emacs manual inside mail or a post, but could not
    find that format in the emacs manual with a few
    (possibly badly aimed) regex searches.
 
    Can someone aim me at the section that describes the
    format of those URL type citations of the m?

I am not sure about a reference to that, but maybe you mean
things like this --

    (info "(cl)Assertions")

-- which can be evaluated inside Emacs and will start info
in the ``cl'' section, in the subsection ``Assertions,'' for
instance.  It is sort of an odd syntax, I suppose.