James Henstridge wrote:
>
> To get something done quickly, it may be better to start with a tutorial
> which shows the basics (hello world program, what are signals, how to
> connect signals, idea of event loop, maybe something on multithreaded
> programming, etc), and at the end have the MAPPING files (or a rewrite of
> their content) with a link to the gtk+ reference documentation project
> (http://www.gtk.org/rdp/) and the GNOME developer's documentation (I can't
> remember the address -- you can get to it from www.gnome.org though).
A short tutorial should be the first thing to work on, and at the very top of
the documentation. Much of the tutorial can in fact come from the examples;
we'd just have to add some text.
> I agree that a tutorial would make it a lot easier to for people to start
> using pygtk, but I think having a function reference would be more work
> than its worth (unless it was possible to write a filter to convert the
> C documentation to python docs).
We can actually take the C reference and convert them all by hand. But in a
sense you already did that by making the bindings :-) I would like to take the
.py files and make one html file per class. We can then fill it in with text
and more tutorials over time.
I'm saying this because I find I have to keep gtk.py and gnome/ui.py open in a
text editor while I'm working on my project. I first look at the C reference or
maybe Eric Harlow's book and then wonder how that would translate into Python.
I can sometimes guess, but it is often the case that you have named things
differently than I'd expect.
> Note that I am not saying other people
> should not atempt this if they want to -- I just think that it would be
> easier and almost as effective to point people at the reference docs (this
> is similar to what they had at the end of the tkinter life preserver --
> how to use the tk man pages).
Yes. David Cook in his last e-mail has some examples of how the C would
translate into Python. I think this would be good to put right after the
tutorial and would serve to help programmers "pull themselves up by their own
bootstraps", in a case where they can only get help from the C docs. At least
they would have an idea as to what the C equivalents are.
If you, David, myself and anyone else are going to work on this, it may be best
to use CVS. I have a CVS server and can start a module. I'll give you and
David shell accounts, which will automatically give you CVS access. You know
the server:
http://theopenlab.uml.edu/
Unless you yell and scream that you don't want the accounts, I'll send you the
login info shortly.
Jeff
>
> On Wed, 26 May 1999, J.W. Bizzaro wrote:
>
> > (This is a reply to a message from Dave Cook on the python newsgroup.)
> >
> > Dave et al.,
> >
> > Would you like to help make more than a stab at creating some documentation for
> > pygtk/gnome?
> >
> > As you mentioned, I found that reading the c-gtk documentation to be
> > informative, but it is still confusing because you may not be certain how the c
> > was pythonized. I usually then look at the pygtk and pygnome modules,
> > particularly gtk.py and gnome/ui.py. James's bindings make a nice systematic
> > list of all the gtk/gnome widgets and functions.
> >
> > Isn't there a program that converts the block-quote (""") comments into
> > documentation? I think that would help us.
> >
> > I personally would like to combine a technical reference with a tutorial. IOW,
> > organize the docs by gtk/gnome widgets/functions, systematically listing all of
> > them (as is already done in the modules), and then put a narrative example after
> > some of the more "important". And we can put it on the Web with pretty
> > screenshots!
> >
> > Any volunteers? Many of us have struggled to figure out certain parts of the
> > toolset related to our projects. It would be nice, if you know something very
> > well, to write a little tutorial. This can then be put into the reference under
> > the appropriate function. As for myself, I have learned a bit about the gnome
> > canvas.
> >
> >
> > Jeff
> >
> >
> > "David M. Cook" wrote:
> > >
> > > On Mon, 24 May 1999 18:47:32 GMT, [EMAIL PROTECTED]
> > > <[EMAIL PROTECTED]> wrote:
> > >
> > > >you already know the C version of gtk. Are there
> > > >any future plans for real documentation for
> > > >pygtk, preferably working under the assumption
> > > >that the user doesn?t know what he?s doing?
> > >
> > > I've made some tentative stabs at Gtk tutorial in python, but don't hold
> > > your breath . As you've surmised, the way to learn it is still to study the
> > > C tutorial and peruse the examples that come with pygtk and also the gtk.py
> > > source. Understanding how the C library works does help in understanding
> > > some of the quirks of the Python wrapper.
> > >
> > > Dave Cook
> >
> > --
> > J.W. Bizzaro mailto:[EMAIL PROTECTED]
> > Boston College Chemistry http://www.uml.edu/Dept/Chem/Bizzaro/
> > --
> > To unsubscribe: echo "unsubscribe" | mail [EMAIL PROTECTED]
> >
>
> To unsubscribe: echo "unsubscribe" | mail [EMAIL PROTECTED]
--
J.W. Bizzaro mailto:[EMAIL PROTECTED]
Boston College Chemistry http://www.uml.edu/Dept/Chem/Bizzaro/
--
To unsubscribe: echo "unsubscribe" | mail [EMAIL PROTECTED]
