Re: Annotated Manual
| From: | Simon Roberts | Date: | Sat, 25 Nov 2000 12:02:07 +0000 |
| Subject: | Re: Annotated Manual | ||
| References: | 1 | Groups: | php.dev php.mirrors |
| Request: | Send a blank email to php-dev+get-39113@lists.php.net to get a copy of this message | ||
> At 04:06 PM 11/24/00 +1300, Simon Roberts wrote:
> >I've just commited a small addition to phpweb that will allow the
annotated
> >manual work on a mirror. It works by downloading all the comments from
> >www.php.net, and storing them in ./manual/usernotes. If people think
that
> >it's worthwhile, we could even add the usernotes dir to CVS and
distributed
> >updates to the comments that way (better, IMO)
> How does this allow you to actually show the user notes on the right
pages?
> Each manual page has its own set of user-notes.
Sorry, perhaps I should have been clearer.
./manual/usernotes/[PAGE].txt
(where [PAGE] is the unique name for each manpage. Each file is a serialized
array, exactly as returned from the DB. The "show comments" section of
shared-manual.inc checks to see if it's www.php.net. If not, it looks in
usernotes/ for the comment-files, and shows them if they're there).
There's still a bit of work to do here : efficient updates to mirrors,
security, etc; but I think having the comment-files in CVS would be tidier
(though require an entry in crontab).
Simon