[erlang-questions] bad links in OTP Design Principles html doc

Raimo Niskanen raimo+erlang-questions@REDACTED
Thu Sep 13 15:39:35 CEST 2007

Sorry about you not getting an answer before. I forwarded it to
the concerned, they identified the problem but who should
reply was forgotten.

The problem is that there is a script that goes through the documentation
and rewrites links to create the version independent documentation.
That script assumed a flat namespace for the .html pages. For gen_server
there is both a module documentation and a design principles documentation
page with the same basename.

It is easier to change the name of the design principles document
than to make the rewriting script aware of manual sections (separating 
namespaces), so that is what we will do, but it will have to wait
to the next release, that is R12B during this autumn.

On Mon, Sep 10, 2007 at 06:07:26PM -0600, Michael FIG wrote:
> I sent this a couple of times to webmaster@REDACTED, but they haven't corrected it yet.
> Could somebody please correct the links in the table of contents for OTP Design Principles?
> In: http://www.erlang.org/doc/design_principles/part_frame.html
> the entire chapter on the Gen_server behaviour incorrectly links to doc/man/gen_server.html
> instead of doc/design_principles/gen_server.html
> This can be quite confusing, and naive readers would not have the benefit of the excellent examples and high-level overview of gen_server.
> Please fix this soon.  If I don't hear anything back in the next few days, I'll try investigating the document source and writing a patch for the incorrect table of contents.
> Thanks,
> -- 
> Michael FIG <fig@REDACTED>, PMP
> MarkeTel Multi-Line Dialing Systems, Ltd.
> Phone: (306) 359-6893 ext. 528
> _______________________________________________
> erlang-questions mailing list
> erlang-questions@REDACTED
> http://www.erlang.org/mailman/listinfo/erlang-questions


/ Raimo Niskanen, Erlang/OTP, Ericsson AB

More information about the erlang-questions mailing list