-
Notifications
You must be signed in to change notification settings - Fork 355
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial implementation of EDS support.
- Some contributions by Joe Atzberger, Chris Hallberg and Demian Katz. - Resolves VUFIND-636.
- Loading branch information
1 parent
ebdcf34
commit c88529d
Showing
78 changed files
with
6,832 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,183 @@ | ||
; This section contains global settings affecting search behavior. | ||
[General] | ||
; This setting controls the default sort order of search results; the selected | ||
; option should be one of the options present in the [Sorting] section below. | ||
default_sort = relevance | ||
limit_options = 5,10,20,30,40,50 | ||
default_limit = 20 | ||
include_facets = y | ||
highlighting = y | ||
;common limiters are select type limiters to display on the basic search screen | ||
common_limiters = FC,FT,RV | ||
common_expanders = fulltext | ||
default_view = brief | ||
|
||
; These are the default recommendations modules to use when no specific setting | ||
; are found in the [TopRecommendations] or [SideRecommendations] sections below. | ||
; See the comments above those sections for details on legal settings. You may | ||
; repeat these lines to load multiple recommendations. | ||
; | ||
; Right now, VuFind is configured to use all facets ON the side. You can reconfigure | ||
; this by changing the default_top_recommend setting and [Facets] / [FacetsTop] | ||
; sections below. | ||
;default_top_recommend[] = TopFacets:FacetsTop:EDS | ||
default_side_recommend[] = SideFacets:Facets:CheckboxFacets:EDS | ||
default_noresults_recommend[] = SwitchType | ||
|
||
; 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 | ||
|
||
; This is the timeout in seconds when communicating with the EDS server. | ||
timeout = 120 | ||
|
||
; The following two sections can be used to associate specific recommendations | ||
; modules with specific search types defined in the [Basic_Searches] section | ||
; below. For all the details on how these sections work, see the comments above | ||
; the equivalent sections of searches.ini. Recommendations work the same in | ||
; EDS as they do in the regular Search module. | ||
[SideRecommendations] | ||
; No search-specific settings by default -- add your own here. | ||
[TopRecommendations] | ||
; No search-specific settings by default -- add your own here. | ||
[NoResultsRecommendations] | ||
; No search-specific settings by default -- add your own here. | ||
|
||
; This section is used to identify facets for special treatment by the SideFacets | ||
; recommendations module. | ||
[SpecialFacets] | ||
; Any fields listed below will be treated as date ranges rather than plain facets: | ||
dateRange[] = PublicationDate | ||
|
||
; This section is reserved for special boolean facets. These are displayed | ||
; as checkboxes. If the box is checked, the filter on the left side of the | ||
; equal sign is applied. If the box is not checked, the filter is not applied. | ||
; The value on the right side of the equal sign is the text to display to the | ||
; user. It will be run through the translation code, so be sure to update the | ||
; language files appropriately. | ||
[CheckboxFacets] | ||
|
||
; The order of display is controlled by EBSCO's administrative system. | ||
; The name of the index field is on the left | ||
; The display name of the field is on the right | ||
[Facets] | ||
SourceType = Format | ||
SubjectEDS = Subject | ||
Publisher = Publisher | ||
Journal = "Published in" | ||
ContentProvider = Source | ||
SubjectGeographic = Geography | ||
CollectionLibrary = Collection | ||
LocationLibrary = Location | ||
PublicationDate = adv_search_year | ||
|
||
; These are limiter identifiers that are treated as facets in VuFind. They are | ||
; listed here to assist in translation of the interface. | ||
AU = "Author" | ||
DT1 = "Published" | ||
FC = eds_limiter_FC ; Catalog Only | ||
FC1 = eds_limiter_FC1 ; Institutional Repository Only | ||
FM6 = eds_limiter_FM6 ; Audio Available | ||
FR = eds_limiter_FR ; References Available | ||
FT = eds_limiter_FT ; Full text | ||
FT1 = eds_limiter_FT1 ; Available in Library Collection | ||
GZ = "Collection" | ||
LA99 = "Language" | ||
LB = "Location" | ||
RV = eds_limiter_RV ; Peer Reviewed | ||
SO = "Journal Title" | ||
TI = "Title" | ||
|
||
; search mode | ||
SEARCHMODE = "Search Mode" | ||
|
||
; These facets will be shown above search results if the TopFacets recommendations | ||
; module is used, as opposed to the [Facets] section, which is shown to the side | ||
; of search results when the SideFacets module is used. | ||
; | ||
; NOTE: This section is not used by default -- see default_top_recommend setting | ||
; above for more details. | ||
[FacetsTop] | ||
|
||
; Facet display settings | ||
[Results_Settings] | ||
; Rows and columns for table used by top facets | ||
top_rows = 2 | ||
top_cols = 3 | ||
; Should we show "exclude" links for some or all of the facets? Set to * for | ||
; all facets, use a comma-separated list to show for some of the facets, set | ||
; to false or omit to disable "exclude" links | ||
;exclude = * | ||
; Should we OR together facets rather than ANDing them? Set to * for | ||
; all facets, use a comma-separated list to apply to some of the facets, set | ||
; to false or omit to disable ORed facets. | ||
;orFacets = * | ||
|
||
; These settings affect the way the facets are displayed | ||
[Facet_Settings] | ||
facet_limit = 30 ; how many values should we show for each facet? | ||
|
||
; These facets will be displayed as limiters on the advanced screen. Only | ||
; values that are present in the EDS API Available Limiters will be | ||
; used. Leave blank to use all available values from the INFO method | ||
[Advanced_Facets] | ||
|
||
; These settings affect the way facets are displayed on the advanced screen | ||
[Advanced_Facet_Settings] | ||
facet_limit = 100 ; how many values should we show for each facet? | ||
; Should we OR together facets rather than ANDing them? Set to * for | ||
; all facets, use a comma-separated list to apply to some of the facets, set | ||
; to false or omit to disable ORed facets. | ||
orFacets = * | ||
|
||
; Any facets named in the list below will have their values run through the | ||
; translation code; unlisted facets will displayed as-is without translation. For | ||
; translated facets, be sure that all of the necessary strings are included in the | ||
; language files found in the web/lang directory. By default, no facets are | ||
; translated -- uncomment or add lines below to turn on this feature. | ||
;translated_facets[] = ContentType | ||
|
||
; This section shows which search types will display in the basic search box at | ||
; the top of EDS pages. The name of each setting below corresponds with an | ||
; index defined in the EDS API. 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 "AllFields" is a special case that searches all | ||
; fields. | ||
; | ||
; If left empty, these will be populated from a call to the EDS API Info Method. | ||
[Basic_Searches] | ||
AllFields = "All Fields" | ||
TI = Title | ||
AU = Author | ||
|
||
; 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] | ||
|
||
; This section defines the sort options available on EDS search results. | ||
; Values on the left of the equal sign are either the reserved term "relevance" | ||
; or the name of an EDS index to use for sorting. Values on the right | ||
; of the equal sign are text that will be run through the translation module and | ||
; displayed on screen. If no values are provided here, default sort options will | ||
; be dynamically loaded from the API. | ||
[Sorting] | ||
|
||
; This section controls the behavior of the EDSRecord module. | ||
[Record] | ||
; Set this to true in order to enable "next" and "previous" links to navigate | ||
; through the current result set from within the record view. | ||
next_prev_navigation = false | ||
|
||
; This section represents the EBSCO EDS API Account credentials. | ||
; If using IP Authentication, then the user_id and password should remain blank | ||
; and ip_auth should be set to true. | ||
[EBSCO_Account] | ||
ip_auth = false | ||
user_name = [USERNAME] | ||
password = [PASSWORD] | ||
profile = [PROFILE] | ||
organization_id = |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.