For Programmers: Free Programming Magazines  


Home > Archive > PHP Documentation > August 2007 > #41427 [Asn->Fbk]: creating all sub pages, and putting in TOC









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author #41427 [Asn->Fbk]: creating all sub pages, and putting in TOC
bjori@php.net

2007-08-24, 8:00 am

ID: 41427
Updated by: bjori@php.net
Reported By: betz@php.net
-Status: Assigned
+Status: Feedback
Bug Type: Documentation problem
Operating System: irrelevant
PHP Version: Irrelevant
Assigned To: bjori
New Comment:

This is how the chunking rules are.
It was originally a bug in Docbook-DSSSL that got fixed when we
switched to Docbook-XSL.

The first <sect1>/<section> is a "section information" element which is
not supposed to be added to the TOC, just like index.php doesn't create
a link to itself in the TOC.

Furthermore, its totally inconsistent with the rest of the TOCs.
When you are browsing php.net/in_array, do you expect the "Array
introduction" to be the top most link in the TOC?

Wrapping that first <simpara /> inside a <sect1/> will create a new
chunk, control-structures.if.php, out of the "if" page and therefore add
it to the TOC.

With that said. Shouldn't we fix our sources rather than adding crazy
workarounds to otherwise clean and relatively-dirty-workaround-free
PhD?

-Hannes


Previous Comments:
------------------------------------------------------------------------

[2007-08-24 05:10:28] philip@php.net

I nominate the new build system (PhD) to perform this task so...
assigning to bjori :)

This bug tackles two issues:

1) Generate the separate page, for example create:

http://php.net/manual/en/control-structures.if.php

2) Link to it within the navigation pane, as explained here by others.

We could instead simply link to the root page but I (like tularis)
prefer having the separate page created so that it'll be a permanent
link whereas the root page content may change. So yes, we'll have
duplicate information in these cases but that's fine.



------------------------------------------------------------------------

[2007-05-18 11:27:21] rquadling@php.net

Yes. The use different XSL files. Just mentioning that the there is at
least one of them that is correct.



------------------------------------------------------------------------

[2007-05-18 11:09:24] betz@php.net

Hm, to be clear: I am talking about the online manual ;-)

------------------------------------------------------------------------

[2007-05-18 10:32:12] rquadling@php.net

The "if" page IS in the index in the Extended CHM manual.

------------------------------------------------------------------------

[2007-05-18 09:16:32] tularis@php.net

It's all gotten from splitting the same file on <sect1>'s. It seems
like the first (if in this case) is appended to the original TOC-page
while only the remainders are split off. IMO it should be split off too.
Unfortunately, I don't know enough of the phpdoc internal build process
to know how to do this... I'll have a look at it later, but maybe one of
the build-masters have any ideas on this?

------------------------------------------------------------------------

The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at
http://bugs.php.net/41427

--
Edit this bug report at http://bugs.php.net/?id=41427&edit=1
Sponsored Links







Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive

Copyright 2008 codecomments.com