Req #66491 [NEW]: Alphabetic extension list
| From: | kulakov74 at yandex dot ru | Date: | Wed, 15 Jan 2014 19:39:19 +0000 |
| Subject: | Req #66491 [NEW]: Alphabetic extension list | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-10845@lists.php.net to get a copy of this message | ||
From: kulakov74 at yandex dot ru
Operating system: Windows
PHP version: Irrelevant
Package: Documentation problem
Bug Type: Feature/Change Request
Bug description:Alphabetic extension list
Description:
------------
Of all the PHP manual formats I have always preferred the chm one. But
since some time the structure of its contents under "Function reference"
changed from linear to a deeper structure. I do understand the need to
get things more in order, but at the same time, with the new nested tree
I often experience problems when trying to find sections I used to
easily find before. For example, to find String functions, I have to
know it's inside the Text Processing node, and in order to find ctype
functions I have to know they're in "Variable and Type Related
Extensions". In both cases I have to scan through all the TOC. Of course
I could use the index but I don't always know the right name I search
for and anyway TOC could be more usable.
As I had to compile the chm manual for myself I used the chance and
added an extra node "Extension Alphabetical List" that includes all 3rd
level extension names from "Function Reference" sorted alphabetically
regardless of their parent node. That is, from "Affecting PHP's
Behaviour": APC, APD through Xhprof, then from "Audio Formats
Manipulation": ID3, and so on through "XML Manipulation". And I had to
go 1 level deeper in the Database Extensions node cause it has 1 extra
level.
The "Extension Alphabetical List" goes right before "Function
Reference". Itself does not open any page, and every subnode in it (like
Ctype or MySQL) points to a simple fake page funclink.html that only
jumps to the original page. Because actually the Alphabetical List
introduced duplicates for the nodes it contains, it can't just point to
the same page as the original nodes. For example, in my Alphabetical
list the node MySql actually points to res/funclink.html#set.mysqlinfo,
and funclink.html parses the hash 'set.mysqlinfo' which is actually the
name of the original page and jumps there with javascript
(window.location.replace(...)). That way I do get to the right page and
then if I click the Locate (Find?) toolbar button, I get the
corresponding node in the original Function Reference structure (in this
case: Database extensions - Vendor Specific DB extensions - MySql).
So you could do smth like that in the chm manual.
Test script:
---------------
-
Expected result:
----------------
-
Actual result:
--------------
-
--
Edit bug report at https://bugs.php.net/bug.php?id=66491&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=66491&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=66491&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=66491&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=66491&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=66491&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=66491&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=66491&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=66491&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=66491&r=support
Expected behavior: https://bugs.php.net/fix.php?id=66491&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=66491&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=66491&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=66491&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=66491&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=66491&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=66491&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=66491&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=66491&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=66491&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=66491&r=mysqlcfg