php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #41427 creating all sub pages, and putting in TOC
Submitted: 2007-05-18 08:30 UTC Modified: 2007-09-01 01:00 UTC
From: betz@php.net Assigned: bjori (profile)
Status: No Feedback Package: Documentation problem
PHP Version: Irrelevant OS: irrelevant
Private report: No CVE-ID: None
View Add Comment Developer Edit
Anyone can comment on a bug. Have a simpler test case? Does it work for you on a different platform? Let us know!
Just going to say 'Me too!'? Don't clutter the database with that please — but make sure to vote on the bug!
Your email address:
MUST BE VALID
Solve the problem:
22 + 19 = ?
Subscribe to this entry?

 
 [2007-05-18 08:30 UTC] betz@php.net
Description:
------------
if construct is shown on Table of Contents
http://www.php.net/manual/en/language.control-structures.php

However from the subpages, if is not listed in the right navigation pane. (e.g.: http://www.php.net/manual/en/control-structures.for.php)



Expected result:
----------------
if should be listed on the right navigation pane.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2007-05-18 09:16 UTC] 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?
 [2007-05-18 10:32 UTC] rquadling@php.net
The "if" page IS in the index in the Extended CHM manual.
 [2007-05-18 11:09 UTC] betz@php.net
Hm, to be clear: I am talking about the online manual ;-)
 [2007-05-18 11:27 UTC] rquadling@php.net
Yes. The use different XSL files. Just mentioning that the there is at least one of them that is correct.


 [2007-08-24 05:10 UTC] 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-08-24 08:28 UTC] bjori@php.net
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
 [2007-09-01 01:00 UTC] phpdoc at lists dot php dot net
No feedback was provided for this bug for over a week, so it is
being suspended automatically. If you are able to provide the
information that was originally requested, please do so and change
the status of the bug back to "Open".
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Thu Mar 28 13:01:28 2024 UTC