php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Bug #36533 Need for user notes in downloadable HTML documentation
Submitted: 2006-02-26 10:37 UTC Modified: 2006-02-26 14:06 UTC
From: mathieu dot bonnet at nalkym dot org Assigned:
Status: Wont fix Package: Website 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: mathieu dot bonnet at nalkym dot org
New email:
PHP Version: OS:

 

 [2006-02-26 10:37 UTC] mathieu dot bonnet at nalkym dot org
Description:
------------
The PHP downloadable HTML documentation does not feature the user contributed notes. I can understand some people do not want them, but it would be nice to have a separate downloadable HTML documentation version, with the user contributed notes.

As the user notes are in English, I guess we only need the English documentation to be available with them... and I suppose we only need the version with multiple HTML files.



Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2006-02-26 11:54 UTC] goba@php.net
What you are looking for (also with the search box :) is a self-hosted packages, which includes user notes. We are in a great need of testers for our Livedocs software, which does just that, and it looks really nicer then the downloadable HTML versions.

  http://wiki.phpdoc.info/LiveDocs

You will find the self-hosted version on the first link. Please give feedback, bug reports and suggestions in the Livedocs bug category.
 [2006-02-26 14:06 UTC] mathieu dot bonnet at nalkym dot org
I like the idea, but it is slow and needs a Web server (well, I have one, but I would prefer not to depend on it, for the documentations...). Moreover, the table of contents is too detailed in the default configuration. Unfortunately, for now, I don't have enough time to try to tweak it.

I won't insist, if you do not want to generate another version of the downloadable HTML documentation, but I still think it is the best solution, for most people, for now.
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Thu Mar 28 13:01:28 2024 UTC