You are here

Home » API reference » Search configuration 6

README.txt in Search configuration 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 7 README.txt
search_config is used to configure the advanced search form.

Installation
------------

1. Copy entire search_config directory to the module directory of your Drupal 
   installation
2. Enable the search_config module on the admin modules page
3. Go to administer » Search Configuration, you should now see a 
   "Advanced search form configuration" collapsed fieldset.


General Information
-------------------

This module started out as a simple means of configuring the *display* of the
advance search form. A few features have been added since thanks to the
contributions of others.

In simple use cases the search_config module allows site admins to decide which 
fields to display on the advanced search form when enabled. This does not stop 
astute users from entering the search criteria directly into the search text 
fields. There is also the option of selecting which node types not to index.
Once selected they are also automatically removed from the advance search
form. This gives more control over the content that can be searched to those
who need it. 

Search config now has the option of choosing which search implementation
should be the default, for example, "content", "user", "apachesolr", etc. The 
regular "content" search provided by the node module is selected by default.

Three new permissions are also provided, these simple control the display of
fields per role and is useful if fields should not be removed globally from
the form.

The following fields or selected members of their groups can removed from the 
form globally or on role by role basis:

 - keywords
 - categories
 - node types

Some of what this module does can also be achieved by theming the form. 

Removing nodes from the search index
------------------------------------

A feature offered by this module is to stop the indexing of specific node types.
There is no easy way to do this is Drupal. Items can be removed from the search
index though and this was the original method that was used. This worked by
deleting values of the selected type from the search index using the
search_wipe function in hook_update_index. This proved problematic, especially
in cases where search_config was installed on a site with a lot of content. No
throttling was enabled in the hook and this caused cron to crash. It also
posed the problem of search_config playing catch-up in removing the items from
the index since there was no way to prevent them from getting there in the
first place. I gave up on this approach. 

Items are no longer removed from the index but instead hook_db_rewrite_sql is
used to prevent select content types from showing up in search results. This
is a ugly and hack but it provides the desired result. If you want to help solve
this issue of preventing indexing of content plese see this issue: 
http://drupal.org/node/111744

File

README.txt
View source 
  1. 

  2. search_config is used to configure the advanced search form.

  3. 

  4. Installation

  5. ------------

  6. 

  7. 1. Copy entire search_config directory to the module directory of your Drupal 

  8.    installation

  9. 2. Enable the search_config module on the admin modules page

  10. 3. Go to administer » Search Configuration, you should now see a 

  11.    "Advanced search form configuration" collapsed fieldset.

  12. 

  13. 

  14. General Information

  15. -------------------

  16. 

  17. This module started out as a simple means of configuring the *display* of the

  18. advance search form. A few features have been added since thanks to the

  19. contributions of others.

  20. 

  21. In simple use cases the search_config module allows site admins to decide which 

  22. fields to display on the advanced search form when enabled. This does not stop 

  23. astute users from entering the search criteria directly into the search text 

  24. fields. There is also the option of selecting which node types not to index.

  25. Once selected they are also automatically removed from the advance search

  26. form. This gives more control over the content that can be searched to those

  27. who need it. 

  28. 

  29. Search config now has the option of choosing which search implementation

  30. should be the default, for example, "content", "user", "apachesolr", etc. The 

  31. regular "content" search provided by the node module is selected by default.

  32. 

  33. Three new permissions are also provided, these simple control the display of

  34. fields per role and is useful if fields should not be removed globally from

  35. the form.

  36. 

  37. The following fields or selected members of their groups can removed from the 

  38. form globally or on role by role basis:

  39. 

  40.  - keywords

  41.  - categories

  42.  - node types

  43. 

  44. Some of what this module does can also be achieved by theming the form. 

  45. 

  46. Removing nodes from the search index

  47. ------------------------------------

  48. 

  49. A feature offered by this module is to stop the indexing of specific node types.

  50. There is no easy way to do this is Drupal. Items can be removed from the search

  51. index though and this was the original method that was used. This worked by

  52. deleting values of the selected type from the search index using the

  53. search_wipe function in hook_update_index. This proved problematic, especially

  54. in cases where search_config was installed on a site with a lot of content. No

  55. throttling was enabled in the hook and this caused cron to crash. It also

  56. posed the problem of search_config playing catch-up in removing the items from

  57. the index since there was no way to prevent them from getting there in the

  58. first place. I gave up on this approach. 

  59. 

  60. Items are no longer removed from the index but instead hook_db_rewrite_sql is

  61. used to prevent select content types from showing up in search results. This

  62. is a ugly and hack but it provides the desired result. If you want to help solve

  63. this issue of preventing indexing of content plese see this issue: 

  64. http://drupal.org/node/111744 

  65.