About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
configuration:search_customization

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
configuration:search_customization [2015/12/14 20:43] – ↷ Links adapted because of a move operation demiankatzconfiguration:search_customization [2021/08/03 13:57] (current) demiankatz
Line 2: Line 2:
  
 Starting with VuFind 1.0RC2, the search options available to your users are completely customizable through configuration files. Starting with VuFind 1.0RC2, the search options available to your users are completely customizable through configuration files.
- 
-If you are using an earlier version of VuFind, we strongly recommend upgrading.  However, if you need information on customizing 1.0RC1 and earlier, see [[http://www.vufind.org/wiki/searches_customizing_tuning_adding?rev=1249657570|this earlier version of the page]]. 
- 
  
 ===== Defining Search Types ===== ===== Defining Search Types =====
  
-The available search types are defined in a file called searchspecs.yaml.  This file may be found in the web/conf directory in VuFind 1.x; in VuFind 2.x, default settings are found in config/vufind and may be copied and customized in the config/vufind subdirectory of your [[configuration:local_settings_directory|local settings directory]].+The available search types are defined in a file called searchspecs.yaml.  This file may be found in config/vufind and may be copied and customized in the config/vufind subdirectory of your [[configuration:local_settings_directory|local settings directory]].
  
 [[http://www.yaml.org/|YAML]] is a text file format for storing data that is a little more flexible than the standard .ini files used by most of VuFind.  Don't be intimidated -- most simple changes can be made without needing a deep understanding of how YAML works, and most new searches you will need can be created by copying some of the samples provided with the default VuFind installation. [[http://www.yaml.org/|YAML]] is a text file format for storing data that is a little more flexible than the standard .ini files used by most of VuFind.  Don't be intimidated -- most simple changes can be made without needing a deep understanding of how YAML works, and most new searches you will need can be created by copying some of the samples provided with the default VuFind installation.
Line 39: Line 36:
 ===== Search Interface Customization ===== ===== Search Interface Customization =====
  
-A file called [[:searches.ini]] is used to control which of the search types defined in searchspecs.yaml are used by VuFind.  The [Basic_Searches] section defines which search options are displayed in the basic search box found on most pages of the interface.  The [Advanced_Searches] section defines which search options are displayed on the Advanced Search screen.  You can adjust the order in both areas to meet your needs.  Note that if you are working in a multi-language environment, you will need to create translations for any text you enter into searches.ini in the language files found in the web/lang directory.+A file called [[configuration:files:searches.ini]] is used to control which of the search types defined in searchspecs.yaml are used by VuFind.  The [Basic_Searches] section defines which search options are displayed in the basic search box found on most pages of the interface.  The [Advanced_Searches] section defines which search options are displayed on the Advanced Search screen.  You can adjust the order in both areas to meet your needs.  Note that if you are working in a multi-language environment, you will need to create translations for any text you enter into searches.ini in the language files found in the web/lang directory.
  
 ===== Other Customizable Options ===== ===== Other Customizable Options =====
  
-The [General] section of [[:searches.ini]] allows some additional customization of search-related features:+The [General] section of [[configuration:files:searches.ini]] allows some additional customization of search-related features:
  
   * The case_sensitive_bools setting lets you choose whether boolean operators in the search string must be ALL UPPERCASE in order to be recognized (true) or if they will be used regardless of case (false).  The default setting is true.   * The case_sensitive_bools setting lets you choose whether boolean operators in the search string must be ALL UPPERCASE in order to be recognized (true) or if they will be used regardless of case (false).  The default setting is true.
   * The default_handler setting lets you specify which of the searches from searchspecs.yaml is used by default when no other handler is chosen.   * The default_handler setting lets you specify which of the searches from searchspecs.yaml is used by default when no other handler is chosen.
  
 +===== Related Video =====
 +
 +Some of the topics from this page are also covered in the [[videos:configuring_search_and_facet_settings|Configuring Search and Facet Settings]] video.
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
configuration/search_customization.1450125829.txt.gz · Last modified: 2015/12/14 20:43 by demiankatz