trapexit.org is moving
ke han
ke.han@REDACTED
Mon Jun 19 19:58:43 CEST 2006
Its my understanding that most/all the erlang docs use docbook. The
mySQL site's documentation also uses docbook and they have a very
clean structure which allows user comments per page.
Perhaps someone from the mySQL team is willing to share the methods/
tools they use to produce this online doc??
expert from http://dev.mysql.com/doc/refman/5.0/en/manual-info.html
<snip>
The Reference Manual source files are written in DocBook XML
format. The HTML version and other formats are produced
automatically, primarily using the DocBook XSL stylesheets. For
information about DocBook, see http://docbook.org/
The DocBook XML sources of this manual are available from http://
dev.mysql.com/tech-resources/sources.html. You can check out a copy
of the documentation repository with this command:
svn checkout http://svn.mysql.com/svnpublic/mysqldoc/
If you have any suggestions concerning additions or corrections to
this manual, please send them to the documentation team at
<docs@REDACTED>.
</snip>
ke han
On Jun 20, 2006, at 12:35 AM, Michael Leonhard wrote:
> I think it's a great idea to put the Erlang docs into a Wiki.
> Searching documentation is the biggest annoyance for new Erlang users.
> We need documentation that has no frames. A wiki would allow people
> to correct typos and add missing details and examples. Of course
> there will be the question of which documentation is authoritative.
> Ideally, the Erlang development team would put up the wiki on
> Erlang.org and update it along with each release. The release could
> include HTML docs generated from the wiki.
>
> This would also be great for Jungerl. It would also be great to
> package the docs in a MS Help file for offline searching.
>
> -Michael
>
> Michael Leonhard
> http://tamale.net/
> michael206@REDACTED
>
> On 6/9/06, Yariv Sadan <yarivvv@REDACTED> wrote:
>> >
>> > This just shows that creating a community doesnt mean one create
>> > a technical solution and then the people will come.
>>
>> I think there needs to be a "critical mass" of content before enough
>> people start using it... I was thinking that taking all official
>> Erlang docs, dumping them into a wiki (wikimedia would be nice), and
>> setting up a community site around it would be effective. However,
>> I'm
>> pretty sure somebody mentioned there are license restrictions with
>> this documentation.
>>
>> Cheers,
>> Yariv
More information about the erlang-questions
mailing list