Re: re-formatting CREDITS file

hi, On Mon, Jun 8, 2009 at 12:15 AM, Greg Beaver<greg@chiaraquartet.net> wrote: > No, the text is copied verbatim into <summary> <description> and <notes> > fields of package.xml (with appropriate encoding and escaping of &lt; > and friends). > > Of course, this is just how I wrote the code, and the best part (I > think) about Pyrus is there is a distinct separation of the developer > tools from the core installer, thus it will be easy and economical to > bloat^H^H^H^Hadd as many features as people need into the developer > tools.  Personally, I would tend to wonder if the README/CREDITS files > are the best place for complex formatting? I was not thinking about complex formatting rules but more some basic stuff to display nicer package information (description or changelog for example) without having to edit the text online manually. > However, one can easily do a > format like wiki markup which is still human-readable, and it solves > your problem and mine without any need to change the code. An alternative would be to specify which formatting rule is used and add a tag to the related attributed (<notes format="markdown">...</notes>). One can ignore it (pyrus show cmd for example) or parse it correctly (web frontend). >> The format describes below is fine from an information point of view. >> One thing to keep in mind is that this file is used to generate the >> Credits page in phpinfo() which should contain only names (I don't >> think we should clutter it with all these details). It should be easy >> to update the generation script to support this new format (script is >> in php-src). >> > Perhaps there would need to be some kind of marker in CREDITS that the > script would look for?  I implemented (arbitrarily) ;; as a comment, so > it could be a requirement that if you plan to use the new > Pyrus-compatible format, your file would look like: > > ;; extensionname maintainers (or any other comment you want to put in here) > Full Name [handle] <email@example.com> (role) > > So the script could simply check for $line1[0] == ';' and jump to > parsing the new format. > > Sound reasonable? Yes, it is fine. Cheers, -- Pierre http://blog.thepimp.net | http://www.libgd.org