Re: great plans about the CHM version

From: Date: Mon, 01 Oct 2001 08:02:11 +0000
Subject: Re: great plans about the CHM version
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969337819@lists.php.net to get a copy of this message
Hi Goba, Saturday, September 29, 2001, 3:38:45 PM, you wrote: > Hi! > I have some plans regarding the CHM version of the PHP manual. > Some our feature request (eg. include notes), some our from my > mind. Anybody with a Windows box can see a pre-proto version > here: http://www.goba.hu/chm_proto.chm I had a look. > This is a small presentation of some features and designs > I would like to incorporate. Many things are not there >>from my plan. > So go through what I would like to achieve: > - Much more powefull design (as we are hosting this > help file for an "enterprise quality product" - PHP, > and so the big mans there like good looking things, > and me too :) I am not a designer, so it would be > better, if some designer can come up with better > graphics, than I have done, but it is certainly better > in the file mentioned above, than now. The graphics and layout seems to be quite good. I myself can > - More information on the pages: > + including user notes in the CHM file. it hardens > the build process, but makes the CHM much more useful. > this is not shown in the file posted above That would be great! > + boxing warnings, notes, see alsos (the last one is > the hardest, as we have no <seealsoblock> kind > of tag, while we have <warning> and <note> block > tags, so these blocks are easy to identfy. boxing warnins and notes would be great. about see also: for now this is done actually with (you know better than I): <para> See also: <function>mysql_query</function>. </para> Whats the problem to do this in this way? (ok, I am not so experienced in xml and building issues), but this see also does actually work for the chm`s. > + tagging of inside and outside links with small > images, opening outside links in a separate window. > this eases the distinction between the outside > and inside links, and moves outside links to a more > suitable browser environment Good idea! > + "links on this page" feature. collecting, categorizing, > and presenting unique links on the page shown in > a separate dropdown menu (outside links, links to > functions, etc.) this eases the reach of connected > pages Also a good idea! > - User preferences > + let the user set, what mirror site he/she would like to > use for the online functions mentioned below > (also not working at this time on the above page) In my opinion not so urgent. It would be a nice add on for the future. > + maybe more in the future > - Online functions > + "see this page online" - on the user selected mirror, > or one random choosen one random choosen for the starting. > + "report docbug on this page" - eases docbug reporting, > directs bug reports to the proper destination good point. > + "check for newer version" - simple newer CHM download > check, eases the update of the CHM file (can simply > call php.net/download-docs.php?chm-update=2001-09-29, > and if that script finds newer CHM file than this > date given, then the download is offered) good point. > I am really open for other useful tips, and feature > requests, and better graphics than mine :)) Generally, I would like to see a section in the manual/chms of unsupported functions for windows and vice versa a section of functions only working on *nix or windows. Actually there is only a note within the function description(see for example the Filesystem functions). An overview would be great. Also more windows specific notes: what extensions are included in the win-distribution? what extensions are included but need installation of additional programms/libraries? my 2cents so long Friedhelm

« previous php.doc (#969337819) next »