• Fabien Potencier
• 12 months ago
• Documentation
• 13

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:

Get the Flash Player to see this player.

Enjoy!

Comments

• 

  #1 Daniel said 30 minutes later

  Great, I'll have a look into a Opensearch integration for one of my projects as well.

• 

  #2 beevee said about 9 hours later

  But wait, why there is only two options, 1.0 and 1.2? You just said that support is enabled for all stable versions, including 1.1.

• 

  #3 Geoffrey said about 16 hours later

  beevee: the 1.1 version of the plugin is available directly through the api doc pages, in the right sidebar

• 

  #4 xdade said about 18 hours later

  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).

• 

  #5 Geoffrey said about 19 hours later

  xdade: from what I read there and there, IE8 supports the suggestion spec extension. No idea when (if) chrome will support it as well.

• 

  #6 And said 1 day later

  That is nice and handy addition, thank you!

• 

  #7 gnagno said 1 day later

  guys, you simply rock!!!

  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

• 

  #8 Fabian said 1 day later

  @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.

• 

  #9 elliesdad said 4 days later

  Another great addition to the Symfony documentation.

• 

  #10 COil said 5 days later

  That's cool ! To quickly check options of form widget for exemple. :)

• 

  #11 Anton said 6 days later

  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.

• 

  #12 Dominic said 10 days later

  This is really great news!
  Thanks a lot for the effort.

• 

  #13 wik said about 1 month later

  Sound good,

  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!