[erlang-questions] Erlang documentation cleanup (PREV: R13B01 modules, quick reference)

Mazen Harake mazen.harake@REDACTED
Tue Aug 11 09:29:16 CEST 2009


Ah!

Nope that is exactly what I wanted! Cheers!

/Mazen

Zoltan Lajos Kis wrote:
> They are usually in the form #function-arity, for example:
>
> http://www.erlang.org/doc/man/ets.html#first-1
> http://www.erlang.org/doc/man/ets.html#foldl-3
>
> Or did you mean something completely different?
>
> Zoltan.
>
>   
>> But there is no anchor to each function on a module page; which is what
>> I want.
>>
>> /Mazen
>>
>> Zoltan Lajos Kis wrote:
>>     
>>> The one the link leads to. There is a search box on the top left.
>>>
>>> Zoltan.
>>>
>>>
>>>       
>>>> What page are you looking at?
>>>>
>>>> /Mazen
>>>>
>>>> Zoltan Lajos Kis wrote:
>>>>
>>>>         
>>>>> You can give the search engine at gotapi a try
>>>>> (http://www.gotapi.com/erlang). It needs some fixes, but probably will
>>>>> do
>>>>> what you want.
>>>>>
>>>>> Anchors already exist in the documentation, in the non-xhtml style (<a
>>>>> name="anchor" />) .
>>>>>
>>>>> Regards,
>>>>> Zoltan.
>>>>>
>>>>>
>>>>>
>>>>>           
>>>>>> This brings up a subject I've been meaning to bring up for a while.
>>>>>> The
>>>>>> online documentation needs modernisation... A few things that come to
>>>>>> mind are:
>>>>>>
>>>>>> * Proper documentation search (please don't insult this by saying
>>>>>> Google... that's just stupid)
>>>>>> * Function overview in each module
>>>>>> * Module summary on the modules page (and categorized) much like
>>>>>> http://docs.python.org/3.1/library/index.html
>>>>>> * Add anchors to the HTML so that a link can go straight to a
>>>>>> function
>>>>>> * Make HTML XHTML
>>>>>> * More visually appealing. Probably this won't go very well with
>>>>>> old-timers but frankly I have spoken to beginners in Erlang that say
>>>>>> that when looking at the documentation it looks like something
>>>>>> created
>>>>>> 20 years ago and it doesn't look very... well... "appealing". The
>>>>>> fact
>>>>>> they are right about the age is not the point now is it ;) ?
>>>>>>
>>>>>> Probably many more issues exist.... just saying.
>>>>>>
>>>>>> /Mazen
>>>>>>
>>>>>>
>>>>>> Dave Pawson wrote:
>>>>>>
>>>>>>
>>>>>>             
>>>>>>> http://www.dpawson.co.uk/erlang/qr.txt
>>>>>>>
>>>>>>> I did it for my own reference.
>>>>>>> I use this, then open an appropriate
>>>>>>> http://erlang.org/doc/man_index.html  page
>>>>>>> for details.
>>>>>>>
>>>>>>> Feedback appreciated.
>>>>>>>
>>>>>>> regards
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>               
>>>>>> ________________________________________________________________
>>>>>> erlang-questions mailing list. See http://www.erlang.org/faq.html
>>>>>> erlang-questions (at) erlang.org
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>             
>>>>>           
>>>> ________________________________________________________________
>>>> erlang-questions mailing list. See http://www.erlang.org/faq.html
>>>> erlang-questions (at) erlang.org
>>>>
>>>>
>>>>
>>>>         
>>>
>>>       
>>     
>
>
>   



More information about the erlang-questions mailing list