Commit 06f126e8 authored by Nesta Campbell's avatar Nesta Campbell
Browse files

Updated documentation to reflect the current set of features

parent 468b681b
......@@ -9,3 +9,36 @@ Installation
2. Enable the search_config module on the admin modules page
3. Go to administer » settings » search, 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.
......@@ -3,27 +3,9 @@
/**
* @file
* Allows admins to configure the advanced search form.
* Used to configure the advanced search form and other search behaviour.
*
* In general the search_config module allows users to decide which fields
* to show on the advanced search form. This does not stop astute users from
* placing the search criteria directly in the search text fields. The module
* also provides three (3) new permissions but for the time being won't do much
* good.
*
* You also have the option of selecting which node types not to index. These are
* also automatically removed from the search form.
*
* Admins will be able to decide if the following fields or selected members
* of their groups are removed from the search form.
* - keywords
* - categories
* - node types
*
* What this module achieves at the moment can also be achieved by theming the
* search form. Also, it does not control what can be searched.
*
* @author Nesta Campbell
* @author Nesta Campbell <nesta.campbell@gmail.com>
* @todo Look at multiple hierarchy taxonomies
*
*/
......@@ -31,9 +13,7 @@
/**
* Implementation of hook_perm()
*
* At the moment this module does not control access to what can be searched,
* only what fields are displayed to the user. Therefore, these permissions
* don't really do much but allow the displaying of form fields per role.
* Allow the displaying of form fields per role.
*/
function search_config_perm() {
return array('search by node type', 'search by category', 'use keyword search');
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment