You are here

Home » API reference » Search Log 6

README.txt in Search Log 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
Description
-----------
The core Search module provides a simple list of top search phrases from the
watchdog log using the function dblog_top. However, most sites clear watchdog 
frequently. Search Log stores search terms indefinitely and provides more 
robust reporting.

* Search Log supports all modules which implement hook_search(). Modules can 
  be configured to be excluded from logging.

* Search Log supports the search page, search block and theme search forms.
  By default, logging is performed at form submit before the search results are
  generated, but developers can implement a search_log hook to add additional 
  entries to the log or record failed searches.

* (new) Search Log has an experimental feature to attempt to capture failed 
  searches. While most content reporting revolves around identifying what is 
  popular, identifying failed searches allows you to know what users are 
  looking for and not finding (and then potentially going elsewhere).

* Search Log table can be truncated at a user-specified interval or kept 
  indefinitely.

* Search Log reporting can be filtered by date, module and status.

* Search Log provides a configurable block of Top Searches.


Prerequisites
-------------
Search module.


Usage
-------------
After enabling the module, Search Log is configured at:
admin/settings/search

The improved Search log can be viewed at: 
admin/reports/search

The Top Searches block can be enabled and configured at:
admin/build/block


Bugs/Features/Patches:
----------------------
If you want to report bugs, feature requests, or submit a patch, please do so 
at the project page on the Drupal web site.
http://drupal.org/project/search_log


Author
------
John Money
ossemble LLC.
http://ossemble.com

Module development sponsored by Consumer Search, a service of About.com, a part 
of The New York Times Company.
http://www.consumersearch.com

File

README.txt
View source 
  1. 

  2. Description

  3. -----------

  4. The core Search module provides a simple list of top search phrases from the

  5. watchdog log using the function dblog_top. However, most sites clear watchdog 

  6. frequently. Search Log stores search terms indefinitely and provides more 

  7. robust reporting.

  8. 

  9. * Search Log supports all modules which implement hook_search(). Modules can 

  10.   be configured to be excluded from logging.

  11. 

  12. * Search Log supports the search page, search block and theme search forms.

  13.   By default, logging is performed at form submit before the search results are

  14.   generated, but developers can implement a search_log hook to add additional 

  15.   entries to the log or record failed searches.

  16. 

  17. * (new) Search Log has an experimental feature to attempt to capture failed 

  18.   searches. While most content reporting revolves around identifying what is 

  19.   popular, identifying failed searches allows you to know what users are 

  20.   looking for and not finding (and then potentially going elsewhere).

  21. 

  22. * Search Log table can be truncated at a user-specified interval or kept 

  23.   indefinitely.

  24. 

  25. * Search Log reporting can be filtered by date, module and status.

  26. 

  27. * Search Log provides a configurable block of Top Searches.

  28. 

  29. 

  30. Prerequisites

  31. -------------

  32. Search module.

  33. 

  34. 

  35. Usage

  36. -------------

  37. After enabling the module, Search Log is configured at:

  38. admin/settings/search

  39. 

  40. The improved Search log can be viewed at: 

  41. admin/reports/search

  42. 

  43. The Top Searches block can be enabled and configured at:

  44. admin/build/block

  45. 

  46. 

  47. Bugs/Features/Patches:

  48. ----------------------

  49. If you want to report bugs, feature requests, or submit a patch, please do so 

  50. at the project page on the Drupal web site.

  51. http://drupal.org/project/search_log

  52. 

  53. 

  54. Author

  55. ------

  56. John Money

  57. ossemble LLC.

  58. http://ossemble.com

  59. 

  60. Module development sponsored by Consumer Search, a service of About.com, a part 

  61. of The New York Times Company.

  62. http://www.consumersearch.com