Re: Helping Document PHP-GTK

On 3/23/2010 8:01 AM, Paul Lashbrook wrote:
> Hiya guys,
>
> Ive just started my php-gtk app that ive been thinking about for awhile, it
> will use GtkScintilla extensively and since the current documentation
> information is sparse i would like to offer to help add documentation to the
> manual as i go...
>
> i just dont know how to go about it.. or if theres anyone still around as
> the archive shows it's been awhile.
>
> cheers guys (if anyone is there)
>


AHHH! people to draft into writing docs!

HURRAY (excuse the excess enthusiasm - docs are a thankless and frankly 
slightly boring thing)

1st of all - yeah the (few) people who actually still do some php-gtk 
work hang out in #php-gtk on freenode, great place to come if you're 
interested in helping out.

2nd - the docs are all in docbook format in the PHP svn
http://svn.php.net/repository/gtk/php-gtk-doc/trunk/

php-gtk currently uses a rather proprietary format of docbook - with 
it's own dtd extension and some stylesheets that make my head hurt that 
are run through xsltproc in order to generate the actual html.

This is not fun.

The IDEAL thing would be to migrate the docs to docbook 5, using the php 
xsd with some of our own extensions (like PEAR does for it's special 
markup) and then we could use PhD (a php based docbook renderer written 
for the PHP documentation that is fast and fun)  Some people started on 
this... then floated away.

But that's a BIG project.

If you want to just help document now, feel free to check out the 
documentation from svn, do some editing, and send patches for changes to 
the php.gtk.dev mailing list.

After a few good patches someone (most likely me) will probably get sick 
of applying said patches and get you an svn account and karma.

But yeah, patches first - on the docs in SVN.  You can really ignore a 
lot of the stuff there, the actual "meat" of the manual is here
http://svn.php.net/repository/gtk/php-gtk-doc/trunk/manual/en/

the translations are horribly out of date as well.

Thanks,
Elizabeth Smith