#32012 [Opn]: reference page organization

ID:               32012
Updated by:       philip@php.net
-Summary:          Request for revisiting your online manual
Reported By:      soletan at toxa dot de
Status:           Open
-Bug Type:         Livedocs problem
+Bug Type:         Documentation problem
Operating System: Irrelevant
PHP Version:      Irrelevant
New Comment:

The new proposed use of <set>/<book> will help solve this, to go along
with the new build system (PhD). Each extension should have an
introduction but how to organize the reference pages is still being
debated.


Previous Comments:
------------------------------------------------------------------------

[2006-01-07 03:12:12] jsgoupil@php.net

See also bug #35922

------------------------------------------------------------------------

[2005-08-15 11:26:14] goba@php.net

This is indeed a doc (or livedocs) problem, since the rendering code
lives there. DSSSL could be fixed to do this, and Livedocs definitely
should be.

------------------------------------------------------------------------

[2005-08-13 21:14:06] nlopess@php.net

Myabe its a a good idea to add anchor links to install intructions,
functions list, etc..

------------------------------------------------------------------------

[2005-02-17 17:48:30] soletan at toxa dot de

Description:
------------
Hi,

I'm using your online manual as reference while coding each and every
day. I prefer to use that over any book or similar since I consider it
to be always most uptodate over those. Furthermore user notes are quite
helpful very often.

BUT: Again and again I don't see any sense in having such huge front
page on each extension. Did you ever try to find the list of supported
methods on Multibyte String Extension's front page? While looking for
that I'm neither interested in information how to install that
extension, how to configure transparent IO-encoding or on what each
charset is about to be. Even "moving to bottom of page" doesn't satisfy
as there might be lots of user notes with further suggestions on how to
install here, configure there etc.

Of course, ALL these information are worth to be available, but why
couldn't you have some subpages since they become more and more complex
with each new release of PHP. And normally users stop installing some
day and even configuration is done, right before the developer starts to
use your manual as a reference for daily work.
Sometimes I simply can't remember what was the name of a single
function or what options I have to do this or that using single
selection. So using shorthand access using URL is no good tool just like
searching whole PHP's function list.

Well, simplest adjustment would be to have a page menu on top to click
for the function list (as well as installation notes, list of defined
constants, user notes, etc.). This would avoid getting more files in PHP
manual folder.



------------------------------------------------------------------------


--
Edit this bug report at http://bugs.php.net/?id=32012&edit=1