You are here

Home » API reference » Search configuration 8

README.txt in Search configuration 8

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
  3. 7 README.txt
INTRODUCTION
============

The Search Configuration module has two primary functions, to alter how the
search form is rendered and to provide restrictions on the content that is
exposed when searching.

 * For a full description of the module, visit the project page:
   https://drupal.org/project/search_config

 * To submit bug reports and feature suggestions, or to track changes:
   https://drupal.org/project/issues/search_config


DESCRIPTION
===========

The basic functionality of this module is to configure the search forms so as to give an easy user interface for the
users during the search mechanism.

The key features are listed below:

 * Remove the basic search form if advanced search form is present.
 * Move the basic keyword search to advanced search form.
 * Options to override advanced forms fieldset.
 * Options to specify the relative positions of the field labels. i.e, either the default or below the field or in the
   hidden state.
 * Options to alter the field labels of the basic and the advanced search forms.
 * Options to select the users who can access various fields.
 * Replace the type options with custom type groups.
 * Options to alter the pager limit.

This module has been ported to Drupal 8 as part of the Google Summer of Code 2016 project.

PREREQUISITES
=============

Search module (Drupal core).

INSTALLATION
============

Standard module installation.

See https://www.drupal.org/docs/7/extending-drupal/overview for further information.

CONFIGURATION
============

* Form Appearance

  Navigate to Administration » Configuration » Search pages »

  "Labels and string overrides" fieldset

  This section allows you to configure the field labels. Options include:
    - alter the field titles of the basic and advanced search forms
    - title position. These can be positioned above (default), below or hidden

  You can basically see two configuration options: Labels and string overrides and Additional node search configuration.
  The labels and string overrides is to configure the field labels. You have options to alter the field titles of the
  basic and advanced search forms.

  You also have the liberty to specify the relative position of the field title. It can be above the field (the
  default format), below the field or in the hidden state.

  Additional node search configuration configures the additional features and make this module more lively. Once you
  select the additional node search configuration option, you have the options to deal with form control, removing
  ... keyword options, selecting the roles who can see the fields, replacing type option with custom type groups and
  setting the pager limit.

  Form control allows you to configure the search form in such a way that only one form is displayed at a given instant.
  This is achieved by selecting the checkbox 'Only show one form at a time.' in the form control. Another option is to
  move the basic keyword search to advanced search form.

  You can also replace the type option available with custom type groups. i.e, you can search based on content types of
  your choice. This is done by adding the required content type in the field 'Replace type options with custom type
  groups'.

  You could also configure the maximum number of results to be displayed in a page. You can select the value of your
  choice from the drop down menu of 'Pager limit' in the results section.

* Configure user permissions

  Navigate to Administration » People » Permissions:

  - Exclude nodes from search results

    This allows users with this permission to flag content as not to be searched.

    You can select the roles who can view particular fieldset.
    There are basically three types of roles; Anonymous user, Authenticated user and the Administrator. You could
    set the privileges to be assigned to the various types of users through this search configuration tool.


MAINTAINERS
============

Current maintainers:
Naveen Valecha - <https://www.drupal.org/u/naveenvalecha>
Joyce George - <https://www.drupal.org/u/joyceg>

Past maintainers:
Joseph Yanick - https://www.drupal.org/u/jbomb

File

README.txt
View source 
  1. INTRODUCTION

  2. ============

  3. 

  4. The Search Configuration module has two primary functions, to alter how the

  5. search form is rendered and to provide restrictions on the content that is

  6. exposed when searching.

  7. 

  8.  * For a full description of the module, visit the project page:

  9.    https://drupal.org/project/search_config

  10. 

  11.  * To submit bug reports and feature suggestions, or to track changes:

  12.    https://drupal.org/project/issues/search_config

  13. 

  14. 

  15. DESCRIPTION

  16. ===========

  17. 

  18. The basic functionality of this module is to configure the search forms so as to give an easy user interface for the

  19. users during the search mechanism.

  20. 

  21. The key features are listed below:

  22. 

  23.  * Remove the basic search form if advanced search form is present.

  24.  * Move the basic keyword search to advanced search form.

  25.  * Options to override advanced forms fieldset.

  26.  * Options to specify the relative positions of the field labels. i.e, either the default or below the field or in the

  27.    hidden state.

  28.  * Options to alter the field labels of the basic and the advanced search forms.

  29.  * Options to select the users who can access various fields.

  30.  * Replace the type options with custom type groups.

  31.  * Options to alter the pager limit.

  32. 

  33. This module has been ported to Drupal 8 as part of the Google Summer of Code 2016 project.

  34. 

  35. PREREQUISITES

  36. =============

  37. 

  38. Search module (Drupal core).

  39. 

  40. INSTALLATION

  41. ============

  42. 

  43. Standard module installation.

  44. 

  45. See https://www.drupal.org/docs/7/extending-drupal/overview for further information.

  46. 

  47. CONFIGURATION

  48. ============

  49. 

  50. * Form Appearance

  51. 

  52.   Navigate to Administration » Configuration » Search pages »

  53. 

  54.   "Labels and string overrides" fieldset

  55. 

  56.   This section allows you to configure the field labels. Options include:

  57.     - alter the field titles of the basic and advanced search forms

  58.     - title position. These can be positioned above (default), below or hidden

  59. 

  60.   You can basically see two configuration options: Labels and string overrides and Additional node search configuration.

  61.   The labels and string overrides is to configure the field labels. You have options to alter the field titles of the

  62.   basic and advanced search forms.

  63. 

  64.   You also have the liberty to specify the relative position of the field title. It can be above the field (the

  65.   default format), below the field or in the hidden state.

  66. 

  67.   Additional node search configuration configures the additional features and make this module more lively. Once you

  68.   select the additional node search configuration option, you have the options to deal with form control, removing

  69.   ... keyword options, selecting the roles who can see the fields, replacing type option with custom type groups and

  70.   setting the pager limit.

  71. 

  72.   Form control allows you to configure the search form in such a way that only one form is displayed at a given instant.

  73.   This is achieved by selecting the checkbox 'Only show one form at a time.' in the form control. Another option is to

  74.   move the basic keyword search to advanced search form.

  75. 

  76.   You can also replace the type option available with custom type groups. i.e, you can search based on content types of

  77.   your choice. This is done by adding the required content type in the field 'Replace type options with custom type

  78.   groups'.

  79. 

  80.   You could also configure the maximum number of results to be displayed in a page. You can select the value of your

  81.   choice from the drop down menu of 'Pager limit' in the results section.

  82. 

  83. * Configure user permissions

  84. 

  85.   Navigate to Administration » People » Permissions:

  86. 

  87.   - Exclude nodes from search results

  88. 

  89.     This allows users with this permission to flag content as not to be searched.

  90. 

  91.     You can select the roles who can view particular fieldset.

  92.     There are basically three types of roles; Anonymous user, Authenticated user and the Administrator. You could

  93.     set the privileges to be assigned to the various types of users through this search configuration tool.

  94. 

  95. 

  96. MAINTAINERS

  97. ============

  98. 

  99. Current maintainers:

  100. Naveen Valecha - 

  101. Joyce George - 

  102. 

  103. Past maintainers:

  104. Joseph Yanick - https://www.drupal.org/u/jbomb