[erlang-questions] erlang api documentation

Håkan Stenholm <>
Wed Oct 24 21:59:49 CEST 2007


Kenneth Lundin wrote:
> Hi again
>
> I have plans to improve the doc's in the direction you ask for.
> I am also considering using Javascript in a similar way as used in the
> previously
> mentioned http://gotapi.com.
> But I think it is still a requirement that the doc's can be downloaded
> and browsed
> locally without the need for having a web-server running. 
Being able to use the docs when the network is down is kind of useful ...

You might also want to consider keeping the docs print friendly,
so that one can easily print various chapters and module documents.
> I think it
> would be ok to
> require a browser with javascript capabilities (we already require
> javascript when it
> comes to links between applications)
>
> The suggested approach in summary:
> - Stop using frames, Use CSS instead for the layout
> - Nicer fonts
> - Use Javascript to achieve expandable tree view navigation to the left
> - Search as you type support (also with Javascript) similar as gotapi.com
> ...
>
>   
Sounds reasonable and useful.

> Any comments on this approach?
>
> /Kenneth Erlang/OTP team at Ericsson
>
> On 10/24/07, Frank Blecha <> wrote:
>   
>> Ah, apologies for not being more specific.  I've been a Java programmer for
>> last 10 years, and so I was asking specificaly about documentation that was
>> more like Sun produces (or even the Ruby docs).  For example, it's nice to
>> have a link to all the methods at the top of the class/module instead of
>> scrolling down etc.
>>
>> I have been able to find answers to my questions via the api, I just want to
>> find them faster.
>>
>> Thanks.
>>
>> - Frank
>>
>>
>>
>> On 10/24/07, Kenneth Lundin <> wrote:
>>     
>>> Hi Frank,
>>>
>>> Please explain what you mean with "hyper linked" version and why you don't
>>>       
>> as it
>>     
>>> seems, think that the available documentation on erlang.org
>>> http://erlang.org/doc/
>>>
>>> is hyperlinked?
>>>
>>> We are well aware of that the html format is not modern and that it
>>> would be good with better search facilities but I don't know if that
>>> is what you are after.
>>>
>>> /Kenneth Erlang/OTP team at Ericsson
>>>
>>> On 10/24/07, Frank Blecha <> wrote:
>>>       
>>>> Is there a hyper linked version out there somewhere?  I have been using
>>>>         
>> the
>>     
>>>> module docs from erlang.org, but a linked version would be a bit
>>>>         
>> handier.
>>     
>>>> Thanks.
>>>>
>>>> - Frank
>>>>
>>>> --
>>>> Frank Blecha
>>>>
>>>> _______________________________________________
>>>> erlang-questions mailing list
>>>> 
>>>> http://www.erlang.org/mailman/listinfo/erlang-questions
>>>>
>>>>         
>>
>> --
>> Frank Blecha
>>
>>     
> _______________________________________________
> erlang-questions mailing list
> 
> http://www.erlang.org/mailman/listinfo/erlang-questions
>
>   



More information about the erlang-questions mailing list