Hi Arnar, On 3/29/06, Arnar Birgisson <[EMAIL PROTECTED]> wrote: > I'm a long time python/web developer starting to use TurboGears. > Where's the best place to find comprehensive documentation (if some > exists)?
As you've found, TurboGears has gone from somewhat reasonably documented in 0.8 to woefully underdocumented for 0.9. This is the biggest bug in 0.9, and the main reason that 0.9 is still called an "alpha". I'm going to talk strictly in 0.9 terms, because it's definitely what people should be starting off with. There's quite a bit underway to fix the TurboGears docs. Longer term: * Docudo will be used to manage the TurboGears docs. This will make it far easier for people to collaborate on the docs, while still ensuring quality and freshness. * Mark Ramm and I are writing a book for Prentice Hall, which will be out later in the year. Shorter term: we need to pitch in and fix up the docs that are there. The official place for 0.9 docs is: http://www.turbogears.org/preview/docs/ There remains quite a bit in the wiki that has not been transferred/converted to there: http://trac.turbogears.org/turbogears/wiki/DocumentationPlayground The docs on the wiki are generally close to the 0.9 standards, but there are some items here and there that are out of date. The goal is to *delete* all of those docs on the wiki, putting them into the official spots as appropriate and ditching the ones that are just plain out of date. Fixing up the docs may seem like a daunting task, but it can certainly be broken into manageable pieces. If someone said that they wanted to work on docs for a specific part of the system (widgets, identity, i18n, toolbox, etc.), I'm certain that that someone would be able to get answers to any questions that come up about how to do specific things so that they can update the docs. > I've gone through the tutorials and tidbits of documentation found > online and on this list. The tutorials are nice, but I feel some of > the "tidbits" may be outdated. The only thing I'm afraid of with > TurboGears is reinventing the wheel (or the gear, if you will) - > because I don't know what details are possible to do with the > framework. > > I've used MochiKit for a few projects, but I can't find documentation > or overview of how it integrates with TurboGears widgets. Widgets are able to specify JavaScript that they require. (The JavaScript itself is represented by widgets). Since MochiKit is a core part of the package, you can get at the MochiKit by referencing turbogears.mochikit. If you create your own widgets, you can use that to say that your widget requires MochiKit. In your controllers, if you want to include mochikit on a page, you can just return it in your dictionary to have it get included in the page. return dict(some_value_of_yours=1, mochikit=turbogears.mochikit) > Also, is the "TurboGears is unstoppable now" article still up-to-date > on how to use SQLAlchemy after the 0.9a2 release? That's pretty recent and I haven't seen much action on that code since it was released, so I think that's probably still good. > What I'm basically missing is some documentation listing all those > little features and details, perhaps with short examples, just to get > a sense of "what's there" for me to use. Yep. TurboGears 0.9 does a whole lot more than 0.8 did. As I said in "Project Philosophy", though, the features don't really exist until they're documented. That's a bug we've got to fix, and whatever help people can give in that effort will undoubtedly be appreciated by everyone here. Kevin --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/turbogears -~----------~----~----~----~------~----~------~--~---
