Re: Docstrings - referring to external resources

["Dale P. Smith" <dpsm at en dot com>]

Julian Satchell wrote:
> 
> I am working my way through adding docstrings to xguile. In many cases I
> find I want to refer to specific man pages for more detailed
> explanations. It is a reasonable guess that if somebody is developing
> for X, they will have the X and Xt man pages around.
> 
> At present I just tell them to look at the man pages, but wonder if
> using a url in the style say of the gnome help system would be a
> sensible extension (My own guile/XmHTML based help browser also
> understands this). So rather than saying "See the man page for XCreateGC
> for more detail", I suggest putting in "See the man page
> @url{man:XCreateGC(3x)} for detail". This can be processed to fit
> different back ends by some unknown future method.
> 
> In the same vein using urls like @url{info:r4rs#conditionals} would
> allow us to cross reference to background information in info format
> that may be needed in places.

try: "info texinfo uref" and "info texinfo url"

 -Dale

-- 
Dale P. Smith
Altus Technologies Corp.
dsmith@altustech.com
400-746-9000 x309