Differences

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

--- videos:configuring_search_and_facet_settings [2020/02/17 17:46] – [Transcript] demiankatz
+++ videos:configuring_search_and_facet_settings [2023/04/26 13:27] – crhallberg
@@ Line 1: / Line 1: @@
 ====== Video 4: Configuring Search and Facet Settings ======
-The fourth VuFind instructional video provides a tour of three of VuFind's most important configuration files: searches.ini, facets.ini and searchspecs.yaml. Using these three files, you can control many options presented to users for navigating and refining search results, and you can also change the way those search results are retrieved.
+The fourth VuFind® instructional video provides a tour of three of VuFind's most important configuration files: searches.ini, facets.ini and searchspecs.yaml. Using these three files, you can control many options presented to users for navigating and refining search results, and you can also change the way those search results are retrieved.
 Video is available as an [[https://vufind.org/video/Search_and_Facet_Settings.mp4|mp4 download]] or through [[https://www.youtube.com/watch?v=qFbW8u9UQyM&feature=youtu.be|YouTube]].
@@ Line 7: / Line 7: @@
 ===== Related Resources =====
-  - [[https://vufind.org/wiki/configuration:facets|Facet Configuration wiki page]]
+  - [[configuration:facets|Facet Configuration wiki page]]
-  - [[https://vufind.org/wiki/configuration:search_customization|Search Customization wiki page]]
+  - [[configuration:search_customization|Search Customization wiki page]]
 ===== Transcript =====
-:!: This transcript still needs to be cleaned up and edited.
+Hello and welcome to the fourth in the
+VuFind® instructional video series!
- hello and welcome to the fourth in the
+Today we are going to look at three of
-view find instructional video series
-today we are going to look at three of
 the most important configuration files
-in view find for adjusting the way
+in VuFind for adjusting the way
-search and faceting behave but before we
+search and faceting behave. But before we
 dive into that I just wanted to set the
 stage for those who have been following
-along I didn't want the examples today
+along. I didn't want the examples today
-to look too weird so I have actually
+to look too weird, so I have actually
-gone back to the standard default view
+gone back to the standard default
-find theme and I have re indexed data
+VuFind theme and I have re-indexed data
 using default settings instead of the
 customizations we demonstrated back in
-video 2 so if you're coming in for the
+Video 2. So, if you're coming in for the
 first time you'll see fairly normal
-things I've also indexed a few more of
+things. I've also indexed a few more of
-you finds sample mark records just to
+VuFind's sample marc records just to
 give us a bigger set of search results
-to play with if you're keeping score the
+to play with. If you're keeping score the
-files I indexed our journals mark geo
+files I indexed are "journals.mrc",
-mark and authority bibs dot mark so with
+"geo.mrc", and "authoritybibs.mrc".
-all that out of the way let's start
-looking at configuration files and this
+So, with all that out of the way
-is also a good time to put in yet
+let's start looking at configuration files
+and this is also a good time to put in yet
 another reminder about always using your
 local settings directory when changing
-configuration files so let's start with
+configuration files. So let's start with
-searches I and I which is sort of the
+searches.ini which is sort of the
-top level configuration for view finds
+top-level configuration for VuFind's
-search options we will copy I'm
+search options. We will copy
-currently in the view finder Ector e so
+(I'm currently in the VuFind home directory)
-we will copy config slash view find
+so we will
-slash searches I and I into local slash
+copy "config/vufind/searches.ini"
-config slash view find so now we have a
+into "local/config/vufind/"
+so now we have a
 local copy of the configuration file
 that we can edit without touching the
-core files of the view find distribution
+core files of the VuFind distribution.
-I'm going to bring up a visual studio
+I'm going to bring up VSCode,
-code which is just one of many tools
+which is just one of many tools
-that you can use to edit files and I
+that you can use to edit files, and I
-will open searches I and I I go to the
+will open searches.ini.
-top of the file so the first thing I
+I'll go to the top of the file.
+So, the first thing I
 should explain is that in this file you
-will see references to search handlers
+will see references to search handlers.
-search handler is view find terminology
+"Search handler" is VuFind terminology
 for one of the options in the drop-down
 menu next to the search box like title
-or author or subject it's just a group
+or author or subject. It's just a group
-of settings that tell view find how to
+of settings that tell VuFind how to
-do a particular kind of search we're
+do a particular kind of search. We're
 going to look at how those are built a
 little later but for starters let's just
 talk about the ones that are
 pre-configured for you out of the box in
-view find which are all those common
+VuFind. Which are all those common
-things I mentioned like title and author
+things I mentioned like title, author,
-and subject so at the very top of the
+and subject.
+So, at the very top of the
 file you will see that there's a default
-handler set which is all fields which is
+handler set which is "AllFields", which is
 a very broad search that as it says is
 going to search across the majority of
-the fields indexed in view find there is
+the fields indexed in VuFind. There is
 really very little reason to ever change
-this default handler so I recommend
+this default handler, so I recommend
-leaving that alone however there is a
+leaving that alone. However, there is a
 setting just a few lines down here
-called empty search relevance override
+called "empty_search_relevance_override"
 which is turned off by default because
-it causes view fine to do some extra
+it causes VuFind to do some extra
 work but this is something that a lot of
-people may actually want to turn on so
+people may actually want to turn on.
-let me show you what this does Here I am
+So let me show you what this does.
-in my local view find demo and if I run
+Here I am in my local VuFind demo
-a blank search this will show us all of
+and if I run a blank search
+this will show us all of
 the records in the index and you'll see
 that by default things are sorted by
-relevance which means that view find
+relevance, which means that VuFind
 tries to use the user search terms to
 figure out which things in the result
-set are most important but if you do a
+set are most important. But if you do a
 blank search there are no search terms
 to use for ranking and you just get
 everything back in a completely
 arbitrary order and that's where this
-setting comes in if I go back and I
+setting comes in. If I go back and I
-uncomment empty search relevance
+uncomment empty_search_relevance_override
-override it will use a sort option other
+it will use a sort option other
 than relevance only for empty searches
 and then we will get perhaps a more
-meaningful looking result set so if i
+meaningful looking result set. So if I
-refresh my search results now I've got a
+refresh my search results now I've got
-at the
+"A" at the top.
-moving down a little further you will
+Moving down a little further you will
 see that there are a couple of major
 sections in this file that control which
 search handlers are available to your
-user there is basic searches which is
+user. There is [Basic_Searches], which is
 going to control the drop-down list next
 to the search box which is on
-practically every screen of you find and
+practically every screen of VuFind, and
-then there's advanced searches which is
+then there's [Advanced_Searches], which is
 going to control what options are
 available in the boxes in the advanced
-search screen and you'll notice that by
+search screen. Snd you'll notice that by
 default there are more options available
 for advanced search because we are
 expecting users to be trying to do more
-specific things and combining fields and
+specific things and combining fields in
 more complex ways when they're doing
 advanced searches whereas the basic
-search is really just the basics there's
+search is really just the basics.
-also one kind of special case here the
-tag search which is a way of searching
+There's also one kind of special case here
+the tag search, which is a way of searching
 for user tags that users have created on
-records it works a little bit
+records. It works a little bit
 differently than everything else which
 is why it's only available in the basic
-list it doesn't play well with other
+list. It doesn't play well with other
 types of searches and so it doesn't work
 properly if you try to put it in any
-advanced search so all of these lists
+advanced search.
-let you do a couple of things first of
-all they let you control the order of
+So all of these lists
+let you do a couple of things. First of
+all, they let you control the order of
 the options so for example if I want the
 author option to appear above the title
-option I can just cut and paste put the
+option I can just cut and paste, put the
 author line above the title line and
-then if i refresh my view find screen
+then if I refresh my VuFind screen
 and look at the drop-down menu the order
 of the fields here matches what's in the
-configuration file so if presentation of
+configuration file. So if presentation of
-options is important to you you have
+options is important to you, you have
-full control over that the other thing
+full control over that.
+The other thing
 that you'll notice here is that some of
-these things look a little bit cryptic
+these things look a little bit cryptic.
-like author equals adv underscore search
+Like author equals "adv_search_author".
-underscore author what's going on here
+What's going on here
 is that the values on the left side of
 the equal sign are the names of search
-handlers which are configured in another
+handlers, which are configured in another
-file that we'll look at shortly the
+file that we'll look at shortly. The
-values on the
+values on the right side of the
-side of the equal sign our translation
+equal sign our translation strings.
-strings so if you find has an
+So VuFind has an
 internationalization system which looks
 up keys and then displays values in the
-users currently chosen language all of
+user's currently chosen language. All of
 these values here are going to go
 through that translation system and get
-translated for the user so if you decide
+translated for the user.
+So if you decide
 to customize these labels you can really
-put anything you like here so for
+put anything you like here.
-example I could change author to a
+For example, I could change author to
-person who created stuff and then if I
+Person who Created Stuff" and then if I
-go back to if you find and refresh the
+go back to VuFind and refresh the
 page I now see that I have the option of
-the person who created stuff search but
+the Person who Created Stuff search.
-the important thing to remember is if
+The important thing to remember is if
-your particular view find instance is
+your particular VuFind instance is
 presenting the interface in multiple
-languages you're going to have to create
+languages, you're going to have to create
-mappings for these strings and all of
+mappings for these strings in all of
 the language files you need so that they
 translate correctly when users switch
-languages internationalization is
+languages. Internationalization is
 probably a good topic for a future video
 but for now I just wanted to make you
-aware that that exists so you'll also
+aware that that exists.
-notice that there are a couple of
+So you'll also notice
+that there are a couple of
 searches that have semicolons in front
-of them meaning that they are commented
+of them, meaning that they are commented
-out they're turned off um and that is
+out they're turned off. That is
 because they are useful options in some
 cases but not everyone needs them so we
-leave them off by default for example we
+leave them off by default.
-have this coordinate search which can be
+For example, we have this coordinate search
-useful if you're using view finds
+which can be useful if you're using VuFind's
 optional geographic functionality but is
-meaningless otherwise and we have this
+meaningless otherwise. We have this
 journal title search which is just like
 a title search but it filters down to
-journals again not everyone is indexing
+journals. Again, not everyone is indexing
 journal data so we don't provide it by
 default but just for fun let's turn it
-on here by removing the semicolon and
+on here by removing the semicolon.
-now if i refresh my browser yet again I
+Now if I refresh my browser yet again,
-now have a journal title search showing
+I now have a journal title search showing
 up under title and if I just do a blank
 journal title search that brings back
-just ten
+just ten results,
-salts which is all of the journals that
+which is all of the journals that
-were indexed in my sample data so that
+were indexed in my sample data.
-is how you control and reorganize and
-real able your search handlers similarly
+So that is how you control
-there is a sorting section in the file
+and reorganize and re-label
-which controls your sorting options it's
+your search handlers similarly
-under the heading label of sorting and
+there is a [Sorting] section in the file
-as with the search handlers there are
+which controls your sorting options.
-some options that are on by default some
+It is under the heading label of [Sorting]
+and as with the search handlers there are
+some options that are on by default, some
 options that are commented out but
-they're for your reference and in this
+they're for your reference, and in this
-instance view find by default assumes
+instance VuFind by default assumes
 that you're going to be using Library of
 Congress style call numbers but if
 instead you're using Dewey you can just
-flip-flop these by commenting out call
+flip-flop these by commenting out
-number sort which is the LC field and
+"callnumber-sort" which is the LOC field
-uncommenting dewey sort so in this
+and uncommenting "dewey-sort". So in this
 section the values on the left are the
-names of fields in the solar index that
+names of fields in the Solr index that
-view find can use for sorting the values
+VuFind can use for sorting. The values
 on the right are the labels which are
-once again translation strings so you
+once again translation strings. So you
-can reorganize this list you can real
+can reorganize this list, you can re-label
-able this list you can add different
+this list, you can add different
-solar fields if you want to create some
+Solr fields if you want to create some
-kind of a custom sort but the the one
+kind of a custom sort, but the the one
 thing that you have to keep in mind if
 you're trying to do custom fields here
-is that solar sort must be done on
+is that Solr sort must be done on
 fields that contain only one value per
-record if a field contains multiple
+record. If a field contains multiple
-values solar doesn't know how to sort on
+values Solr, doesn't know how to sort on
 that because it needs just one value to
-put the record in an ordered sequence so
+put the record in an ordered sequence.
-if you try to do anything else here it
+So if you try to do anything else here it
 will cause an error and that's a common
 source of confusion and we of course can
 get into that further when we talk about
-solar in a future video another useful
+Solr in a future video.
-option that's backed up near the top of
-eyal is the ability to control the page
+Another useful option
-size of results you'll notice when you
+that's back up near the top of the file
-first install view find you have 20
+is the ability to control the page size
+of result. You'll notice, when you
+first install VuFind, you have 20
 records per page and no ability to
 change that but in this configuration
 file adjusting both the page size and
 the ability to switch the page size is
-possible so there's a default limit you
+possible. There's a default limit you
 can see here this is set to 20 but
-suppose I want to change this to 40 we
+suppose I want to change this to 40.
-are going to have to close our web
+We are going to have to close our web
 browser before we can see the change
-take effect because if you find
+take effect because VuFind
-remembers all of your default default
+remembers all of your default
 choices in cookies and reinforces them
-for you this is usually convenient
+for you. This is usually convenient
 because if you've made a choice and you
 do a new search you want that choice to
@@ Line 267: / Line 286: @@
 your configuration files and you change
 something it can appear that your change
-didn't work because viewfinders
+didn't work because VuFind is
 remembering what you were doing before
-you made the change so now I've closed
+you made the change. Now I've closed
 Firefox I've opened it back up again
-that's cleared out my session level
+that's cleared out my session-level
 cookies so now when I perform a blank
 search I have 40 results on the page
-instead of 20 and so now if I want to
+instead of 20.
+Now if I want to
 give the user the choice of how many
-records to view at once I can uncomment
+records to view at once, I can uncomment
 this limit option setting which is just
 a comma separated list of numbers and
 all of those numbers are going to be
-provided as a drop-down menu so if i
+provided as a drop-down menu. So, if i
 refresh the page I now have a results
 per page control I can set that to 10 or
-or whatever so you are free to put
+or whatever.
+So you are free to put
 any number you like in this
 configuration but do keep in mind that
 there are limits to how much data a
-solar can process and passed if you find
+Solr can process and pass to VuFind
-it once so if you try to set your page
+it once. So, if you try to set your page
 size to 10,000 you might expect to run
 into memory problems or performance
-problems or other issues so configure
+problems or other issues.
-this but try to keep it within reason
+So configure this
-another very important feature of you
+but try to keep it within reason.
-find is what we call the recommendation
-module system and this is just a modular
+Another very important feature of VuFind
+is what we call the
+recommendation module system.
+This is just a modular
 way of plugging custom code into the
-search results screens there are
+search results screen.
-actually three different regions where
+There are actually
+three different regions where
 you can position a recommendation module
 and by default several of the things
-that you find uses are actually
+that VuFind uses are actually
-recommendation modules that includes
+recommendation modules.
+That includes
 this top suggested topics within your
-search control which is a top
+search control which is a
-recommendation module it includes the
+"top" recommendation module.
+It includes the
 standard faceting controls which are a
-side recommendation module and it
+"side" recommendation module.
-includes a variety of things that show
+It includes a variety of things that show
 up if you do a search that doesn't yield
-any results like this suggesting ways to
+any results like this "suggesting ways to
-find more results blue box these are no
+find more results" blue box these are
-results
+"no results" recommendation modules.
-recommendation modules so you have full
+So you have full control over
-control over what shows up when a user
+what shows up when a user
 performs a search that yields no results
 and also what shows up above and to the
-side of normal search results and that
+side of normal search results.
-is all done through the configuration
+That is all done through the configuration
-file searches I and I if you look fairly
+file, searches.ini.
-near the top of the file you're going to
+If you look fairly near the top
-see that there's default top recommended
+of the file you're going to see that there's
-settings defaults I'd recommend settings
+default_top_recommend settings,
-and default no results recommend
+default_side_recommend settings,
-settings and what these are going to do
+and default_noresults_recommend settings
-is tell you find which recommendation
+and what these are going to do
-modules to load um if there are no more
+is tell VuFind which recommendation
-specific settings available because you
+modules to load if there are no more
+specific settings available. Because you
 can configure each search handler to
 have its own set of recommendation
-modules so for example when you do an
+modules. For example when you do an
 author search you're going to see some
 author specific tips and details that's
-made possible by this recommend
+made possible by this
-configuration
+recommend configuration.
-and to see the other piece of this
+To see the other piece of this
 beside the defaults if you scroll down
-there is a section called side
+there is a section
-recommendations a section called top
+called [SideRecommendations],
-recommendations and a section called no
+a section called [TopRecommendations],
-results recommendations and in each of
+and a section called [NoResultsRecommendations]
-these sections you can specify the name
+and in each of these sections
-of a search handler brackets which allow
+you can specify the name
-you to repeat that setting to have
+of a search handler + "[]"
-multiple values within it and then the
+(which allow you to repeat that setting to have
+multiple values within it) and then the
 one or more recommendation modules that
-you want to display so as I said author
+you want to display.
-has some custom faceting that's made
+So, as I said author has some
-possible through this similarly call
+custom faceting that's made
-number searches behave a little bit
+possible through this.
+Similarly, call number searches
+behave a little bit
 differently if you do a call number
-search and don't find any results there
+search and don't find any results.
-are a lot of recommendation modules
+There are a lot of recommendation modules
 available and if you're comfortable with
-coding you can also write your own each
+coding you can also write your own.
-one of them is just one PHP class and
+Each one of them is just one PHP class
-one corresponding template to display
+and one corresponding template
-Thanks obviously building new ones is
+to display things.
+Obviously, building new ones is
 beyond the scope of this video but we
 may do that in the future but if you
 just want to see all of the available
-options if you scroll up above the side
+options if you scroll up above
-recommendations section of this
+to the [SideRecommendations] section
-configuration file you will find a
+of this configuration file you will find a
 substantial list of options divided into
 which section it's recommended that you
-might want to use these settings in so I
+might want to use these settings in.
-would encourage you to read through this
+So I would encourage you to
-and see if there's anything that catches
+read through this
-your eye most of them are fairly easy to
+and see if there's anything that
-configure you just put the name of the
+catches your eye.
+Most of them are fairly easy to
+configure: you just put the name of the
 module and then a number of parameters
 which are described in the documentation
-here if it's a module that has special
+here (if it's a module that has special
-options but for now just a really quick
+options). But for now, just a really quick
-example I'm going to go back up to the
+example, I'm going to go back up to the
 default recommendation settings and I
 don't know about you but I'm personally
 not a huge fan of the facet controls
-above the search results so this is
+above the search results, so this is
 something that I often turn off
-when I'm setting up you find and getting
+when I'm setting up VuFind and getting
 rid of that is as easy as commenting out
 this line by putting a semicolon at the
-beginning of it so I've removed the
+beginning of it. So I've removed the
-default top recommend equals top facets
+default_top_recommend[] = TopFacets:ResultsTop line.
-results top line and now if I go back to
+Now if I go back to
-my browser and refresh my search results
+my browser and refresh, my search results
 just start at the top of the page
 instead of having those facets above
-them one last thing that's going on in
+them.
-searches I and I that's worth pointing
+One last thing that's going on in
+searches.ini that's worth pointing
 out is that this is where all of the
-autocomplete functionality is set up
+autocomplete functionality is set up.
-there's an autocomplete section which
+There's an [Autocomplete] section which
 you can use to turn autocomplete off
 completely if you don't want to use it
-and similar to recommendation modules
+and similar to recommendation modules,
 there's a default handler that is used
 for generating autocomplete suggestions
 while users type their search queries
-but that's overridden on a handler by
+but that's overridden on a
-handler basis to configure different
+handler-by-handler basis
+to configure different
 rules for how those suggestions are
-looked up most people are probably not
+looked up. Most people are probably not
 going to need to change this but if you
 are planning on building your own custom
-handler it's nice to know that you can
+handler, it's nice to know that you can
 also control how suggestions are
-provided for that handler and
+provided for that handler.
-essentially the majority of these work
+Essentially, the majority of these work
-by using the solar lookup autocomplete
+by using the Solr lookup autocomplete
 handler which accepts the name of a
 search handler that the user's current
 text will be searched against and then a
 prioritized field list which says which
-solar field or fields to use to make the
+Solr field or fields to use to make the
-recommendations as with the
+recommendations. As with the
 recommendation modules all of the
 different autocomplete handlers are
-documented above the section and
+documented above the section in comments
-comments which has a little bit more
+which has a little bit more
 detail about how this works again this
 is something most people don't need to
-change but if you need to it's here
+change but if you need to it's here.
-so I think that's probably plenty on
-searches I and I but there's another
+So I think that's probably plenty on
+searches.ini but there's another
 configuration file that you will
 probably want to play with which is
-facets dot ini and this is what controls
+facets.ini and this is what controls
-how view find provides faceting options
+how VuFind provides faceting options
-for narrowing searches so once again I'm
+for narrowing searches.
-going to go to the terminal it might be
+Once again I'm going to
-you find home directory and I'm going to
+go to the terminal, into my
-copy config slash view fine slash facets
+VuFind home directory and I'm going to
-that I and I into local config you find
+copy "config/vufind/facets.ini"
+into "local/config/vufind"
 so that I have my own local copy of the
 file that I can modify without touching
-the core and then I'm going to go back
+the core.
-to vs code and open my new file facets
+Then I'm going to go back to VSCode
-that I and I so at the very top of the
+and open my new file facets.ini.
-file there's a section called results
+So, at the very top of the
+file there's a section called [Results]
 and this is what controls the facets
 that are displayed on the side of the
-regular search results and just as an
+regular search results.
-aside there's actually a recommendation
+Just as an aside
-module configuration in searches ini
+there's actually a recommendation
-that tells view find that this is where
+module configuration in searches.ini
-to find this so you can theoretically
+that tells VuFind that this is where
-store this anywhere but by default the
+to find this, so you can theoretically
-results section of facets that I and I
+store this anywhere, but by default the
-is going to control your default facet
+results section of facets.ini
-options and just like all the other
+is going to control your default facet options.
+Just like all the other
 configurations I've showed you this list
 can be reordered and the order changes
 will be reflected in the order that the
-facets are displayed in the view find
+facets are displayed in the VuFind interface.
-interface you can also change all of
+You can also change all of
 these labels on the right side of the
 equal signs to whatever you want and it
-will pass through the translation system
+will pass through the translation system.
-similar to the sort options I showed you
+Similar to the sort options I showed you
 the values on the left side of the equal
-signs are all the names of solar fields
+signs are all the names of Solr fields
 and so this is where the facet values
-are going to be retrieved from again
+are going to be retrieved from.
-these defaults should be reasonable but
+Again, these defaults
+should be reasonable but
 if you're doing custom things you know
 for example if you index a custom field
-with solar mark you can expose it here
+with SolrMarc you can expose it here
-as a facet
+as a facet if you want to.
-if you want to again when we talk more
+Again, when we talk more
-about solar in the future you will learn
+about Solr in the future you will learn
 that different fields behave differently
 and not all fields work well as facets
 so keep that in mind if you try
 something and get weird looking
-unexpected results so just as a quick
+unexpected results.
-example let's say that we think language
+So, just as a quick example,
+let's say that we think language
 is the most important facet so we want
 to make that appear first and because
 our demo instance has the same value for
 every record with institution and
-building there's really no point in
+building, there's really no point in
 showing those so we're going to put
-semicolons in front of those comment
+semicolons in front of those,
-them out disable them so now if I save
+comment them out/disable them
-this and i go back and i refresh my
+so now if I save
+this and I go back and I refresh my
 results I now have my language settings
 at the top those other two things have
 disappeared and all the other fields are
-showing up as they always do now if we
+showing up as they always do.
-look a little further down there's a
+If we look a little further down
-results top section and this controls
+there's a [ResultsTop] section
+and this controls
 which facet fields show up in that top
-facets area which I just disabled so
+facets area which I just disabled.
-it's probably useful to still have
+So it's probably useful to still have
-subject faceting so let's let's move
+subject faceting, so let's let's move
-that out of results top and into results
+that out of [ResultsTop] and into [Results]
-save that refresh the page again and now
+Save that. Refresh the page again and now
 when I scroll down those topic facet
 values that used to be showing above the
-search results are showing in the side
+search results are showing in the side bar.
-bar if we scroll down a little bit
+If we scroll down a little bit
 further in the file you'll notice that
-there are some sections related to
+there are some sections related to labeling.
-labeling there's facet labels and extra
+There's [FacetLabels] and [ExtraFacetLabels]
-facet labels these are used because view
+these are used because VuFind
-fine needs to know how to label the
+needs to know how to label the
-filters that you apply to your search
+filters that you apply to
-results
+your search results.
-so for example if I just click on say
+So, for example, if I just click on say
-call number general works you can see in
+"Call Number" > "General Works" you can see in
-the filter list but view fine labels
+the filter list but VuFind labels
-this filter as call number it does that
+this filter as "Call Number".
+It does that
 because it has this list of
 configuration sections where it knows it
 can find labels that apply to different
-solar fields if it can't find a label
+Solr fields. If it can't find a label
-it's going to put the word other in
+it's going to put the word "Other" in front
-front of the facet so this section is
+of the facet.
-just here to enable view find to find
+So this section is
+just here to enable VuFind to find
 all the configuration that will give it
-human readable labels for fields you
+human readable labels for fields.
-shouldn't have to touch this but if you
+You shouldn't have to touch this but if you
-ever see filters being labeled as other
+ever see filters being labeled as "Other",
 it probably means that you've made a
 customization somewhere and haven't
-reflected it in these configurations
+reflected it in these configurations.
-either by providing a section or by just
+Either by providing a section or by just
-putting an explicit solar field to label
+putting an explicit Solr field to label
-mapping in the extra facet labels
+mapping in [ExtraFacetLabels].
-there's also a special facet section
+There's also a [SpecialFacets] section
 here which allows you to turn on special
 handling for certain fields and in the
 default configuration this is used to
 indicate that the publish date field is
-a date range which is what enables this
+a "dateRange", which is what enables this
-slider control to appear and there are a
+slider control to appear.
-few different kinds of ranges you can
+There are a few different
+kinds of ranges you can
 turn on if you need them it's all
-explained in the comments in the file
+explained in the comments in the file.
-also interesting is this checkbox facet
-section if you have a setting that's
+Also interesting is this [CheckboxFacets] section
+if you have a setting that's
 essentially a flip flop switch you can
-put a solar query and a label in here
+put a Solr query and a label in here
-and if you find will present that as a
+and VuFind will present that as a
-checkbox for the user to toggle so for
+checkbox for the user to toggle.
-example suppose I want to be able to
+So, for example, suppose I want to be able to
 filter to only records that have no
-author in them I can make a solar query
+author in them I can make a
-of - author : star which is the syntax
+Solr query of "-author:*"
+which is the syntax
 for excluding anything with a value in
-the author field
+the author field.
-I can say equals no author if I save
+I can say equals "No Author".
-this and I go back and refresh my search
+If I save this
-results I now have a no author checkbox
+and I go back and refresh my search results
+I now have a no author checkbox
 available and if I click that I now end
 up with 10 records that don't have
-authors showing that's a fairly
+authors showing.
-contrived example but there are
+That's a fairly contrived example
-real-world situations where having these
+but there are real-world situations
-checkbox controls can be valuable right
+where having these
-under the checkbox facets a section is
+checkbox controls can be valuable right.
-the result settings section which is
+Under the [CheckboxFacets] a section is
+the [Result_Settings] section which is
 where you can control how many values
-are displayed in the sidebar how many
+are displayed in the sidebar, how many
-shows sort of above the fold of that
+show sort of above the fold of that
-expand link and also what kind of
+expand link, and also what kind of
 behavior if any we present for exploring
-deep into the facet set so by default we
+deep into the facet set.
-show 6 values above the fold and that
+So by default
+we show 6 values above the fold and that
 expands out to 30 values and we offer a
-seol control which pops up a lightbox
+"see all" control which pops up a lightbox
 where we can do more work on the facet
-values if we want to if you want to
+values if we want to.
-change any of that say you only want to
+If you want to change any of that
+say you only want to
 show two above the fold and only ten in
 the complete list you can do that by
-just changing the show more and the
+just changing the "showMore"
-facet limit you can also switch these
+and the "facet_limit".
-out on a field by field basis so for
+You can also switch these
+out on a field-by-field basis so for
 example if we want to show a lot of
 formats but very few of anything else we
-can say show more star equals 2 which
+can say "showMore[*] = 2"
-sets a default and then override that
+which sets a default
-default with show more format equals 10
+and then override that default
-now if I start all over here and do a
+with "showMore['format'] = 10".
-blank search all of the format values
+Now if I start all over here and
-show we don't actually have 10 distinct
+do a blank search,
+all of the format values show.
+We don't actually have 10 distinct
 values in this index but we're seeing
-all of them and everything else
+all of them - and everything else
-at most - with an expand control there
+at most 2 with an expand control.
-are also settings for controlling the
+There are also settings for controlling the
 dimensions of the top area if you want
 to customize that and for whether we
 want to have exclude links which let
-users white values out of a search set
+users wipe values out of a search set
 rather than filtering to only include
-those values if we just uncomment this
+those values. If we just uncomment this
-exclude equal star that will put exclude
+"exclude=*" that will put exclude
 buttons on every single facet field so
-for example now we don't want journals I
+for example now we don't want journals,
-can click this X it deletes all the
+I can click this X,
-journals out of the search this can be
+it deletes all the
-quite useful we can also change facets
+journals out of the search.
+This can be quite useful.
+We can also change facets
 so that by clicking more values the user
-sees more options rather than narrowing
+sees more options rather than narrowing.
-so that's the or facets value and that
+That's the or facets value.
-can be set to work on only certain
+That can be set to work on only certain
-fields so if you use the star it will
+fields so if you use the * it will
 apply to everything but say I only want
-this to apply to format I can set that
+this to apply to format, I can set that
 on the format field and then when i
 refresh my screen I now have little
 checkboxes and so if I click on
-conference proceedings
+"Conference Proceedings",
 I now have narrowed down to only
 conference proceedings but I can still
 see the other two values that existed in
 the result set and I can widen my search
-again by checking off more of them so
+again by checking off more of them.
-depending on what kinds of values you're
+So depending on what kinds of values you're
 working with having this option
-available can be valuable you can also
+available can be valuable.
-control whether facets are visible by
+You can also control
+whether facets are visible by
 default or if they're collapsed and
-again you can specify that on a field by
+again you can specify that on a
-field basis if you just turn it on for
+field-by-field basis.
+If you just turn it on for
 everything then when you load the screen
 all non-selected facet regions are
 collapsed then the user has to expand
-them to see values
+them to see values.
-the Advanced section controls which
+The [Advanced] section controls which
 facets are used as filters in the select
-boxes on the advanced search screen just
+boxes on the advanced search screen.
-to show you that quickly I go to the
+Just to show you that quickly I go to the
-advanced link we have these call number
+advanced link we have these call number,
-language and format filters which allow
+language, and format filters which allow
 you to pre-select some values when
-you're doing an advanced search we can
+you're doing an advanced search.
-control which boxes appear here through
+We can control which boxes appear here
-this Advanced section and Advanced
+through this [Advanced] section.
-Settings also lets us limit how many
+[Advanced_Settings] also
+lets us limit how many
 values can appear in each of those boxes
 along with some other behavioral
-controls you'll notice that by default
+controls. You'll notice that by default
-the advanced facets are bored together
+the advanced facets are OR'd together
 so that multi selections include all of
 those values rather than only including
-records that match every single selected
+records that match every single selected thing.
-thing there are also some special facets
+There are also some special facets
 that can be turned on on the advanced
-screen and further down this is actually
+screen.
-a setting that applies to all of you
-find not just the advanced screen there
+Further down this is actually
-is a translated facets setting which you
+a setting that applies to all of VuFind
-can use to run facet values through view
+not just the advanced screen.
-finds translation system by default the
+There is a translated_facets setting
-majority of values in the solar index
+which you can use
-are just presented as is which means
+to run facet values through VuFind's
-that even though view finds interface
+translation system.
+By default
+the majority of values in the Solr index
+are just presented as-is which means
+that even though VuFind's interface
 supports many languages the values that
 are coming through are just going to
-display in whatever form they were
+display in whatever form
-indexed in but sometimes you may have a
+they were indexed in.
+Sometimes you may have a
 controlled vocabulary in a field that
 you want to translate into many
 languages and this provides the
-mechanism for doing that you'll notice
+mechanism for doing that.
-that format is translated by default
+You'll notice that format
-because if you find comes with
+is translated by default
+because VuFind comes with
 translations for all of the format
-values it uses additionally the call
+values it uses.
-number first field which contains the
+Additionally the callnumber-first field
+which contains the
 top-level Library of Congress call
-number category
+number category is translated
-is translated and you'll see that
+and you'll see that
-there's a : call number first after the
+there's a :CallNumberFirst after the
 name of the facet field that's being
-translated this is specifying which
+translated. This is specifying which
-language file the translations are found
+language file the translations are found in.
-in again we'll go into that in more
+Again we'll go into that in more
 depth when we talk about
 internationalization in the future but
 for now just be aware that if you want
 to translate your facet values you can
-set that up here finally there's a home
+set that up here.
-page and home page settings section and
-these control on the front page of you
+Finally there's a [HomePage]
-find these top-level browse categories
+and [HomePage_Settings] section and
-you can set any facet field to display
+these control, on the front page of VuFind,
+these top-level browse categories.
+You can set any facet field to display
 here and you can control how many values
-to show just by changing that homepage
+to show just by changing that [HomePage]
-section of facets that I and I also note
+section of facets that.ini.
-that if you do make changes there or if
+Also note that if you do make changes there
-you reindex your records you may wish to
+or if you reindex your records
-clear a few finds internal cache to make
+you may wish to clear a VuFind's
+internal cache to make
 those changes visible if you don't see
-them right away so that covers all of
+them right away.
-the highlights of facets I and I and now
+So, that covers all of
+the highlights of facets.ini and now
 we are going to look at one last thing
 which is the most complex configuration
-file and view find called search specs
+file in VuFind, called "searchspecs.yml"
-yeah mol which is the file that contains
+which is the file that contains
-specifications for all of you find
+specifications for all of VuFind
-search handlers so I'm once again going
+search handlers
-to copy config slash view find slash
-search specs that yamo into my local
+So I'm once again going
-config you find directory so I have a
+to copy "config/vufind/searchspecs.yml"
-local copy I can tinker with I'm going
+into my "local/config/vufind" directory
-to go into visual studio code and look
+so I have a local copy I can tinker with.
-at that so search specs dot yeah Mille
+I'm going to go into VSCode and look at that.
-is as the name says a yeah mol file
+So searchspecs.yml is, as the name, says a YAML file
 which is a particular way of structuring
-data for machine readability because of
+data for machine readability.
-the complex nested nature of the data
+Because of the complex nested
-we're using here Gamal was chosen early
+nature of the data
-and few finds development as
+we're using here, YAML was chosen early
+and VuFind's development as
 a workable format for representing all
-of the things we need to do here Gamal
+of the things we need to do here.
-is not the most user-friendly format so
+YAML is not the most user-friendly format so
 be careful with it sometimes if you have
 a space in the wrong place so that
 settings don't align with one another it
 can get confused and have trouble
-reading it so proceed with caution but
+reading it. So proceed with caution.
-for today we're just going to do a quick
+For today we're just going to do
-high-level browse of this file so that
+a quick, high-level browse of this file
-you are aware it's of its existence and
+so that you are aware it's of its existence
-can do more with it later when you
+and can do more with it later when you
-understand more about solar so first of
+understand more about Solr.
-all the file begins with a long long
-series of comments describing all of the
+So, first of all,
+the file begins with a long,
+long series of comments describing all of the
 settings and how they work and providing
-some examples and under all of that is
+some examples.
-the actual set of search handler
+Under all of that is the actual set
-definitions so you'll see that each of
+of search handler definitions.
+So, you'll see that each of
 these starts with the name of the
-Handler and a colon and then some data
+handler and a colon and then some data
-indented underneath it so for example
+indented underneath it.
-here is the author handler here is the
+For example,
-isn handler here is the subject handler
+here is the author handler,
-etc again without getting too deep into
+here is the ISN handler,
-solar there are essentially two
+here is the subject handler, etc.
-different modes of searching that view
+Again, without getting too deep into
-find uses one is called EDA Smacks and
+Solr there are essentially two
+different modes of searching that VuFind
+uses one is called "edismax" and
 this method works by just taking a list
 of fields and some relevance ranking
 numbers that establish the relative
 importance of those fields to one
-another and then solar will just take
+another and then Solr will just take
-the user search search it across all of
+the user search, search it across all of
-those fields and then return a relevance
+those fields, and then return a relevance
-ranked result based on your preferences
+ranked result based on your preferences.
-so author is a perfect example of one of
+So, "Author" is a perfect example of one of
-these dis max type searches if you find
+these edismax type searches.
-has a number of different fields that
+VuFind has a number of different fields that
 contain author data in different formats
 and from different parts of the incoming
-records and so here we're saying primary
+records. So here we're saying primary
-author is the most important the fuller
+author is the most important.
-version of that primary authors name if
+The fuller version of that
+primary authors name if
 it's present may also be quite
-so we're giving primary author a 100
+so we're giving
-point boost we're giving author fuller a
+primary author a 100-point boost
-point boost and they were including
+we're giving author fuller a 50-point boost
+and then we're including
 all the other author fields as being of
-equal relevance of secondary authors
+equal relevance of secondary authors,
-corporate authors variant forms of names
+corporate authors, variant forms of names, etc.
-etc it's important to note that these
+It's important to note that these
 numbers in and of themselves don't
-actually mean anything they're just
+actually mean anything, they're just
-relative to one another so we're saying
+relative to one another.
-that an author is a hundred times more
+We're saying that an author is
-important than a secondary author it is
+a hundred times more important
-often useful to tweak and experiment
+than a secondary author.
+It is often useful to tweak and experiment
 with numbers if you're trying to change
-the order of your results to to find the
+the order of your results,
-balance that works right and there
+to find the balance that works right
-there's as much art as science in that
+and there there's as much art as science
-process let's actually scroll down and
+in that process.
-do an actual example of relevance
-ranking so I mentioned earlier that the
+Let's actually scroll down and
-default search Handler and beyou find is
+do an actual example of relevance ranking.
-all fields and sure enough here's the
+I mentioned earlier that the
-definition for that and it really is all
+default search handler in VuFind is
-fields because we have here a bunch of
+AllFields and sure enough here's the
-title fields that are boosted quite a
+definition for that and it really is
-lot series fields boosted a little
+AllFields because we have here a bunch of
-authors boosted a fair amount topics
+title fields that are boosted quite a lot,
-boosted almost as heavily as titles and
+series fields boosted a little,
-then a few other bits and pieces notice
+authors boosted a fair amount,
-that there's this field called all
+topics boosted almost as heavily as titles,
-fields and this is sort of a catch-all
+and then a few other bits and pieces.
-field that during indexing grabs all of
+Notice that there's this field
+called "allfields" and
+this is sort of a catch-all field
+that during indexing grabs all of
 the text of the records that you're
-indexing so when we search all fields we
+indexing. So when we search allfields we
 are sure to find the words we're
-searching for if they're in the records
+searching for, if they're in the record
 somewhere but we have all this more
 granular relevance boosting to try to
-prioritize matches in more meaningful
+prioritize matches
-places
+in more meaningful places.
-so let's just show an example of this in
-my example index here I search for the
+So let's just show an example of this.
-word finds and reset all my filters I
+In my example index here, I search for the
-get two different kinds of matches here
+word "finds" and reset all my filters,
+I get two different kinds of matches here.
 I have a couple of title matches up at
-the top because solar has decided that
+the top because Solr has decided that
-my search of finds matches the word fine
+my search of "finds" matches
-in fine arts this is because Solar is
+the word "fine" in fine arts.
+This is because Solr is
 configured to be tolerant of word
 endings and you know match rather than
-not match if given the choice there are
+not match if given the choice.
-also a couple of these records where the
+There are also a couple of
-name Greg finds is present so suppose in
+these records where
-my particular situation I think people
+the name "Greg Fines" is present.
-are going to be searching for names more
+So suppose in my particular situation
-often than they are searching for titles
+I think people are going to be
-what I can do is go into my search specs
+searching for names more often
-tamil file and just make the numbers on
+than they are searching for titles.
+What I can do is go into
+my searchspecs.yml file
+and just make the numbers on
 the author fields bigger so I'm going to
 just say authors are 10 times more
-important than the default so I'm
+important than the default, so I'm
 changing the 300 point boost on author
 to 3000 points and 150 point boost on
-author fuller to 1500 now if I go back
+author_fuller to 1500.
-to view find and i refresh my search
+Now if I go back to VuFind and
+I refresh my search
 results I see that the author matches
-are at the top of the list obviously
+are at the top of the list.
-this kind of search tuning can be really
+Obviously, this kind of search tuning
-tricky and complicated because you're
+can be really tricky and complicated
-always going to be dealing with
+because you're always
+going to be dealing with
 competing concerns and a change that
 fixes one scenario may break a different
@@ Line 839: / Line 942: @@
 but keep in mind that you have a lot of
 power and flexibility for making these
-kinds of tweaks but anyway getting back
+kinds of tweaks.
+Anyway, getting back
 to what I was saying earlier about there
 being two types of searches I've showed
-the the dis max style search is fairly
+the edismax style search is fairly
 extensively now but there's also a more
-detailed query syntax that solar can do
+detailed query syntax that Solr can do
 that uses boolean operators
-and specific matching syntax and
+and specific matching syntax
-specific fields this is often referred
+and specific fields.
-to as leucine the syntax because solar
-is built on an indexing engine called
+This is often referred to
-leucine long ago before the dis max
+as Lucene syntax because Solr is
-functionality had been fully developed
+built on an indexing engine called Lucene.
-view find relied much more heavily on
+Long ago before the dismax functionality
-the basic leucine searching and search
+had been fully developed,
-specs that yeah mol includes some fairly
+VuFind relied much more heavily on
+the basic Lucene searching
+and searchspecs.yml includes some fairly
 rich capabilities for constructing
 really complicated queries across
 multiple fields in an effort to do what
-dis max now just does for free most of
+dismax now just does for free.
-that has been eliminated because it was
+Most of that has been eliminated
-very complicated and you can do the same
+because it was very complicated
+and you can do the same
 thing more easily but there are still
 some scenarios where having the control
-of the leucine syntax is valuable so for
+of the Lucene syntax is valuable.
-example if we go to the very bottom of
-the file here there is an OCLC number
+So, for example, if we go to the very bottom
-search so OCLC numbers are just a
+of the file here there is an OCLC number search.
-commonly used identifier for records
+OCLC numbers are just a
-they're found in a lot of places if you
+commonly used identifier for records.
-find indexes OCLC numbers into one of
+Yhey're found in a lot of places.
-the solar fields but we don't want to
+VuFind indexes OCLC numbers into one of
+the Solr fields but we don't want to
 treat that like just any other keyword
 because if you've seen OCLC numbers
 you'll know that sometimes they have
-weird allow alphanumeric prefixes on
+weird alphanumeric prefixes on them
-them sometimes they have leading zeros
+sometimes they have leading zeros on them.
-on them view finds standardizes them to
+VuFind standardizes them to
-a particular format so what we want to
+a particular format.
+What we want to
 be able to do is if a user says they're
 searching for an OCLC number we don't
@@ Line 883: / Line 993: @@
 want to be able to manipulate their
 input to normalize it the same way that
-view find normalizes the values that it
+VuFind normalizes the values that it
-stores in its index so that what the
+stores in its index, so that what the
 user types is more likely to match what
-we have in our index and so that's what
+we have in our index and that's what
-this custom section is doing we define a
+this custom section is doing.
-custom Monge Monge being computer
+We define a custom munge
-programmer slang for data manipulation
+(munge being computer
-we name it OCLC nom and we do some
+programmer slang for data manipulation).
+We name it oclc_num and we do some
 regular expression matching which is
 just a way of transforming text to say
-get rid of anything that's not a number
+"get rid of anything that's not a number
 and get rid of any zeros at the
-beginning of the string then down here
+beginning of the string".
-in query fields we tell a view find that
+Then down here in query fields
-we want to search the OCLC nom solar
+we tell a VuFind that
-field using the OCLC mmm custom munge
+we want to search the oclc_num Solr
-and the end result of that is the user
+field using the oclc_num custom munge
-can type pretty much whatever prefix
+and the end result of that is
-nonsense they want do you find I'll
+the user can type pretty much
-clean it up do the search on just the
+whatever prefix nonsense they want
-numeric part and if there's a match it
+and VuFind will clean it up,
-will be found if you want to look at
+do the search on just the numeric part,
-something even more complicated and I'm
+and if there's a match it will be found.
-not going to walk through it right now
+If you want to look at
+something even more complicated
+- and I'm not going to
+walk through it right now -
 the call number search does some even
 more complex matching and it also does
-some ranking so it has one munge which
+some ranking. So, it has one munge which
 tries to find an exact match on a call
 number and another munge that tries to
@@ Line 915: / Line 1030: @@
 relevance ranking to exact matches to
 try to boost things that are closer to
-what the user has typed we are running
+what the user has typed.
-short on time but just to bring this all
+We are running short on time
-full circle I'm going to go back to my
+but just to bring this all
-searches i and i and i'm going to find
+full circle, I'm going to go back to my
-the basic searches section I'm going to
+searches.ini and I'm going to find
-add OCLC nom equals OCLC number to this
+the [Basic_Searches] section I'm going to
+add "oclc_num = 'OCLC Number'" to this
 to expose that custom OCLC option from
-search specs not yamo that I was showing
+searchspecs.yml that I was showing
-you earlier and now if I go to view find
+you earlier.
-refresh it so I get more options do an
+Now, if I go to VuFind,
-OCLC number search I can do a search for
+refresh it so I get more options,
-a ridiculously over prefixed number that
+do an OCLC number search,
-I happen to know is in the system
+I can do a search for
-and even though I put all this nonsense
+a ridiculously over-prefixed number that
+I happen to know is in the system.
+And even though I put all this nonsense
 here it finds a match on the number and
-brings back the record that matches it
+brings back the record that matches it.
-so that's our time for today I know that
-was a lot but now you've seen some of
+So, that's our time for today!
+I know that was a lot,
+but now you've seen some of
 the many configuration options that are
-available in view find and hopefully
+available in VuFind and hopefully
-understand how they work a little bit
+understand how they work a little bit better.
-better we'll do more next month and in
+We'll do more next month and in
 the meantime feel free to reach out on
 slack mailing lists or elsewhere if you
 have questions or if we can help in any
-other way
+other way. Thank you!
-thank you
 ---- struct data ----
+properties.Page Owner :
 ----