php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #48707 File php_manual_notes.chm not available on site
Submitted: 2009-06-27 15:15 UTC Modified: 2011-06-06 14:30 UTC
Votes:3
Avg. Score:4.7 ± 0.5
Reproduced:3 of 3 (100.0%)
Same Version:3 (100.0%)
Same OS:3 (100.0%)
From: drgnllc at gmail dot com Assigned: rquadling (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
You can add a comment by following this link or if you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: drgnllc at gmail dot com
New email:
PHP Version: OS:

 

 [2009-06-27 15:15 UTC] drgnllc at gmail dot com
Description:
------------
File php_manual_notes.chm is mentioned in latest php manual (english) under "Manual Content and User Note Separation" but no such file can be found on php.net sites/mirrors thru search.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2009-06-30 13:33 UTC] danbrown@php.net
Thanks for reporting this issue to us.

Which mirror are you using to connect to the php.net network?  If you 
could provide a direct link to the error message that you're seeing, it 
would be very helpful.

Thanks.
 [2009-06-30 22:57 UTC] drgnllc at gmail dot com
I don't get any error message. I've reported this as website problem because I think user submissions are important and should be available as .chm file for download. Also this file is referenced in the php manual (.chm version) with clear info how to use it, but the file php_manual_notes.chm itself it can't be found on www.php.net.

I have tried searching for the file in "search for" form in top-right of www.php.net website using "all php.net sites", "this mirror only", "documentation" etc.. I have tried google too without success.

All I have found are either talks about it, or links to other websites containing probably old versions of it.
 [2009-07-01 09:02 UTC] rquadling@php.net
The php_manual_notes.chm was part of the "Extended CHM" manual.

This manual offered the ability to "skin" the manual as well as allowing 
access to the user notes.

The Extended CHM manual is no longer produced.



 [2009-07-01 09:33 UTC] drgnllc at gmail dot com
Thank you for your answer. Perhaps references to it should be removed from .chm version of manual too, to avoid future confusion.

I am changing category of this bug to "documentation problem" so maintainers can take notice.
 [2009-11-16 13:19 UTC] svn@php.net
Automatic comment from SVN on behalf of vrana
Revision: http://svn.php.net/viewvc/?view=revision&revision=290817
Log: CHM notes currently unavailable (bug #48707)
 [2009-11-16 13:20 UTC] vrana@php.net
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation better.


 [2010-04-28 08:56 UTC] techtonik@php.net
-Status: Closed +Status: Re-Opened
 [2010-04-28 08:56 UTC] techtonik@php.net
This doesn't explain why it was taken down. Can anybody enlighten on that?
 [2010-04-28 09:59 UTC] bjori@php.net
-Status: Re-Opened +Status: Closed -Assigned To: +Assigned To: bjori
 [2010-04-28 09:59 UTC] bjori@php.net
Because it is no longer available.
We have noone that has that has the know-how and time to implement this CHM 
stuff.

The references to this package have been removed, it is highly unlikely that it 
will ever exist again.
 [2011-02-24 02:55 UTC] philip@php.net
-Status: Closed +Status: Re-Opened -Assigned To: bjori +Assigned To:
 [2011-02-24 02:55 UTC] philip@php.net
This is being worked on.
 [2011-06-06 13:21 UTC] t dot kmieliauskas at gmail dot com
so is the old format (skinnable) manual going to be maintained again?
 [2011-06-06 14:28 UTC] philip@php.net
-Status: Re-Opened +Status: Closed -Assigned To: +Assigned To: philip
 [2011-06-06 14:28 UTC] philip@php.net
There are now two versions of the CHM build available:

  http://www.php.net/download-docs.php?sizes=1

The 'enhanced' version contains the user notes. The aforementioned old format no 
longer exists, nor is it planned.
 [2011-06-06 14:28 UTC] rquadling@php.net
-Status: Closed +Status: Re-Opened -Assigned To: philip +Assigned To:
 [2011-06-06 14:28 UTC] rquadling@php.net
There were 2 significant features of the old style "Extended CHM" files.

1 - User notes
2 - User selectable CSS styling.

Both of these issues have now been resolved. To a degree.

For the User Notes, the PhD system now has a new format for PHP called 
EnhancedCHM (yeah, sure, the name is pretty poor and is obviously confusable 
with the extended chm ... so shoot me!).

As you can see on the CHM Downloads page (http://www.php.net/download-docs.php), 
you can download a version of the CHM file with the user notes. These are 
generated weekly.

For the User selectable CSS styling, then this has been implemented by the use 
of the --css parameter when running PhD.

You can add multiple CSS files. If you add

--css reset.css --css theme.css --css doc.css

to the PhD build call, this will include the new CSS styling from the currently 
in-progress new styling. As seen if you run http://www.php.net/?beta=1

I have found 1 issue with this 
(http://www.php.net/manual/en/win32service.constants.servicetype.php is a good 
an example as any).

The normal web page (as via the URL) and the HTML file generated by PhD for 
including into the CHM both show the correct alternative line colouring. In the 
CHM file, this isn't the case.

As far as I can tell, this is an MS issue and one that is unlikely to be fixed.

If you have your own CSS file, then you could use ...

--css C:\MyPHPManual\my.css

I've just added this support based upon this conversation 
(http://svn.php.net/viewvc?view=revision&revision=311863).

So, you can now build your own CHM files and apply user defined CSS styling to 
the EnhancedCHM format.

Now... if the CHM viewer supports @import(), I think it could be possible to 
implement many different styling schemes from an unamended, pre-compiled CHM 
file.

The downside is that the CSS file would have to be in the same location as the 
CHM file at all times - unless you built your own CHM file, in which case, why 
use @import? Build in the CSS you want using --css.


I don't think PHP will be providing any additional stylings.
 [2011-06-06 14:30 UTC] rquadling@php.net
-Status: Re-Opened +Status: Closed -Assigned To: +Assigned To: rquadling
 [2011-06-06 14:30 UTC] rquadling@php.net
I think we've done everything here.
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Fri Mar 29 05:01:28 2024 UTC