We are always looking for ways to enhance the developers experience with the
symfony documentation. Some time ago, we added
PDFs for all symfony
documentation to ease offline work.
Today, thanks to Geoffrey Bachelet, the symfony website has now support for
the OpenSearch specification.
We have added OpenSearch support for all stable versions of the symfony API:
1.0, 1.1, and 1.2. If you use Firefox, the symfony search engines will show up
automatically in the search engine menu. You can also click on the "API
OpenSearch" link from the API documentation section.
I have also recorded a small screencast to show you how the symfony API search
engine integrates well with Firefox:
As with any Open-Source project, contributing
code or documentation is the most common way to help, but we also have a wide range of
sponsoring opportunities.
Thanks, this is a really more comfortable way to consult the sf's APIs.
I would report that this function is partially supported also by other browser like IE7+ and Chrome (the handy suggestions are not supported).
can I ask if it is possible to add two other improvements to your alread great documentation?
1 - it would be nice to have a space to comment every api method, like in the phpdoc site
2 - is it possible to add interlinks between the api pages?
for example when I read a definition like this one: "(sfView::NONE) renderPartial ($templateName, $vars = null) " I would like to click on the text sfView to read the documentation concerning sfView.
@gnagno:
I personally dislike the comments, because there is tons of crap in it. Symfony has the snippeets, plugins and cookbooks where users can contribute clever ways of working with certain API.
So I personally see no need and value in creating such API commenting.
Nice! Google Toolbar's custom search doesn't pickup the focus sometimes (cursor should stay in search field when press custom search button there), so OpenSearch is helping a lot.
I would report that this function is partially supported also by other browser like IE7+ and Chrome (the handy suggestions are not supported).
can I ask if it is possible to add two other improvements to your alread great documentation?
1 - it would be nice to have a space to comment every api method, like in the phpdoc site
2 - is it possible to add interlinks between the api pages?
for example when I read a definition like this one: "(sfView::NONE) renderPartial ($templateName, $vars = null) " I would like to click on the text sfView to read the documentation concerning sfView.
Thanks again for all your work!
Gnagno
I personally dislike the comments, because there is tons of crap in it. Symfony has the snippeets, plugins and cookbooks where users can contribute clever ways of working with certain API.
So I personally see no need and value in creating such API commenting.
Thanks a lot for the effort.
but "suggest" autocompletion does not work for some reason... I have FF3.
Others engines works fine, i.e. google, wiki, etc.
Any chance to verify this url:
http://www.symfony-project.org/api/search/1_2/autocomplete.json?search=sfAction
Thanks!