php-documentation-list | 2003101

Re: [PHP-DOC] Colors in Documentation From: Gabor Hojtsy (gabor <email protected>)
Date: 10/15/03

>>>I was thinking that perhaps the red boxes could be consistantly
>>>used for all 'Caution' blurbs and the blue boxes for all 'Info'
>>>blurbs. I also came up with a color (hopefully the same tones) to
>>>be used for all the 'Warning' blurbs.
>>
>>I very much like your idea, *BUT* we are (truly) slowly moving towards
>>using livedocs for online documentation presentation. The goal is to use
>>livedocs completely to generate the online manuals. Read more about it
>>in the 2003 docmeeting findings (in CVS at phpdoc/RFC).
>
> I like it very much :) 15 minutes (starting from installation) and
> I was able to view the docuemntation!!

It was originally intended as a quickview of the manual for the
translators and the authors, but it evolved to be much more (with even a
search function :)

>>There is probably not much left in livedocs to extend to support those
>>things we would need for online manual generation, but the development
>>paused in recent months.
>
> Is there a existing list of items left to do, I cant find much
> discussion (on this list) of what has been done and what still
> needs to be done.
>
> Mabey my email will spark the movment on getting livdocs working :)
> unless there are other things holding it back.

I hope that it will move on. Here are some things in my head regarding
livedocs:

  - fix some unhandled stuff (there are some nodes displayed with ???),
    these are not yet handled properly
  - print out prev and next links as on PHP.net
  - provide optional integration into the PHP.net layout (so it still can
    be used without this, but it can integrate)
  - figure out how caching will work on php.net and the mirror sites

I don't know what other rendering related stuff is missing. Wez? Derick?

Goba