[erlang-questions] online documentation

Dale Harvey <>
Thu Dec 3 17:55:30 CET 2009


2009/12/3 Raimo Niskanen
<<raimo%>
>

> On Thu, Dec 03, 2009 at 03:03:18PM +0000, Dale Harvey wrote:
> > There is a few files modules (egd / nif) that generate the documentation
> > source from the .erl source files and edoc, those are the ones missing
> >
> > (erlapi and erldocs were both built before the ability to build the docs
> in
> > otp was released)
> >
> > the 99% are built from the xml files in app/doc/src, Ive added it as an
> > issue on erldocs to fix.
> >
> > There are other things missing, primarily application chapters / user
> > guides, these require a lot more fudging to get into a format thats
> usable
> > considering the different layouts.
>
>
I actually lied, nif is documented as a library not a module, but egd wasnt
wasnt added to /doc/src/

either way they have both been added

http://erldocs.com/R13B03/erts/erl_nif.html?search=nif&i=0
http://erldocs.com/R13B03/percept/egd.html?search=egd&i=0


> To simplify for erldoc (and such) we have started to generate
> index files during the documentation build, and these .eix
> files are used as input by erldoc on the demo site. Since
> they are generated during build all problems with include
> files, .erl sources through edoc, and such, disappear.
>
> The .eix files will be in the normal documentation tarball
> beginning with the next minor release.
>
> For the eager to try you can currently find a supplementary
> tarball on the demo site:
>    http://demo.erlang.org/upload/otp_doc_eix_R13B03.tar.gz
>
> The format is not documented at all, it is just a file
> you can file:parse and get a term list sorting out
> module, application and documentation html tag, etc.
> We may change the format. Maybe it could be more
> general for other documentation search engines than erldoc...
>
> For what it is worth.
>
>
Thats awesome, thanks.


> >
> >
> >
> > 2009/12/3 Rapsey <>
> >
> > > Both http://erlapi.prepor.ru/docs/ and http://erldocs.com/R13B03/
> > > seem to be incomplete. Searching for erl_nif for instance has no
> results.
> > > Neither do they find any of the driver_* functions in erts.
> > >
> > >
> > > Sergej
> > >
> > >
> > > On Thu, Dec 3, 2009 at 2:22 PM, Dale Harvey <>
> wrote:
> > >
> > > > 2009/12/3 Raimo Niskanen
> > > > <<raimo%>
> <raimo%<raimo%>
> >
> > > <raimo%<raimo%>
> <raimo%<raimo%>
> >
> > > >
> > > > <raimo%<raimo%>
> <raimo%<raimo%>
> >
> > > <raimo%<raimo%>
> <raimo%<raimo%>
> >
> > > >
> > > > >
> > > > >
> > > >
> > > > > On Thu, Dec 03, 2009 at 01:21:23PM +0300, Dmitry Belyaev wrote:
> > > > > > I prefer
> > > > > > http://erlapi.prepor.ru/docs/
> > > > >
> > > > > Yet another nice one. This seems to be a problem
> > > > > that many want solutions for.
> > > > >
> > > >
> > > > Quite so, theres also mine :)
> > > >
> > > > http://erldocs.com/R13B03/
> > > >
> > > >
> > > > >
> > > > > It is also fast, but I can not readily find a quick
> > > > > way to search for a function name when I do not
> > > > > know the module. If I type "new" ets:new comes at least
> > > > > one page down and there is no possibility to filter
> > > > > for function names only.
> > > > >
> > > > > Another nice thing on this site is that you get
> > > > >  Application
> > > > >  Module:Function
> > > > >  Short description
> > > > > already in the search results.
> > > > >
> > > > > >
> > > > > > It scrolls to selected function and has pretty style.
> > > > > >
> > > > > > On Thu, 2009-12-03 at 10:45 +0100, Raimo Niskanen wrote:
> > > > > > > On Thu, Dec 03, 2009 at 11:53:18AM +0900, Ngoc Dao wrote:
> > > > > > > > This is an impressive improvement.
> > > > > > > >
> > > > > > > > Currently I am using gotapi, and its API is not the latest:
> > > > > > > > http://www.gotapi.com/erlang
> > > > > > >
> > > > > > > That is a really cool tool. Annoying that they call modules
> > > > > > > "class", but anyway impressive...
> > > > > > >
> > > > > > > This site sets a standard that erldoc should strive to
> > > > > > > reach, but with the latest documentation!
> > > > > > >
> > > > > > > >
> > > > > > > >
> > > > > > > > On Wed, Dec 2, 2009 at 8:20 PM, Raimo Niskanen
> > > > > > > > <<raimo%>
> <raimo%<raimo%>
> >
> > > <raimo%<raimo%>
> <raimo%<raimo%>
> >
> > > >
> > > > <raimo%<raimo%>
> <raimo%<raimo%>
> >
> > > <raimo%<raimo%>
> <raimo%<raimo%>
> >
> > > >
> > > > >>
> > > > > wrote:
> > > > > > > > > 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 <
> > > > > > 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
> > > > > > > > >> 
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >>
> > > > > > > > >
> > > > > > > > > --
> > > > > > > > >
> > > > > > > > > / Raimo Niskanen, Erlang/OTP, Ericsson AB
> > > > > > > > >
> > > > > > > > >
> > > ________________________________________________________________
> > > > > > > > > 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
> > > > > > > >
> > > > > > >
> > > > > >
> > > > > >
> > > > > >
> > > > > > ________________________________________________________________
> > > > > > 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
> > > > >
> > > > >
> > > >
> > >
>
> --
>
> / Raimo Niskanen, Erlang/OTP, Ericsson AB
>


More information about the erlang-questions mailing list