php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #41182 Function Reference list under TOC
Submitted: 2007-04-25 05:05 UTC Modified: 2007-08-17 09:26 UTC
From: uttam at hotpop dot com Assigned:
Status: Not a bug Package: Documentation problem
PHP Version: Irrelevant OS: Irrelavant
Private report: No CVE-ID: None
View Developer Edit
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: uttam at hotpop dot com
New email:
PHP Version: OS:

 

 [2007-04-25 05:05 UTC] uttam at hotpop dot com 
Description:
------------
Hi,

The list of functions under section "Function Reference" in PHP Manual (http://www.php.net/manual/en/) has grown too long. The list is sorted alphabetically, due to which many similar categories appear at very different place in TOC. Here are a few examples"

1. ".NET Fuctions" and "COM and .NET Functions"
2. "ClibPDF Fucntions", "Haru PDF Functions", and "PDF Functions"
3. "DOM XML Functions", "libXML Functions", and "SimpleXML Functions"
4. "String Functions" and "Multibyte String Functions"
5. "Image Functions" and "Exif Functions"

I think we should group the functions categories under different sections such as "Database", "Mail","Imaging" etc. This would make it easier to browse or search for a particular function. The word "Functions" can also be omitted from each category because it is obvious.

If creating sections is not feasible, we can atleast rename the categories so that similar functions appear togather. For example the cateogry "Multibye String Fuctions" can be renamed to "String Functions - Multibye" so that it appears togather with the category "String Fuctions" in TOC.

Thanks & Regards,

Uttam Shukla
Bangalore, India

Reproduce code:
---------------
NA

Expected result:
----------------
NA

Actual result:
--------------
NA

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2007-04-25 05:12 UTC] philip@php.net 
Do you feel it would be useful to have categories like the following:

  http://php.net/manual/extensions

But for the Function Index list the functions too?
 [2007-04-25 05:28 UTC] uttam at hotpop dot com 
Yes, I think a similar grouping scheme would be useful. However, the line spacing was too much on the page http://in.php.net/manual/en/extensions.php, due to which you have to scroll a lot. 

We can continue listing the functions in the Function Index. But let me clarify, I have not referred to the Function Index in my earlier post. I have refered to the section "Function Reference" in Table of Contents on page http://www.php.net/manual/en/.

Regards,
 [2007-04-25 06:25 UTC] philip@php.net 
It's tough to do it nicely, perhaps you can create a partial mockup of the layout? One of the troubles is it can't be too wide, and must be easy to find extensions.

This comes up from time to time but no decent solution has been found. There will be a time when we have 1000 PECL extensions so perhaps by then we'll be forced to solve this problem for good :-)

One of the proposed solutions is to have people choose their extensions but IMHO that is not a solution. By default all extensions will be listed, and most people don't know what extensions to list and/or would be missing out on some goodies later. But then again when there are 1000 PECL extensions we can't list them all within the sidebar.

See how complicated this gets? :)
 [2007-08-17 09:26 UTC] vrana@php.net 
That's why we have both extension categorization and index. Index is preferred currently.
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Wed Jul 16 20:01:32 2025 UTC