=== YD Search Functions ===
Contributors: ydubois
Donate link: http://www.yann.com/
Tags: Wordpress, WP, plugin, search, snippet, snippets, Google, result, results, hit-highlighting, highlighting, hit, search engine, find, function, functions, template function, template, search template, abstract, indexing, text, full-text, full-text indexing
Requires at least: 2.9.1
Tested up to: 2.9.2
Stable tag: trunk

Improved search tools and template functions including Google-like search result snippets (on-the-fly contextual abstract) and hit-highlighting.

== Description ==

= Display Wordpress search results like Google! =

This Wordpress plugin installs a set of **new template functions** that lets you customize the way search results are displayed in your Wordpress search page.
You can use on-the-fly generated Google-style text **snippets** to help make search result abstracts more useful.
You can do on-the-fly hit-highlighting (in-line xml-based, not through a cumbersome asynchronous Javascript).
Your customized search result snippets being included in the delivered page content, they can be indexed by third-party web search engines.

The CSS styling of snippet results is compatible with Google custom search engine stylesheets for complete integration.

For an example of what it can look like, look here: http://www.nogent-citoyen.com/recherche/tour+eiffel (in this example, the left columns displays Wordpress-generated results using this plugin, while the right column displays asynchronous Google custom search engine results)

The plugin has its own admin options page.

It is **fully internationalized**. The search functions are UTF-8 multibyte compatible and do take care of accentuated text.

Base package includes .pot file for translation of the interface, and English and French versions.

**NB: although fully functional, this plugin is still in development stage, and new features will be added soon to help further improve search-result customization and display.**

= Available template functions =

* Use `<?php echo yd_search_snippet() ?>` in your search results page template loop (`search.php`).
For example, in your search template theme file (`search.php`), find the place where it says `the_content()` and replace it like this:
`
    <?php if( function_exists( 'yd_search_snippet' ) ) yd_search_snippet() ?>
`
*(beware: function parameters have changed since 0.1.0. They should not change again in the future.)*

= Active support =

Drop me a line on my [YD Search Functions plugin support site](http://www.yann.com/en/wp-plugins/yd-search-functions "Yann Dubois' Advanced Search Functions plugin for Wordpress") to report bugs, ask for a specific feature or improvement, or just tell me how you're using the plugin.

= Description en Français : =

Ce plug-in Wordpress installe des fonctions avancées d'affichage des résultats de recherche.
Vous pouvez notamment l'utiliser pour afficher des extraits de texte intelligents dans vos résultats ("snippets" à la Google).
Il n'extraira que les passages du texte contenant les mots-clés et expressions recherchés.
Il pourra également surligner dans le texte les expressions et mots recherchés.
La fonction de surlignage se fait en ligne dans le flux XML et non en mode asynchrone avec un Javascript lent et lourd.
Les snippets et les mots surlignés faisant partie du texte de vos pages de résultats de recherche, ils peuvent eux-même être indéxés par les moteurs de recherche externe du web, donnant de la valeur originale à vos pages de résultats.

Le style CSS généré pour les résultats de recherche est compatible avec les feuilles de styles utilisées par le moteur de recherche Google custom pour une intégration parfaite (voir exemple ci-dessous).

Le plugin a sa propre page d'option dans l'administration.
Il est entièrement internationalisé.

La distribution standard inclut le fichier de traduction .pot et les versions française et anglaise.

Le plugin peut fonctionner avec n'importe quelle langue ou jeu de caractères.
Les fonctions de recherche et de surlignage gèrent les caractères français accentués de façon intelligente.
Elles sont compatibles utf-8 multibyte.

Pour voir un exemple du fonctionnement de ce plug-in en grandeur nature, regardez ici : http://www.nogent-citoyen.com/recherche/pavillon+baltard
(dans cet exemple, la colonne de gauche affiche des résultats Wordpress générés avec ce plug-in alors que la colonne de droite affiche des résultats de l'API du moteur de recherche Google custom)

Pour toute aide ou information en français, laissez-moi un commentaire sur le [site de support du plugin YD Search Functions](http://www.yann.com/en/wp-plugins/yd-search-functions "Yann Dubois' Advanced Search Functions for Wordpress").

= Funding Credits =

Original development of this plugin has been paid for by [www.Nogent-Citoyen.com](http://www.nogent-citoyen.com "Nogent Citoyen"). Please visit their site!

Le développement d'origine de ce plugin a été financé par [www.Nogent-Citoyen.com](http://www.nogent-citoyen.com "Nogent Citoyen"). Allez visiter leur site !

= Translation =

If you want to contribute to a translation of this plugin or its documentation, please drop me a line by e-mail or leave a comment on the plugin's page.
You will get credit for your translation in the plugin file and this documentation, as well as a link on this page and on my developers' blog.

== Installation ==

1. Unzip yd-search-functions.zip
1. Upload the `yd-search-functions` directory and all its contents into the `/wp-content/plugins/` directory of your WP site
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Use the option admin page to customize the settings if necessary.

For specific installations, some more information might be found on the [YD Search Functions plugin support page](http://www.yann.com/en/wp-plugins/yd-search-functions "Yann Dubois' Advanced Search Functions plugin for Wordpress")

== Frequently Asked Questions ==

= Where should I ask questions? =

http://www.yann.com/en/wp-plugins/yd-search-functions

Use comments.

I will answer only on that page so that all users can benefit from the answer. 
So please come back to see the answer or subscribe to that page's post comments.

= Puis-je poser des questions et avoir des docs en français ? =

Oui, l'auteur est français.
("but alors... you are French?")

== Screenshots ==

1. TODO
For an example of what it can look like, look here: http://www.nogent-citoyen.com/recherche/tour+eiffel (in this example, the left columns displays Wordpress-generated results using this plugin, while the right column displays asynchronous Google custom search engine results)


== Widget options page ==

Use the widget's own option page to customize settings if necessary.


== Revisions ==

* 0.1.0 Original beta version.
* 0.2.0 First improvements (function interface, options, no debug code)

== Changelog ==

= 0.1.0 =
* Initial release
 = 0.2.0 =
* Improvements (2010/04/25)
* Better function interface (function call parameters have become optional. Parameter order has changed.)
* Simplified function implementation
* No more debug messages visible
* Option set for customization

== Upgrade Notice ==

= 0.1.0 =
Initial release.
= 0.2.0 =
Upgrade the usual way. Beware the function call parameters have changed. See changelog for details.

== To Do ==

Test. Final release.

== Did you like it? ==

Drop me a line on http://www.yann.com/en/wp-plugins/yd-search-functions

And... *please* rate this plugin --&gt;