You are here

README.txt in Apache Solr Autocomplete 7

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 README.txt
Apache Solr Autocomplete module for Drupal.

-- SUMMARY --

Add-on module to Apache Solr Search Integration that adds simple autocomplete
functionality. It enforces node access, meaning that all suggestions are only
from nodes that the user actually has access to.

For a full description of the module, visit the project page:
  http://drupal.org/project/apachesolr_autocomplete

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/apachesolr_autocomplete


-- REQUIREMENTS --

Apache Solr Search Integration module.
See http://drupal.org/project/apachesolr


-- INSTALLATION --

* Install as usual.
  Read http://drupal.org/documentation/install/modules-themes/modules-7
  to learn how to install contributed Drupal modules.


-- CONFIGURATION  --

In your Drupal website, browse to the settings page of the Apache Solr module
at /admin/config/search/apachesolr/settings:

  Configuration >> Search and metadata >> Apache Solr search
  Tab: Settings 

In the section "Advanced configuration" choose which autocomplete widget to use.

You can choose between:

* a custom JavaScript widget
* the jQuery UI Autocomplete widget provided by Drupal core.
* the Drupal autocomplete widget used elsewhere (like for taxonomy autocomplete).

The default is to use the jQuery UI widget.

Normally, the module will make autocomplete responses cacheable by external
caches (e.g., Varnish) using the page_cache_maximum_age Drupal variable (set in
Admin > Config > Performance > Expiration of Cached Pages). Optionally, you can
set a different cache lifetime just for autocomplete responses by overriding
this variable in settings.php:

  // Make autocomplete responses cacheable for 3600 seconds (1 hour)
  $conf['apachesolr_autocomplete_cache_maximum_age'] = 3600;

If you set this to 0, responses will *not* have the necessary Cache-Control
headers and thus will not be cached externally.

-- TROUBLESHOOTING --

If you are having trouble with the autocomplete suggestions not working 
correctly, try changing the configuration to use the core Drupal autocomplete
widget.

If you encounter other problems, please post to the project issue queue:
  http://drupal.org/project/issues/apachesolr_autocomplete

--

File

README.txt
View source
  1. Apache Solr Autocomplete module for Drupal.
  2. -- SUMMARY --
  3. Add-on module to Apache Solr Search Integration that adds simple autocomplete
  4. functionality. It enforces node access, meaning that all suggestions are only
  5. from nodes that the user actually has access to.
  6. For a full description of the module, visit the project page:
  7. http://drupal.org/project/apachesolr_autocomplete
  8. To submit bug reports and feature suggestions, or to track changes:
  9. http://drupal.org/project/issues/apachesolr_autocomplete
  10. -- REQUIREMENTS --
  11. Apache Solr Search Integration module.
  12. See http://drupal.org/project/apachesolr
  13. -- INSTALLATION --
  14. * Install as usual.
  15. Read http://drupal.org/documentation/install/modules-themes/modules-7
  16. to learn how to install contributed Drupal modules.
  17. -- CONFIGURATION --
  18. In your Drupal website, browse to the settings page of the Apache Solr module
  19. at /admin/config/search/apachesolr/settings:
  20. Configuration >> Search and metadata >> Apache Solr search
  21. Tab: Settings
  22. In the section "Advanced configuration" choose which autocomplete widget to use.
  23. You can choose between:
  24. * a custom JavaScript widget
  25. * the jQuery UI Autocomplete widget provided by Drupal core.
  26. * the Drupal autocomplete widget used elsewhere (like for taxonomy autocomplete).
  27. The default is to use the jQuery UI widget.
  28. Normally, the module will make autocomplete responses cacheable by external
  29. caches (e.g., Varnish) using the page_cache_maximum_age Drupal variable (set in
  30. Admin > Config > Performance > Expiration of Cached Pages). Optionally, you can
  31. set a different cache lifetime just for autocomplete responses by overriding
  32. this variable in settings.php:
  33. // Make autocomplete responses cacheable for 3600 seconds (1 hour)
  34. $conf['apachesolr_autocomplete_cache_maximum_age'] = 3600;
  35. If you set this to 0, responses will *not* have the necessary Cache-Control
  36. headers and thus will not be cached externally.
  37. -- TROUBLESHOOTING --
  38. If you are having trouble with the autocomplete suggestions not working
  39. correctly, try changing the configuration to use the core Drupal autocomplete
  40. widget.
  41. If you encounter other problems, please post to the project issue queue:
  42. http://drupal.org/project/issues/apachesolr_autocomplete
  43. --