On Jan 11, 2007, at 5:21 PM, Christopher Arndt wrote:
> > Alberto Valverde schrieb: >> so I'll *try* writting a more general widget oerview. > > Hi Alberto, > > I just had a private email conversation with Florent Aide about the > widget docs > and I was planning to start a comprehensive overview about widgets > myself. > Since I don't think that I would be able to finish such an > undertaking in a > single day, it would be perfect, if we could share the work on this. > > Below follows a preliminary draft of the doc structure resp. the > points I would > like to see covered. Some of these topics are already (partly) > covered by > existing wiki pages and for some there are good emails from you or > others that > could be used as a basis. > > What do you think about it? > > Chris > > > Widget documentation > -------------------- > > - What are widgets? > - What can/should you use widgets for? > - What are the parts of a widget? > > - template > - JavaScript > - CSS > - glue code (i.e. __init__(), update_params()) > - sub/compound widgets > - validators > > - How to use TG standard widgets > - instantiation (__init__ parameters) > - passing the widget to your template be sure to mention tg.include_widgets for app-wide widgets. > - widget display (parameters) > - How to structure your code, i.e. where to put what > > - How to create your own custom widgets > - Simple widgets > - Compound widgets / Forms > - Widget lists > - Validation schema > - Custom validators > - Controller methods: > - validation > - error handling > - form submission handling Maybe this shouldn't be covered in much detail as it's more related to controllers than widgets and widgets are not required to validate input, just mention how a form can be used to validate. > - Custom JavaScript / CSS code > > - Dataflow > - between a widget and the controller. > - JavaScript / CSS inclusion > > - ??? I would add: - how to create a widget skeleton with "tgadmin quickstart -t tgwidget" to make app-agnostic widgets that can be easily reused. - the fact that widgets should be state-less and should only be instantiated once as they're designed to be defined in a declarative way (more or less like FE validators) How are you guys planning to distribute work? What part should I (or you want me to) tackle? I'll probably be offline on saturday as It'll be a shame to be in Amsterdam and don't see anything apart from racks and servers but I might be able to have something done tomorrow... Alberto --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Docs" 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-docs?hl=en -~----------~----~----~----~------~----~------~--~---
