[erlang-questions] online documentation

[Raimo Niskanen]

On Wed, Dec 02, 2009 at 03:08:05AM -0800, Jayson Vantuyl wrote:
> When I searched for a fully qualified function (i.e. ets:new), it seemed to have an issue URL-decoding the colon, and the search generally didn't like it even when manually adjusted on the next page.  Nice start, though.

Currently it searches for names anywhere (functions, modules and applications),
so you can search for `ets', follow to the ets man page and then
scroll down to the `new' function.

Or you can search for `new'.

You can also search for `ets new', which oddly enough
does not give ets:new higher ranking than any other
Whatever:new function...

It sounds like a very nice idea that either `ets:new' or
`ets new' would give higher ranking for a hit on both
module and function (and application). I will forward
the idea to the developers (hope they read this too).

> 
> On Dec 2, 2009, at 2:55 AM, Raimo Niskanen wrote:
> 
> > On Fri, Nov 27, 2009 at 03:15:03PM +0100, Kenneth Lundin wrote:
> >> Hi Vlad,
> >> 
> >> A search facility will come , we will create an index
> >> for this purpose as part of the docbuilding process.
> >> 
> >> No need to patch the docbuilder application.
> >> 
> >> /Kenneth Erlang/OTP Ericsson
> > 
> > There is a preliminary version of the search facility
> > now running on the (perliminary) demo site:
> > Go to http://demo.erlang.org/doc.html and type e.g "keyse"
> > in the text field in the grey right column, then click the
> > looking glass button... Comments are welcome.
> > 
> > The same search application should eventually be
> > possible to run via the OTP webtool application on
> > your local Erlang/OTP installation as a HTTP 
> > server on your local host.
> > 
> > / Raimo
> > 
> > 
> >> 
> >> On Fri, Nov 27, 2009 at 2:23 PM, Vlad Dumitrescu <vladdu55@REDACTED> wrote:
> >>> Hi!
> >>> 
> >>> I really like the looks of the new documentation.
> >>> 
> >>> There is a small thing that was suggested before and that would help a
> >>> lot: a search field (hopefully with autocompletion, too). Typing
> >>> "li<TAB>:keys" to go to lists:keysearch would be soooo sweet!...
> >>> 
> >>> I realize now that generating this is probably the job of the
> >>> docbuilder application, which would mean that I can probably submit a
> >>> patch myself (if I get to it). Will check that (but if someone else
> >>> has faster fingers, I won't hold a grudge :-).
> >>> 
> >>> BTW, a related question: I see that the issue tracker at github is
> >>> being used. What is the current policy for reporting bugs? It would be
> >>> nice if there was only a single place instead of three (some people
> >>> like me do post bug reports here instead of erlang-bugs anyway), for
> >>> example if the github tracker could send email notifications to
> >>> erlang-bugs.
> >>> 
> >>> best regards,
> >>> Vlad
> >>> 
> >>> ________________________________________________________________
> >>> 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
> > 
> > -- 
> > 
> > / Raimo Niskanen, Erlang/OTP, Ericsson AB
> > 
> > ________________________________________________________________
> > erlang-questions mailing list. See http://www.erlang.org/faq.html
> > erlang-questions (at) erlang.org
> > 
> 
> 
> 
> -- 
> Jayson Vantuyl
> kagato@REDACTED
> 
> 
> 
> 
> 

-- 

/ Raimo Niskanen, Erlang/OTP, Ericsson AB