edoc - how to set up links?

Ulf Wiger (AL/EAB) <>
Fri Sep 16 11:58:37 CEST 2005


I've attached a diff for edoc_lib.erl that at 
least finds the OTP documentation using the 
code path. Don't know what to do about the /
in the relative part, though.

It should be backward compatible. I added the 
option 'ref_any_html' (default 'false'). 
I'm not particularly proud of the name.
It finds the OTP html pages, but doesn't jump
to the right function.

/Uffe

> -----Original Message-----
> From: Richard Carlsson [mailto:]
> Sent: den 16 september 2005 10:55
> To: Ulf Wiger (AL/EAB)
> Cc: Björn Gustavsson; 
> Subject: Re: edoc - how to set up links?
> 
> 
> Ulf Wiger (AL/EAB) wrote:
> > Richard Carlsson wrote:
> >>  1> edoc:application(kernel).
> >>  2> edoc:application(stdlib).
> >>  3> ...
> >>
> >>(Then have a look in lib/<app-dir>/doc/.)
> > 
> > I would very much prefer that the links point to 
> > the existing HTML docs, as regards OTP.
> 
> Me too, but the mapping is not so simple. E.g., the current URL for
> the lists:zip/2 function is:
>   
> http://erlang.se/doc/doc-5.4.8/lib/stdlib-1.13.8/doc/html/list
s.html#zip/2

Maybe OTP can be persuaded to set up some links in the tree, so that at
least http://erlang.se/doc/doc/lib/stdlib/doc/html/lists.html#zip/2 always
works regardless of the current version?

(By the way, I'm not sure it's a great idea to use / in the last fragment.)

	/Richard
-------------- next part --------------
A non-text attachment was scrubbed...
Name: edoc_lib.erl.diff
Type: application/octet-stream
Size: 4888 bytes
Desc: edoc_lib.erl.diff
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20050916/7e08c39c/attachment.obj>


More information about the erlang-questions mailing list