Documentation updates

During the last weeks, the symfony core team has spent a lot of time polishing the documentation:

  • "The Definitive Guide to symfony" book is being actively updated to take into account the differences between symfony 1.0 and symfony 1.1. As of now, most of the new features are already documented and the last remaining changes will occur before the release of the 1.1 final version.

  • Along side the symfony book work, we're writing some "How Tos" for symfony 1.1. These tutorials will be first published on this blog and will also be added to the symfony Cookbook. The first one has been published last week and it explains "How to use Propel 1.3 in symfony 1.1".

  • We've re-enabled the translation feature of the symfony documentation as it was one of the most frequent request. So, the symfony documentation is now available in several languages. This also means that the askeet tutorial is browseable again in Japanese, French, Spanish, German, Indonesian, Korean, and Portuguese.

  • The API documentation has also been tweaked. There is a new search box to help you find any symfony class or method by its name. The search is quite fast and flexible thanks to the autocomplete feature (see some example below).

  • As of 1.1, symfony supports both Propel and Doctrine as an ORM. As a lot of people are already using Doctrine, we're working on adapting the symfony documentation for Doctrine. The symfony 1.0 "My First Project" tutorial is now available for Propel or Doctrine. More tutorials will be adapted in the near future.

  • symfony 1.1 is bundled with a brand new form framework. As this new feature is quite powerful, and the features it provides are quite huge and flexible, we've decided to write a whole book on the subject. The first four chapters are almost finished and will be published next week.

All those activities represents a tremendous amount of work and any help is very welcome. If you want to write tutorials for symfony 1.1, update the current documentation, or translate some of them, please contact me.

Comments

That all sounds great especially the API search and I am really looking forward to the symfony 1.1 forms book.

Thanks for the great work all involved.
Great! :D Keep up the good work
Great work.

Thank's
Very nice work !
Well done! Keep up the spin!
The API search is great. Thank you for that. One addition to the API that I would like to see is user comments. It is one of the features of the PHP documentation that really help me when I began learning PHP years ago.
The API search is great. Thank you for that. One addition to the API that I would like to see is user comments. It is one of the features of the PHP documentation that really help me when I began learning PHP years ago.
The API search is great. Thank you for that. One addition to the API that I would like to see is user comments. It is one of the features of the PHP documentation that really help me when I began learning PHP years ago.
True, the API search ist really cool! Very nice thing, maybe it could be published as a plugin? :-)

And it seems like the comment system needs another update. ;-)
Love the API search. Awesome.
Good work - it's great to see a project concentrating on documentation rather than just writing lots of code.
Great news,keep it up ppl
Wow waiting for next week!!! ;)
Great! Very good work guys! :)

But, why the most important change of the 1.1, the sfForms, don't have update documentation ?
@Paolo: because the old form system is still available in sf 1.1 and the new form framework will have its own dedicated book.
@Fabien

It's ok, it sound very good :)

But, don't you think to have over-engineered the sfForms, if they need of a dedicated book ?

I'm sure that is a great system (i've tried some times ago), but too much complicated and verbose, comparated for example to Zend Form counterpart.

We want an yml Form generator!! :))

Thank you very much for your hardwork Fabien!
@Paolo: wait for the documentation. You will that creating forms is very very easy with the new system. Much easier than anything else. And complex forms are just as easy. We write a whole book because we really think the new system deserves the best documentation.
I'm waiting for it :)

PS: You already know, but there is some problem with timestamp printing in the comment, seems to be inverted.

Thank you very much

Comments are closed.

To ensure that comments stay relevant, they are closed for old posts.