Warning: This page has not been updated in over over a year and may be outdated or deprecated.
videos:combining_search_types
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
videos:combining_search_types [2020/08/07 13:30] – [Transcript] demiankatz | videos:combining_search_types [2023/04/26 13:29] (current) – crhallberg | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Video 9: Combining Search Types ====== | ====== Video 9: Combining Search Types ====== | ||
- | The ninth VuFind | + | The ninth VuFind® |
Video is available as an [[https:// | Video is available as an [[https:// | ||
Line 11: | Line 11: | ||
===== Transcript ===== | ===== Transcript ===== | ||
- | // This is a raw machine-generated transcript; it will be cleaned | + | In last month' |
- | in last month' | + | We'll start with combined searching. Obviously, |
- | index um and so we now have a you find | + | |
- | instance that has both a catalog of | + | So here I am at the terminal in the VUFIND_HOME directory, |
- | bibliographic records and an index of | + | |
- | web pages which brings up the challenge | + | So these comments at the top summarize everything, and once I get into the guts of the file, there' |
- | of how to allow users to search both of | + | |
- | these things fortunately if you find | + | The home page section here allows you to turn on contents on the main home screen of combined searching. By default, that screen is just going to show a search box. But by using content block plugins, which are described in more detail in searches.ini, you can add other content there, be it sort of a welcome message or details pulled in from other parts of you find. |
- | includes several mechanisms for | + | |
- | combining searches and these mechanisms | + | The layout section controls how the boxes in your combined search are distributed on the screen. You can set how many columns of boxes that you want to show and how you want to wait the distribution of search boxes across the columns. So for example, if you had three columns and six types of searches, you could wave at the left or to the right or you could evenly spread it across the columns. In the simple two column example, I'm about to show you none of this will matter. We'll just get two boxes side by side. But in more complex setups, you may find these advanced settings |
- | can be used separately or in combination | + | |
- | depending on your needs so in today' | + | Before I get into the boxes themselves, of which there are a few examples here, I wanted to go down to the very bottom and point out that there' |
- | video I'm going to show you how to | + | |
- | combine searches side-by-side how to | + | But now onto the really juicy part of this file, which are these sections defining search boxes. For each of these, the section name within the configuration file is actually the name of one of you find search backends, the code that actually retrieves search results. So any existing search |
- | create combined options in the search | + | |
- | options drop down here and how to use | + | Within |
- | tabs to switch between multiple sets of | + | |
- | search results on the fly | + | Another |
- | we'll start with combined searching | + | |
- | obviously | + | So I've now set up the basic combined search settings |
- | having many different types of resources | + | |
- | to search is figuring out how to present | + | You can get to your combined search screen by simply adding the word combined |
- | them to your user and many libraries | + | |
- | have found that an effective way of | + | If we set this to true, it's going to create a uniform search box that works the same everywhere in the VuFind site and encompasses all of the options from all of the different search backends. So we need to turn that on and then scroll down to the combined handlers section. Here, we need to activate all of the search backends that we want to show options for in our search |
- | combining different types of search | + | |
- | results is the so-called bento box | + | So a couple more things to clarify here. There are two values that we can put in the type for each of these groups of handler settings. VuFind |
- | approach where a single set of search | + | |
- | terms reveals a number of boxes of | + | So here is my combined search. Here is my catalog search. And under the catalog search are all of the catalog specific search options that are provided through |
- | categorized content and then the user | + | |
- | can navigate into whichever set of | + | I'll go back to my terminal and I will once again edit my main config.ini file. In this file, there is a section called search tabs, which by default is all commented out. But you can here create mappings from search |
- | results are most appropriate for them | + | |
- | view fiims combined searching mode | + | That is all I have for this month. But I thank you for your time and I will have more next time. Thanks |
- | provides a simple way of implementing | + | |
- | this type of bento box searching | + | //This is an edited version of an automated transcript. Apologies for any errors.// |
- | going to set that up first to allow us | + | |
- | to search our Web index and our | + | |
- | bibliographic index side-by-side so here | + | |
- | I am at the terminal in the view finder | + | |
- | Ector II and as with any other defined | + | |
- | configuration I'm going to start by | + | |
- | copying the default configuration which | + | |
- | is the ' | + | |
- | I into my local config | + | |
- | directory establishing a local copy that | + | |
- | I can edit and then edit that file as | + | |
- | all you find configuration files | + | |
- | combined ini has lots and lots of | + | |
- | comments in it describing all of the | + | |
- | contents of the file there are a handful | + | |
- | of reserved sections in here which allow | + | |
- | you to set global settings for combined | + | |
- | searching and the remainder of the | + | |
- | sections each define one search box that | + | |
- | will show up in the combined results | + | |
- | these comments at the top summarize | + | |
- | everything once I get into the guts of | + | |
- | the file there' | + | |
- | section which defines which search types | + | |
- | the user can choose | + | |
- | you wanted to allow a fielded title | + | |
- | author or subject search across all of | + | |
- | your search boxes you could uncomment | + | |
- | some of these options to make that | + | |
- | possible | + | |
- | mind that when you're combining search | + | |
- | results you can only turn on options | + | |
- | that are supported in all of the boxes | + | |
- | so for the purposes of combining web | + | |
- | results and bibliographic results having | + | |
- | search types to select doesn' | + | |
- | sense because the fields are very | + | |
- | different | + | |
- | this commented out but if I were in a | + | |
- | different scenario where I wanted to | + | |
- | search two different kinds of things | + | |
- | that both have titles I would have the | + | |
- | option of turning on title searching | + | |
- | which would allow the users to do more | + | |
- | focus searching in their results | + | |
- | home page section here allows you to | + | |
- | turn on contents on the main home screen | + | |
- | of combined searching | + | |
- | screen is just going to show a search | + | |
- | box but by using content block plugins | + | |
- | which are described in more detail in | + | |
- | searches | + | |
- | content there be it sort of a welcome | + | |
- | message or details pulled in from other | + | |
- | parts of you find | + | |
- | the layout section controls how the | + | |
- | boxes in your combined search are | + | |
- | distributed on the screen | + | |
- | how many columns of boxes that you want | + | |
- | to show and how you want to weight | + | |
- | distribution of search boxes across the | + | |
- | columns | + | |
- | columns and six types of searches you | + | |
- | could weigh that the left or to the | + | |
- | right or you could evenly spread it | + | |
- | across the columns | + | |
- | column example I'm about to show you | + | |
- | none of this will matter | + | |
- | two boxes side by side but in more | + | |
- | complex setups you may find these | + | |
- | Advanced Settings | + | |
- | controlling the priority and arrangement | + | |
- | of all of the search options | + | |
- | get into the boxes themselves of which | + | |
- | there are a few examples here I wanted | + | |
- | to go down to the very bottom and point | + | |
- | out that there' | + | |
- | recommendation module section which you | + | |
- | can use to embed recommendations above | + | |
- | or below all of the combined searches | + | |
- | again most of the time recommendation | + | |
- | modules work best in the context of a | + | |
- | particular type of search but there are | + | |
- | some situations where you may want to | + | |
- | augment the overall result screen and | + | |
- | this setting allows you to do that but | + | |
- | now on to the the really juicy part of | + | |
- | this file which are these sections | + | |
- | defining search boxes | + | |
- | for each of these the section name | + | |
- | within the configuration file is | + | |
- | actually the name of one of you find | + | |
- | search backends the code that actually | + | |
- | retrieves search results | + | |
- | search | + | |
- | combined searches by just creating a | + | |
- | matching section name so the example | + | |
- | configuration includes sections for the | + | |
- | summon and EDS services | + | |
- | we are not using those services in this | + | |
- | example we want to comment those out but | + | |
- | we're going to leave the solar section | + | |
- | in place because that's where our | + | |
- | bibliographic records live and we also | + | |
- | want to add a solar web section for the | + | |
- | website because | + | |
- | the back-end | + | |
- | within | + | |
- | label which will be used to title the | + | |
- | search results within the box we could | + | |
- | optionally include a sub-label which | + | |
- | just provides some extra messaging | + | |
- | within the box if we set the more link | + | |
- | that will provide a link from the | + | |
- | combined search into the full result set | + | |
- | for that box and in theory we can limit | + | |
- | the number of results that show up so by | + | |
- | default we get 10 but if we wanted to | + | |
- | have more or fewer we can adjust the | + | |
- | limit here another | + | |
- | the Ajax setting which if we set to true | + | |
- | will cause these search results to be | + | |
- | retrieved asynchronously from the rest | + | |
- | of the page and Ajax loading of combined | + | |
- | results can be really helpful | + | |
- | particularly when you have a large | + | |
- | number of boxes or if some of your boxes | + | |
- | are being loaded from slow third-party | + | |
- | services | + | |
- | all of the searches have to be exit | + | |
- | in processed before the overall results | + | |
- | page will load which could be very slow | + | |
- | and we' | + | |
- | whatever service runs the slowest | + | |
- | we use Ajax on some of the boxes it will | + | |
- | cause the main screen | + | |
- | quickly and then additional results to | + | |
- | load in as they become available | + | |
- | so I've now set up the basic combined | + | |
- | search settings | + | |
- | website indexes | + | |
- | you can get to your combined search | + | |
- | screen by simply adding the word | + | |
- | combines | + | |
- | mentioned as its configured by default | + | |
- | the home page of the combined search is | + | |
- | just a search box but you can augment | + | |
- | this by turning on content block | + | |
- | settings in combine | + | |
- | for web and see what the combined search | + | |
- | results look like as you can see we've | + | |
- | got two boxes of results on the Left we | + | |
- | have catalog results | + | |
- | have website results I'm also going to | + | |
- | refresh the page one more time and draw | + | |
- | your attention to the website area here | + | |
- | just to highlight how that Ajax loading | + | |
- | works so as you can see there is a link | + | |
- | of the word loading here before the full | + | |
- | results actually popped into place so if | + | |
- | you're using combined search it is | + | |
- | common that you would want this to be | + | |
- | the first thing that users encounter | + | |
- | when they come to your site because it | + | |
- | offers the broadest view into your | + | |
- | content | + | |
- | changed default configurations if I go | + | |
- | back to the home page of you find the | + | |
- | default | + | |
- | bibliographic record search | + | |
- | want to change that it's very easy | + | |
- | I just need to edit my local config | + | |
- | find a big dot ini file and there' | + | |
- | setting in here called default module | + | |
- | which defines the name of a controller | + | |
- | that will be loaded by default from the | + | |
- | defined | + | |
- | search which searches the bibliographic | + | |
- | index but if I simply change this | + | |
- | setting from search to combine and then | + | |
- | refresh my home page here now my default | + | |
- | you find URL is taking me to the | + | |
- | combined search | + | |
- | really anything you want to change to | + | |
- | make your default | + | |
- | for example if I wanted my website | + | |
- | search to be the default I could have | + | |
- | changed that to web etc so it's great | + | |
- | that we can now search these two | + | |
- | different services at the same time but | + | |
- | our search experience can now become a | + | |
- | little bit confusing unless we do some | + | |
- | additional configuration | + | |
- | notice on this screen my search box up | + | |
- | here uh searches the combined search | + | |
- | if I hit this more options link here and | + | |
- | delve into the bibliographic record | + | |
- | search now I have the bibliographic | + | |
- | record search box | + | |
- | I have no obvious way to get back to my | + | |
- | combined search | + | |
- | context but within an area of the screen | + | |
- | that looks like it should remain | + | |
- | consistent | + | |
- | web results I now have an identical | + | |
- | looking search box to what I had on the | + | |
- | combined screen | + | |
- | searching the web results and I have to | + | |
- | hit the back button to return to my | + | |
- | combine | + | |
- | to cause people to get lost in your site | + | |
- | but fortunately there' | + | |
- | solution which is the combined search | + | |
- | box once again there is simply a | + | |
- | configuration file that controls the way | + | |
- | if you find search box works and you can | + | |
- | manage that in the usual way we'll copy | + | |
- | the default version config / beautifying | + | |
- | / search box | + | |
- | ini into our local config | + | |
- | directory and we' | + | |
- | we are faced with a file full of | + | |
- | configuration settings and comments | + | |
- | the thing that I want to mainly draw | + | |
- | your attention to is this top setting | + | |
- | combined handlers which defaults to | + | |
- | false if we set this to true it's going | + | |
- | to create a uniform search box that | + | |
- | works the same everywhere in the view | + | |
- | hindsight | + | |
- | options from all of the different search | + | |
- | backends | + | |
- | then scroll down to the combined | + | |
- | handlers section | + | |
- | activate all of the search backends that | + | |
- | we want to show options for in our | + | |
- | search | + | |
- | configuration here shows solar and | + | |
- | summon | + | |
- | website results | + | |
- | the summon | + | |
- | label of website | + | |
- | the way these settings are set up you | + | |
- | have groups of type target label and | + | |
- | group it's very important that you copy | + | |
- | all four settings when you add options | + | |
- | here so that each of these named | + | |
- | settings type target label and group | + | |
- | have the same number of values because | + | |
- | otherwise the settings can get | + | |
- | out of sync and cause weird results | + | |
- | when you're adding things just be sure | + | |
- | you copy everything and fill in all of | + | |
- | the settings | + | |
- | that because I need to add one more set | + | |
- | of options here because we want to | + | |
- | include the combined search option in | + | |
- | addition to the individual catalog and | + | |
- | website options | + | |
- | to clarify here there are two values | + | |
- | that we can put in the type for each of | + | |
- | these groups of handler settings | + | |
- | fine means we're working with an | + | |
- | internal | + | |
- | that we need to get all of our options | + | |
- | from you finds internal code and that's | + | |
- | the most commonly used setting | + | |
- | that case the target value is the name | + | |
- | of a search back-end and the label is | + | |
- | what we want to display as a label for | + | |
- | that option within the drop down the | + | |
- | group setting is optional | + | |
- | it false nothing will happen | + | |
- | have a very large number of handlers in | + | |
- | play and you want to group them within | + | |
- | the drop down into labelled | + | |
- | can provide a label here but I recommend | + | |
- | leaving that false in all but rare | + | |
- | situations | + | |
- | can set up is an external handler | + | |
- | allows you to actually link into | + | |
- | searches on sites outside of you find in | + | |
- | this instance when a user performs a | + | |
- | search | + | |
- | you provide as the target of the | + | |
- | external resource and append their | + | |
- | search terms to the end of that so in | + | |
- | this example we can perform a Google | + | |
- | search directly from inside | + | |
- | obviously | + | |
- | reason why you would want to do that | + | |
- | most of the time but if you're | + | |
- | integrating | + | |
- | systems and you want to make them | + | |
- | searchable this is one way to achieve | + | |
- | that that kind of linking | + | |
- | some other settings in this file that | + | |
- | might potentially be of interest are | + | |
- | include alpha browse which allows you to | + | |
- | embed links to you finds alphabetical | + | |
- | browse search within the main search box | + | |
- | that's a topic we haven' | + | |
- | but we may in the future | + | |
- | remaining settings have to do with | + | |
- | grouping options together and are | + | |
- | usually safe to ignore | + | |
- | that I've turned all of this on if i | + | |
- | refresh my combined search you'll now | + | |
- | see that I have a drop down menu so here | + | |
- | is my combined search | + | |
- | search | + | |
- | all of the catalog specific search | + | |
- | options that are provided through | + | |
- | fines internal configuration | + | |
- | the options from searches | + | |
- | we have the website | + | |
- | bottom that Google example | + | |
- | can see it's under a label called other | + | |
- | sites because of the group setting | + | |
- | I wanted to group all of these things | + | |
- | here under a label that looked like this | + | |
- | I can use the group setting to | + | |
- | accomplish that but importantly we now | + | |
- | have consistent search behavior | + | |
- | click on more options on my catalog | + | |
- | search it now shows that I'm doing a | + | |
- | catalog search I have a consistent set | + | |
- | of controls | + | |
- | into my web result again now it shows | + | |
- | that I'm doing a website search but all | + | |
- | of the same options are available | + | |
- | everywhere | + | |
- | configuring a combined search box at the | + | |
- | same time that you set up a combined | + | |
- | search | + | |
- | detail which is optional | + | |
- | which is turning on search tabs which | + | |
- | just provides another way for users to | + | |
- | navigate between different types of | + | |
- | search results I'll go back to my | + | |
- | terminal and I will once again edit my | + | |
- | main config.ini file | + | |
- | in this file there is a section called | + | |
- | search tabs which by default is all | + | |
- | commented out but you can here create | + | |
- | mappings from search | + | |
- | labels in order to turn on tabs in your | + | |
- | search results | + | |
- | the solar equals catalog option I'm | + | |
- | going to add combined equals combined | + | |
- | and solar web website so that it's | + | |
- | possible to tab between all three search | + | |
- | options the combined and the two | + | |
- | individual | + | |
- | lines of configuration if I now go back | + | |
- | to my search results refresh | + | |
- | now have tabs on my search box and if I | + | |
- | click on them they will switch me back | + | |
- | and forth between the three different | + | |
- | search modes retaining | + | |
- | so with all three of these things in | + | |
- | place we have access to every kind of | + | |
- | search from every page of you find | + | |
- | through this drop-down menu here once we | + | |
- | perform a search we can navigate to | + | |
- | different kinds of searches with a | + | |
- | single click through the tabs and by | + | |
- | configuring the combined search we have | + | |
- | this high-level view of all of our | + | |
- | search results | + | |
- | a single screen | + | |
- | things together we offer our users very | + | |
- | flexible access to the content that | + | |
- | we're providing | + | |
- | lot more complicated as you add a lot | + | |
- | more content figuring out how to label | + | |
- | your boxes and what kinds of messaging | + | |
- | to use can be quite a challenge | + | |
- | least few find provides the technical | + | |
- | framework to easily experiment with | + | |
- | different arrangements and different | + | |
- | labels and make all of your stuff | + | |
- | visible | + | |
- | that is all I have for this month but I | + | |
- | thank you for your time and I will have | + | |
- | more next time thanks | + | |
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
videos/combining_search_types.txt · Last modified: 2023/04/26 13:29 by crhallberg