From aae5e38b05748bc63dccbef0c20f35cf1e097cb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Lahmann?= <lahmann@ub.uni-leipzig.de> Date: Wed, 3 Dec 2014 14:24:22 +0100 Subject: [PATCH] added standard searches.ini to local/config/vufind-folder due to dependency in local/dev/config/vufind/searches.ini.sample --- local/config/vufind/searches.ini | 525 +++++++++++++++++++++++++++++++ 1 file changed, 525 insertions(+) create mode 100644 local/config/vufind/searches.ini diff --git a/local/config/vufind/searches.ini b/local/config/vufind/searches.ini new file mode 100644 index 00000000000..41238e7ecef --- /dev/null +++ b/local/config/vufind/searches.ini @@ -0,0 +1,525 @@ +; This section contains global settings affecting search behavior. +[General] +default_handler = AllFields ; Search handler to use if none is specified + +; This setting controls the default sort order of search results if no search- +; specific setting was present in the [DefaultSortingByType] section below; the +; selected option should be one of the options present in the [Sorting] section +; below. +default_sort = relevance + +; This setting controls the default view for search results; the selected option +; should be one of the options present in the [Views] section below. +default_view = list + +; This section controls the result limit options for search results. default_limit +; sets the default number of results per page. limit_options is a comma-separated +; list of numbers to be presented to the end-user. If only one limit is required, +; set default_limit and leave limit_options commented out. +; WARNING: using large limits may require you to raise your PHP memory limits to +; avoid errors. +default_limit = 20 +;limit_options = 10,20,40,60,80,100 + +; If this setting is true, boolean operators in searches (AND/OR/NOT) will only +; be recognized if they are ALL UPPERCASE. If set to false, they will be +; recognized regardless of case. If set to a comma-separated list of operators +; (e.g. "AND,NOT") then only the listed operators will be case-sensitive. +case_sensitive_bools = true + +; If this setting is true, range operators in searches ([a TO b] or {a TO b}) +; will only be recognized if the word "TO" is ALL UPPERCASE. Additionally, the +; edges of the range may be treated in a case sensitive manner. If set to false, +; ranges will be recognized regardless of case -- this will allow better matching +; at the cost of a bit of extra server-side processing. +case_sensitive_ranges = true + +; These are the default recommendations modules to use when no specific setting +; are found in the [TopRecommendations], [SideRecommendations] or +; [NoResultsRecommendations] sections below. +; See the comments above those sections for details on legal settings. You may +; repeat these lines to load multiple recommendations. +default_top_recommend[] = TopFacets:ResultsTop +;default_top_recommend[] = VisualFacets:Visual_Settings +default_side_recommend[] = SideFacets:Results:CheckboxFacets +default_noresults_recommend[] = SwitchType +default_noresults_recommend[] = SwitchQuery + +; Set this to true in order to highlight keywords from the search query when they +; appear in fields displayed in search results. +highlighting = true + +; Set this to restrict the list of fields that will be highlighted (the hl.fl +; Solr parameter); default = '*' for all fields: +;highlighting_fields = * + +; Set this to true in order to include a text snippet in the search results when +; a keyword match is found in a field that is not normally displayed as part of +; the listing. For finer control over which fields are used for snippets, see +; the record driver code (web/RecordDrivers/IndexRecord.php). +; +; For control over snippet captions, see the [Snippet_Captions] section below. +snippets = true + +; When you filter a search using facets, VuFind will present a checkbox that can +; be used to apply those filters to the next search you perform. This setting +; controls its default state: on (true) or off (false). +retain_filters_by_default = true + +; The filters listed below will be applied to all new searches by default. Omit +; this setting to have no default filters applied. These differ from hidden +; filters because they are visible in the UI and may be removed by the user. +;default_filters[] = "format:Book" +;default_filters[] = "institution:MyInstitution" + +[Cache] +; This controls whether the parsed searchspecs.yaml file will be stored to +; improve search performance; legal options are APC (use APC cache), File (store +; on disk) or false (do not cache). +type = File + +; This section shows which search types will display in the basic search box at +; the top of most pages. The name of each setting below corresponds with a +; search handler (either DisMax or from conf/searchspecs.yaml). The value of +; each setting is the text to display on screen. All on-screen text will be run +; through the translator, so be sure to update language files if necessary. The +; order of these settings will be maintained in the drop-down list in the UI. +; +; Note: The search type of "tag" is a special case that gets handled differently +; because tags are not stored in the same index as everything else. Treat +; this as a reserved word if you create your own custom search handlers. +[Basic_Searches] +AllFields = "All Fields" +Title = Title +;JournalTitle = "Journal Title" +Author = Author +Subject = Subject +CallNumber = "Call Number" +ISN = "ISBN/ISSN" +tag = Tag + +; This section defines which search options will be included on the advanced +; search screen. All the notes above [Basic_Searches] also apply here. +[Advanced_Searches] +AllFields = adv_search_all +Title = adv_search_title +;JournalTitle = adv_search_journaltitle +Author = adv_search_author +Subject = adv_search_subject +CallNumber = adv_search_callnumber +ISN = adv_search_isn +publisher = adv_search_publisher +Series = adv_search_series +year = adv_search_year +toc = adv_search_toc + +; This section defines the sort options available on standard search results. +; Values on the left of the equal sign are either the reserved term "relevance" +; or the name of a Solr index to use for sorting; asc and desc modifiers may be +; used in combination with index names, but not relevance. To allow secondary +; sorting, you may include a comma-separated list of options (for example, +; "year desc,title asc"), but this list may NOT include the special "relevance" +; value. Values on the right of the equal sign are text that will be run +; through the translation module and displayed on screen. +; +; Note: "year", "author" and "title" are special shortcut aliases for the +; "publishDateSort", "authorStr" and "title_sort" Solr fields; you can use +; either form in this file. +[Sorting] +relevance = sort_relevance +year = sort_year +year asc = "sort_year asc" + +; Use the "callnumber" line for LC or the "dewey-sort" line for Dewey Decimal. +; If you want to enable both systems for sorting, you can uncomment both lines, +; but you will need to add some custom text to distinguish between the two. +callnumber = sort_callnumber +;dewey-sort = sort_callnumber + +author = sort_author +title = sort_title + +; This section allows you to specify the default sort order for specific types of +; searches. Each key in this section should correspond with a key in the +; [Basic_Searches] section above. Each value should correspond with a key in the +; [Sorting] section above. Any search type that is not listed here will be sorted +; using the default_sort setting in the [General] section above. +[DefaultSortingByType] +CallNumber = callnumber + +; Each search type defined in searchspecs.yaml can have one or more "recommendations +; modules" associated with it in the following sections. These plug-ins will cause +; boxes of suggestions to appear beside (in [SideRecommendations]) or above (in +; [TopRecommendations]) the search results. The special [NoResultsRecommendations] +; are only displayed for empty search results. You can repeat the line to display a +; series of recommendations boxes in a particular section -- just be sure to include +; brackets ("[]") after the search type name. If you do not want recommendations +; for a particular search type, set the value to "false" in either or both sections. +; Any search types not listed here will use the default value -- see the +; default_top_recommend and default_side_recommend settings in the [General] +; section above. It is legal to set the default options to false if you want no +; default value. +; +; Available modules recommended for use in the side area: +; +; CatalogResults:[GET parameter]:[result limit] +; Display catalog search results matching the terms found in the specified +; GET parameter (default = "lookfor"), limited to a specified number of +; matches (default = 5). This is designed for use with non-catalog modules. +; EuropeanaResults:[url]:[requestParam]:[limit]:[unwanted data providers] +; Display search results from Europeana.eu API. [url] is the base search URL +; default "api.europeana.eu/api/opensearch.rss" [requestParam] parameter name +; for passing lookup value in url, default is "searchTerms" [limit] defaults to +; 5, is the number of result items to display [unwanted data providers] comma +; separated list of dataproviders to ignore results from; useful for excluding +; own results that are also in Europeana. An API key must be set in config.ini +; (see europeanaAPI setting in [Content] section). +; EuropeanaResultsDeferred: [url]:[requestParam][limit]:[unwanted data providers] +; See EuropeanaResults, but this version uses AJAX. +; ExpandFacets:[ini section]:[ini name] +; Display facets listed in the specified section of the specified ini file; +; if [ini name] is left out, it defaults to "facets." Rather than using +; facets to limit the existing search, this module uses them to start a new +; search showing all records matching the selected facet value. +; FacetCloud:[ini section]:[ini name] +; Same functionality as ExpandFacets, but with a more compact interface to +; allow the display of more values. +; OpenLibrarySubjects:[GET parameter]:[limit]:[date filter]:[Subject types] +; Display full-text, public scans from the Open Library (OL) Subjects API. +; [GET parameter] (default = "lookfor"), [limit] (default = 5), +; [date filter] The name of a date filter (from facet settings) to apply to +; searches. Defaults to "publishDate" if blank; set to "false" to disable. +; [Subject types] (default = "topic") comma-separated list of subject types to +; test. Open Library distinguishes between the following subject types: +; topic,place,person,time +; Note: an API call will be made for each type until valid data is returned +; which will slow down the loading of the main VuFind result set, +; see OpenLibrarySubjectsDeferred +; OpenLibrarySubjectsDeferred:[GET parameter]:[limit]:[date filter]:[Subject types] +; The same as OpenLibrarySubjects but uses AJAX to make the API calls after the +; main result set has loaded +; RandomRecommend:[backend]:[limit]:[display mode]:[random mode]:[minimumset] +; :[facet1]:[facetvalue1]:[facet2]:[facetvalue2]:...:[facet-n]:[facetvalue-n] +; This module offers random records either from the whole backend or within +; the current resultset. +; [backend] is the name of the search backend currently in use, +; which will help with accurate analysis (default = Solr) +; [limit] is the number of records to display (default = 10) +; [display mode] determines how the records are displayed. Valid values are +; "standard" (for a basic display including titles and authors), +; "images" for just images or "mixed" for both. (default = standard) +; [random mode] determines if the records are selected from the entire backend +; or from the current result set. Valid values are "retain" to limit results +; to the current result set or "disregard" to use the entire backend. +; (default = retain) +; [minimumset] is the minimum result set count required to display random items, +; 0 = no minimum required. This setting can be used to prevent random items +; displaying in a small result set. (default = 0) +; [facet-n] A facet to apply to the random selection +; [facetvalue-n] The facet value to apply to the random selection +; SideFacets:[regular facet section]:[checkbox facet section]:[ini name] +; Display the specified facets, where [ini name] is the name of an ini file +; in your config directory (defaults to "facets" if not supplied), +; [regular facet section] is the name of a section of the ini file containing +; standard facet settings (defaults to "Results" if not specified), +; and [checkbox facet section] is the name of a section of the ini file +; containing checkbox facet settings (leave blank for no checkbox facets). +; Checkbox facets are normally in filter => label format; prefix the section +; name with ~ to reverse this and use label => filter format (useful if your +; filters contain values that are illegal in configuration keys -- e.g. []). +; SummonBestBets:[GET parameter] +; Display Summon-generated "best bets" recommendations matching the terms found +; in the specified GET parameter. NOTE: If you are using this module with a +; Summon search, the [GET parameter] setting will be ignored and the actual +; current Summon search will be used instead. The parameter only needs to be +; specified when combining this module with a non-Summon-based search module. +; SummonBestBetsDeferred:[GET parameter] +; Same as SummonBestBets, but loaded via AJAX. +; SummonDatabases:[GET parameter] +; Display Summon-generated database recommendations matching the terms found +; in the specified GET parameter. NOTE: If you are using this module with a +; Summon search, the [GET parameter] setting will be ignored and the actual +; current Summon search will be used instead. The parameter only needs to be +; specified when combining this module with a non-Summon-based search module. +; SummonDatabasesDeferred:[GET parameter] +; Same as SummonDatabases, but loaded via AJAX. +; SummonResults:[GET parameter]:[result limit] +; Display Summon search results matching the terms found in the specified +; GET parameter (default = "lookfor"), limited to a specified number of +; matches (default = 5). +; SummonResultsDeferred:[GET parameter]:[result limit] +; Same as SummonResults, but loaded via AJAX. +; SummonTopics:[GET parameter] +; Display Summon-generated topic recommendations matching the terms found +; in the specified GET parameter. NOTE: If you are using this module with a +; Summon search, the [GET parameter] setting will be ignored and the actual +; current Summon search will be used instead. The parameter only needs to be +; specified when combining this module with a non-Summon-based search module. +; WebResults:[GET parameter]:[result limit] +; Display website search results matching the terms found in the specified +; GET parameter (default = "lookfor"), limited to a specified number of +; matches (default = 5). This requires the website Solr core to be active. +; +; Available modules recommended for use in the top area: +; +; AuthorFacets +; Display author names based on the search term. +; AuthorInfo:[use_viaf] +; Load author information from external providers based on the current search +; and the "authors" setting in the [Content] section of config.ini. +; The [use_viaf] setting may be set to true to use the VIAF web service in +; combination with your Solr authority index to pick more appropriate authors; +; this defaults to false if unset. If you do not have local authority records +; to draw on, the OCLC FAST data works well with the [use_viaf] option; see: +; http://vufind.org/wiki/open_data_sources#oclc_fast +; AuthorityRecommend:[field1]:[query1]:[field2]:[query2]:...:[field-n]:[query-n] +; Displays see and see also results to user based on search of Authority Index. +; Any number of filter queries may be specified as parameters to limit which +; set of authority records is used for recommendations; for example: +; AuthorityRecommend:record_type:Heading* OR Topical*:source:LCNAF +; limits record_type to strings starting with "Heading" or "Topical" and +; limits source to LCNAF. A special field name of "__resultlimit__" may be +; used to suppress authority results when the result set contains more items +; than the number specified as the corresponding value (e.g. if you configure +; AuthorityRecommend:__resultlimit__:50 then authority recommendations will +; only display on result screens displaying fewer than 50 hits; by default, +; recommendations will always display). Filtering is optional. +; PubDateVisAjax:[zooming]:[facet field 1]:[facet field 2]:...:[facet field n] +; Display a visualization of publication dates for each of the specified facet +; fields. This is designed for a field containing four-digit years. Zooming +; is set to either true or false and controls whether or not selecting part of +; the graph zooms in to greater detail. +; ResultGoogleMapAjax:[facets] +; Show a Google Map with markers for all result items which have long/latitude +; data (be sure to turn on location indexing in import/marc_local.properties). +; Each marker will show the number of items which are in the long_lat +; facet. A separate call is made when a marker is clicked to retrieve the +; first 5 records on that location facet. The map uses clustering to +; combine markers where there are more than one marker close together into +; clusters. The facets parameter is the name of the extra config file which +; holds the facet information(default "facets.ini"). +; TopFacets:[ini section]:[ini name] +; Display facets listed in the specified section of the specified ini file; +; if [ini name] is left out, it defaults to "facets." +; VisualFacets:[ini section]:[ini name] +; Supports visualizing pivot facet information as a treemap or circle +; packing visualization. It must be used in combination with the "visual" +; view in the [Views] section below -- it will only display in Visual mode. +; WorldCatIdentities +; Use the WorldCat Identities API to find names and related subjects based +; on the current search. +; WorldCatTerms:[vocabulary] +; Use the WorldCat Terminologies API to find Library of Congress Subject +; Headings related to the current search. [vocabulary] is the vocabulary to +; use for recommendations; default is "lcsh" but other options include "fast", +; "mesh", etc. See http://tspilot.oclc.org/resources/ for details. +; +; Available modules recommended for use in the "no results" area: +; +; SwitchQuery:[backend]:[checks to skip] +; This module analyzes the user's query and offers suggestions for ways to +; improve it. [backend] is the name of the search backend currently in use, +; which will help with accurate analysis (default = Solr). [checks to skip] +; is a comma-separated list of checks to disable; see the check*() methods +; in the module's code for a complete list of available checks. +; SwitchType:[field]:[field description] +; If the current search type is not the same as [field], display a link +; suggesting that the user try switching to [field]. [field description] +; is the human-readable description of [field]. Default values are +; 'AllFields' and 'All Fields' respectively. +; +; You can build your own recommendations modules if you wish. See the developer's +; guide here: +; +; http://vufind.org/wiki/vufind2:recommendation_modules +[SideRecommendations] +; No search-specific settings by default -- add your own here. +;Subject[] = SideFacets +;Subject[] = OpenLibrarySubjectsDeferred:lookfor:5:true:topic,place,person,time + +[TopRecommendations] +Author[] = AuthorFacets +;Author[] = WorldCatIdentities +;Subject[] = WorldCatTerms + +[NoResultsRecommendations] + +; These settings control the top and side recommendations within the special Author +; module (the page accessed by clicking on an author's name within the search +; results). The Author module ignores the default_top_recommend and +; default_side_recommend settings and only uses this section. +[AuthorModuleRecommendations] +;top[] = TopFacets:ResultsTop +;side[] = SideFacets:Results:CheckboxFacets +top[] = AuthorInfo +side[] = "ExpandFacets:Author" + +; This section controls the "New Items" search. +[NewItem] +; New item information can be retrieved from Solr or from the ILS; this setting +; controls which mechanism is used. If using Solr, change tracking must be enabled +; (see https://vufind.org/wiki/tracking_record_changes). If using the ILS, your +; driver must support the getNewItems() method. +; Valid options: ils, solr; default: ils +method = ils +; Comma-separated list of date ranges to offer to the user (i.e. 1,5,30 = one day +; old, or five days old, or thirty days old). If using the "ils" method, be careful +; about raising the maximum age too high -- searching very long date ranges may put +; a load on your ILS. +ranges = 1,5,30 +; This setting only applies when using the "ils" method. It controls the maximum +; number of pages of results that will show up when doing a new item search. +; It is necessary to limit the number of results to avoid getting a "too many boolean +; clauses" error from the Solr index (see notes at +; http://vufind.org/jira/browse/VUFIND-128 for more details). However, if you +; set the value too low, you may get the same results no matter which range setting +; is selected! +result_pages = 10 +; This setting can be used to automatically apply filter queries to the New Item +; results. For example, you might want to filter out certain content types. You +; can add multiple filters by repeating the "filter[] =" line, or you can skip +; filtering entirely by leaving the line commented out. +; filter[] = "format:Book" + +; This section controls RSS feed behavior +[RSS] +; If set, this setting will override sort settings associated with RSS feeds. This +; allows you to ensure that newly added or changed items in your index appear at +; the top of the feed. Use "first_indexed desc" if you only want newly-added items +; to be listed first. Use "last_indexed desc" if you want newly-added-or-changed +; items. Comment out the whole setting if you do not want custom RSS sorting. +; IMPORTANT: In order for first_indexed and last_indexed sorting to work properly, +; you need to index record change dates; see the Wiki page at +; http://vufind.org/wiki/tracking_record_changes +sort = "last_indexed desc" + +; The following two sections control the behavior of the autocomplete drop-downs +; associated with search boxes. The [Autocomplete] section contains global default +; settings, while the [Autocomplete_Types] section allows you to associate different +; autocomplete handlers with different search handlers. +; +; The available autocomplete handlers are: +; +; None +; Do not provide any suggestions. You should use this handler if you want to +; disable suggestions for one search type while still providing suggestions +; for other search types. To disable suggestions completely, it is better to +; use the "enabled" setting in the [Autocomplete] section. +; SolrAuth:[Search Handler]:[Display Field]:[Sort Field]:[Filters] +; See Solr below -- this handler behaves exactly the same, except +; it uses the Solr authority data index rather than the bibliographic index, +; and its default [Display Field] value is "heading". +; Solr:[Search Handler]:[Display Field]:[Sort Field]:[Filters] +; Perform a wildcarded search against [Search Handler], using the contents of +; [Display Field] (a comma-separated, priority-ordered field list) as +; suggestions and sorting by [Sort Field]. Any additional parameters at the +; end of the string are treated as an alternating sequence of field names and +; values for use as filters against the suggestion list. All parameters are +; optional. If omitted, [Search Handler] will use the default Solr field, +; [Display Field] will use "title", [Sort Field] will use relevance and no +; filters will be applied. +; SolrCN +; A customized version of Solr designed for smart handling of +; call numbers using the custom CallNumber search handler. +; Tag +; Provide suggestions from the local database of tags. +; +; You can build your own autocomplete modules if you wish. See the developer's +; guide here: +; +; http://vufind.org/wiki/vufind2:autosuggesters +[Autocomplete] +; Set this to false to disable all autocomplete behavior +enabled = true +; This handler will be used for all search types not covered by [Autocomplete_Types] +default_handler = Solr + +; In this section, set the key equal to a search handler from searchspecs.yaml and +; the value equal to an autocomplete handler in order to customize autocompletion +; behavior when that search type is selected. +[Autocomplete_Types] +Title = "Solr:Title" +JournalTitle = "Solr:JournalTitle" +Author = "Solr:Author:author,author2" +Subject = "Solr:Subject:topic,genre,geographic,era" +CallNumber = "SolrCN" +ISN = "Solr:ISN:isbn,issn" +tag = "Tag" + +; When snippets are enabled, this section can be used to display captions based on +; the Solr fields from which the snippets were obtained. Keys are the names of Solr +; fields and values are strings to display to the user. Note that all displayed +; strings are subject to translation and should be accounted for in the language +; files found in web/lang if you are in a multilingual environment. Fields that are +; not listed in this section will be displayed without captions, so you can comment +; out the whole section to disable captions. +[Snippet_Captions] +author2 = "Other Authors" +contents = "Table of Contents" +topic = "Subjects" +container_title = "Journal Title" + +; This section allows sharding to be used to pull in content from additional Solr +; servers. All servers used in sharding must contain the same index fields needed +; to satisfy queries sent to them AND they must all include different ID numbers! +; Leave this commented out to disable sharding. +; To use sharding, simply fill in lines using the format: +; [display name of shard] = [URL of shard (without http://)] +;[IndexShards] +;Library Catalog = localhost:8080/solr/biblio +;Website = localhost:8080/solr/website + +; This section allows you to set preferences for shards display. You only need to +; set these if you want to use shards. See also the [StripFields] section below +; if your shards have non-identical schemas. +;[ShardPreferences] +; This setting controls whether or not to display checkboxes to allow the user to +; select which shard(s) to search (default if commented out = false) +;showCheckboxes = true +; These lines determine which shards are searched by default if the user hasn't +; specified preferences using checkboxes (default if commented out = all shards): +;defaultChecked[] = "Library Catalog" +;defaultChecked[] = "Website" + +; Fields must be stripped if you have a field in your main index which is missing +; from any index includable by shards. This section can be ignored if you are +; not using sharding or if all of your shards have identical schemas. +; +; Put in the fields to strip here in the following format: +; shard name = fieldname,another fieldname,... +[StripFields] + +; This section defines the view options available on standard search results. +; If only one view is required, set default_view under [General] above, and +; leave this section commented out. +; +; Note -- when using visual view, you must also turn on the VisualFacets +; recommendation module in the top area. +;[Views] +;list = List +;grid = Grid +;visual = Visual + +; This section allows for adding hidden filters. Each filter will be translated +; to format 'key:"value"' and added by Solr.php as a hidden filter (a facet that +; is always applied but is not seen by the user). This is useful if you use a +; shared Solr index and need to display different subsets in different contexts +; (for example, a union catalog with separate VuFind instances each member). +[HiddenFilters] +;institution = "MyInstitution" + +; This section is an alternative to [HiddenFilters] when you need to create more +; advanced types of filters -- i.e. complex boolean queries. Keys are ignored, +; but increasing numeric values (1, 2, 3...) are recommended. Values are fully- +; formed filter queries. +[RawHiddenFilters] +;0 = "format:\"Book\" OR format:\"Journal\"" +;1 = "language:\"English\" OR language:\"French\"" + +; This section defines how records are handled when being fetched from Solr. +;[Records] +; Boolean value indicating if deduplication is enabled. Defaults to false. +;deduplication = true +; Priority order (descending) for record sources (record ID prefixes separated +; from the actual record by period, e.g. testsrc.12345) +;sources = alli,testsrc -- GitLab