Re: A complete summary of doc.keliglia.com status

From: Date: Wed, 09 Jun 2004 20:46:50 +0000
Subject: Re: A complete summary of doc.keliglia.com status
References: 1  Groups: php.doc.web 
Request: Send a blank email to doc-web+get-7@lists.php.net to get a copy of this message
> What was done so far ? > > * templates : > they are derived from the official websites. Seems like > we're not going to use them, but Yannick have made a lot of efforts > to make them XHTML 1.0 strict compliant. Maybe the official sites > can use them so that we won't be wasting any effort ? :) I hope so! > * revcheck : > I rewrote everything from scratch to integrate an sqlite database > to handle it. The idea is : > - a single database per documentation (pear, smarty, ..) > - the ability to build the database for several languages at once. You are using a DB with all languages for phpdoc? 100 MBs?? :) Do you this to generate the revcheck? > Why did I use sqlite instead of simply generating static HTML pages ? > There are a lot of reasons : > * when we first started to use this system on phpdoc-fr, the generated > page was really huge, and made my browser crash several times. (now > we're 99% uptodate, so this is not a probelm anymore for the french > translation :)) Mine doesn't crash (long life to IE! :)) but takes some time to load a 700 KBs page... > * I wanted to be able to dynamically extract the outdated files for a > particular translator, without having to run revcheck.php for every > dude. > My idea is to have a login system for every @php.net member, to be able > to provide a karma system over the website (who is able to edit the > news ? > who can drop the comments ?) Sqlite was a clear answer to me. > It seems like Gabor wasn't to happy with sqlite, what about it now, with > the explanations ? (read my previous e-mail) I have the same opinion. We should have a login system. (my proposal was to use the magic cookie, as we use it in the master server and in the bugs, too) > Yannick used jpgraph to provide some graphic for revcheck. We can compare > the different translation status with a single look to a picture, or we > can see the detailed status of a translation with another one. They are really nice! > Also, I'm an optimistic guy, I believe that if someone reads a translation > of the manual, and sees a warning claiming that this translation is > outdated. > This someone can help us updating the translation if we provide a > simple way > to do it. (see the phpdoc/RFC for the findings about a visual editing > utility) I've already saw a modified version of livedocs in your site. This might be a good idea. We may try and see if it works. > discuss some global issues (how do we document a class ? I know Steph has > been waiting for an official and global answer since ... too much time). And OO, too. I need to finish documenting the tidy extension. > We could also drop a fresh XML DTD for the RFCs, to add more informations, > something like : > > <rfc id="xx"> > <title>title</title> > <topic>short description</topic> > <content> > <para> > plop plop plop > </para> > </content> > </rfc> > > (or whatever structure you want) > > We will extract the various commit messages to provide a summary of > changes. > Anyway, waiting for comments on this (it's an RFC :D). Why not a simple DB? With the login system, someone could submit an RFC easily without XML. > * Splitted the site > informations. We did this with a vhost system, but sure, we can do it > via folders, > or whatever you'd like to. I think I prefer folders. (virtual with mod_rewrite) > This is all what I see for the moment, I've got to go back to the party > or I'll sleep > on the sofa tonight ;) I'll have a look at my mails tomorrow morning and > will try to be > more reactive. Just have a good party! :) > doc.keliglia.com, but it's mostly Yannick's work. Rendons à Cesar ce qui > appartient > à Cesar :) J'aime le français! Nuno

« previous php.doc.web (#7) next »