AvantSearch

By George Soules Provides extended search results cababilites for the public interface.
Download 2.0.0

AvantSearch

Provides extended searching and search results capabilities for an Omeka Classic installation.

Table of Contents

Dependencies

The AvantSearch plugin requires that the AvantCommon plugin be installed and activated.

Installation

To install the AvantSearch plugin, follow these steps:

  1. First install and activate the AvantCommon plugin.
  2. Unzip the AvantSearch-master file into your Omeka installation's plugin directory.
  3. Rename the folder to AvantSearch.
  4. Activate the plugin from the Admin → Settings → Plugins page.
  5. Configure the AvantCommon plugin to specify your item identifier and title elements.
  6. Configure the AvantSearch plugin as described in the Configuration Options section below.

When this plugin is activated, it dynamically overrides the native Omeka search box (located in the page header) with the version used by AvantSearch. When you deactivate the plugin, the Omeka search box returns.

Differences from Omeka's Native Search

AvantSearch completely overrides Omeka's public search features. It provides its own Advanced Search page and presents search results in a wide variety of ways. It does not affect Omeka's admin search. The table below highlights the differences between AvantSearch and Omeka's native search.

Feature | AvantSearch | Omeka Search --------|------------ | ------------ Quick search | Yes - Feature | No Simple search for All Words | Yes - Feature | No Search in Titles only | Yes - Advanced Search page option | No Search only items with images or files | Yes - Advanced Search page option | No Date range search | Yes - Advanced Search page option | No User can specify number of results | Yes - Advanced Search page option | No Tabular results | Yes - Feature | No Custom Results Layouts | Yes - Congfiguration option | No Image View | Yes - Feature | No Index View | Yes - Congfiguration option| No Tree View (Hierarchical Data) | Yes - Congfiguration option | No Relationships View | Yes - Congfiguration option | No Integer sorting | Yes - Congfiguration option | No Address sorting | Yes - Congfiguration option | No Lightbox | Yes - Feature | No Search by File, Collection, Featured | No | Yes

Quick Search

Quick Search is a feature of Simple Search that allows you to immediately go to the page for an item by typing the item's Identifier value in the simple search box. This is much faster than getting back search results for every item that contains that value and then having to locate and click on the item of interest.

Simple Search

The AvantSearch version of simple search improves on the native Omeka simple search by only returning results that contain all of the matching keywords instead of any of the keywords. Items that contain some, but not all of the keywords will not appear in the results. Searching for all keywords tends to provide much more relevant results. If you need to search for any of the keywords, you can enter the keywords on the Advanced Search page and choose the Boolean condition.

Search Results Views

One of the most powerful features of AvantSearch is its ability to display search results in many different ways which you can customize to meet your needs. In addition to the Index View and Tree View presentations described later, the Table View lets you specify any number of different layouts to display results in rows and sortable columns. The screen shots that follow show the same AvantSearch results in three different Table View layouts.

Table View

Table View Detail Layout

The Detail Layout provides a compact presentation of key information about an item including a thumbnail image. You specify which elements appear in the two columns to the right of the thumbnail. The item's description automatically appears in the third column. The screen shot below is truncated after the first three results.

Summary Layout Example


Table View Custom Layouts

This is an example of a custom layout showing the item's Type and Subject elements. The red triangle next to 'Type' in the header indicates that the results are sorted ascending by Type. The screen shot below is truncated after the first 10 results.

Custom Layout Example


This is another example of a custom layout, but this one shows the item's Creator and Publisher elements. Note the asterisk on item 2636. When you are logged in as an administrator, the astersisk indicates that the item is not public. When not logged in, the item does not appear in the results. You can also define layouts that can only be chosen when logged in. These layout can be used to show data that is normally hidden from public users. The screen shot below is truncated after the first 10 results.

Custom Layout Example

Image View

Image View displays search results as a grid of thumbnails. It's a more compact way to view results when the image is most important for identifying items of interest. The screen shot below is truncated after the first 10 results.

Image View Example

Index View

Index View displays information like the index in a book. It consolidates values into unique groups having the same value. The screen shot below is truncated midway through the B's.

When the index field contains hierarchical data, Index View shows only the leaf (lowest level) values in the hierarchhy. For non-hierarchical data, Index View shows the entire value. The data is considered to be hierarchical only if the index field element is specified using the Hierarchies option, otherwise Index View displays it as flat data.

Index View Example

Tree View

Tree View display hierarchical data in tree format. The screen shot below shows just a fragment of the full hierarchy (the places on Mount Desert Island a.k.a. MDI).

Tree View Example

Lightbox

Both the Table View Detail Layout and the Image View display thumbnails for an item's image if it has one. If the item has no image, a placeholder image is displayed. When you click on a thumbnail, the AvantSearch plugin displays a large version of the image. You can have the image display in a popup by using the Lightbox feature of the AvantCommon plugin.

Private Elements

You can specify that certain elements are private to administrators and not visible to or searchable by public users. You specify which elements are private using the Private Elements feature of the AvantCommon plugin.

Usage

Once installed, AvantSearch entirely overrides Omeka's native user interface for public search (Omeka's native admin search is still available from admin pages). There are several configuration options available on the plugin's configuration page.

Advanced Search Page

AvantSearch provides its own Advanced Search page. You access this page by either clicking on the Advanced Search link that appears below the simple search box in the header of every page, or by clicking the Modify Search button that appears on search result pages.

The screen shot below shows the search conditions that were specified to generate the Table View Custom Layout - Type / Subject screen shot shown earlier.

Advanced Search Page

Date Range Feature

When AvantCommon is configured to provide Start and End years, year start and end text boxes will appear as filters at the bottom of the Advanced Search page. A user can provide values for both the start and end years to limit search results to items in that range inclusive. For example if you specify 1900 for the start year and 1940 for end year, search will find items with start year greater than or equal to 1900 and less than or equal to 1940. If you only provide a value for the start year, the search will find items where the start year is that date or more recent. If you only provide a value for the end year, the filter will find items where the end year is that date or older.

Configuration Options

The sections that follow describe each of the options on the AvantSearch plugin configuration page.

Many options require that you specify a formatted list of information using commas or other characters as separators. For these options, spaces before and after the separators are ignored.

Syntax for some options is shown using BNF notation.


Titles Only Option

When this option is checked, radio buttons will appear under the keywords text box on the Advanced Search page to let the user choose to search in all fields or in titles only. This feature is very helpful for narrowing search results down to only the most relevant items because titles often contain the most important keywords.

NOTE: If you want to use this option, but the configuration page says it's not available for your installation, you'll need to add a FULLTEXT index to the title column of the search_text table. This is easily done using phpMyAdmin by following these steps: 1. Select the 'search_texts' table 1. Click the Structure tab 1. On the row for the title column, click Fulltext among the actions at the far right 1. Click OK on the dialog confirming that you want to add FULLTEXT to the column 1. The title column will now appear in the Indexes section showing its type as FULLTEXT (expand the Indexes section if it's not visible)


Columns Option

Use the Columns option specify: The order of columns from left to right in search results Table View An alias for an elements name e.g. 'Catalog #' for the Identifier element The width of a column The alignment of column text (left, center, or right)

Syntax:

The syntax for each row of the Columns option is

<element-name> [ "," <alias>] [ ":" <width> [ "," <alignment>] ] ]

Where:

  • <element-name> is the name of an Omeka element.
  • <alias> is an optional parameter preceded by a comma to provide another name for element e.g. 'ID' for 'Identifier'.
  • <width> is an optional parameter preceded by a colon to indicate the width of the element's column in pixels.
  • <alignment> is an optional parameter preceded by a comma that can only be specified if width is provided. It specifies the alignment of the column's text as right, center, or left.
Column Order:

The order of columns from left to right in search results Table View is determined as follows: The order, first to last, in which you specify elements with the Columns option. For elements that are not specified in the Columns option, the order in which column names appear, top to bottom, and left to right, in the Detail Layout option.

Note that because of the order precedence above, you cannot have columns appear in a specific order in one layout and in a different order in another layout. The reason for this restriction is because the content for all columns is contained in the HTML for the search results Table View; however, only the columns for the selected layout are visible. When you select another layout, the previous layout's columns are hidden and the new layout's columns are made visible. This is what allows instantaneous switching between layouts.

Below is an example specification for the Columns option.

Identifier, Item: 65, right
Title
Type
Subject
Creator
Publisher
Status: 90

Layout Selector Width Option

Use this option to specify an integer indicating the width of the layout selector that appears on Table View search results. For example, specify 250 to mean 250px. This option saves you from having to code CSS to adjust the width to a size that is appropriate for your layout options and your theme's styling. Experiment to find a value that makes the selector just wide enough to accommodate the longest layout you defined in the Layouts option described below.


Layouts Option

The Layouts option lets you specify different ways to present search results in Table Vew. The layouts you define here will appear in the Layout Selector and on the Advanced Search page.

Syntax:

The syntax for each row of the Layouts option is

<layout-id> "," <layout-name> [ "," <admin> [ ":" <column-name> [ "," <column-name>]* ] ]

Where:

  • <layout-id> is 'L' followed by an integer e.g. 'L3'. The numbers do not have to be consecutive from layout to layout. 'L1' is reserved for the Detail Layout described in the next section.
  • <layout-name> is a short descripion of the layout. It will appear in the Layout Selector list.
  • <admin> is an optional instance of the word "admin" (without quotes) to indicate that only a logged in user can see and choose this layout in the Layout Selector.
  • <column-name> is the name of an element that will appear as a column in the layout. Use a comma between column names.

The purpose of the layout Id is to uniquely identify a layout in the query string for Table View page. You can use this query string as a link on web pages to display search results in a specific layout. The Id ensures that those results will appear using the correct layout even if you change the layout's name or its position in the Layouts option list.

Below is an example specification of Layouts.

L1, Summary
L2, Creator/Publisher: Identifier, Title, Creator, Publisher, Date
L3, Type/Subject: Identifier, Title, Subject, Type
L6, Confidential, admin: Identifier, Title, Status, Notes

Notes about the example above: Each layout begins with an Id and Name The fourth row also specifies 'admin' You don't specify columns for the L1 Layout (described in the next section), but you do specify its Name. In the example, the columns for the other layouts always begin with "Identifier, Title" so that users see those values on every layout. Repeating these columns is a convention, but is not required.


Detail Columns Option

L1 is a special layout referred to as the Detail Layout because it presents a lot of information about an item, including a thumbnail, in a single row. Use the Detail Columns option to specify the elements which appear in the first two columns of this layout. The third column is reserved for the Description element. A screen shot of the detail layout appears at the top of this documentation.

In the screen shot, the last row shows Type and Subject in column one, and Address and Place in column two. If an element has no text, it will not appear in the Detail layout. In the screen shot, the first row shows Date in column one, but Date does not appear in the other rows because those items have no date information.

Format:
  • Specify the column one elements in the first row
  • Specify the column two elements on the second row
  • Specify the elements as a comma-separated list of element names
  • Use the pseudo-element <tags> to display an item's tags

Below is an example specification of the Detail Layout option.

Type, Accession Number, Subject, Date, <tags>
Creator, Publisher, Medium, Condition, Number of Pages

If you prefer to have only one detail column plus the Description column, specify only one row of elements.


Index View Option

The Index View option lets you specify a list of elements that can be used as the Index Field when choosing Index View from the Advanced Search page. If you leave this option blank, Index View will not appear as an option on the Advanced Search page.

Below is an example specification of the Index View option.

Title
Creator
Publisher
Type

By default, the Index View displays results in two columns. You can change it to show one column by placing the following CSS in your theme's style.css file. To show three columns, specify 3 instead of 1.

#search-index-view-headings {
    column-count: 1;
}

Tree View Option

The Tree View option lets you specify a list of elements that contain hierarchical data. In these elements, the hierarchy must be represented by a comma-separated list for example United States, Maine, Bangor.

The elements listed using the Tree View option will appear as Tree View fields on the Advanced Search page. If you leave this option blank, Tree View will not appear as an option on the Advanced Search page.

In Table View, columns that display elements listed here will show only the leaf value of the hierarchical data. For example, only Bangor instead of United States, Maine, Bangor. This allows you to sort these columns on the most meaningful part of the data, e.g. the city rather than the country.

Below is an example specification of the Tree View option.

Subject
Type

Relationships View Option

When this option is checked, an option to show search results in Relationships View will appear on the Advanced Search page.

NOTE: If you want to use this option, but the configuration page says it's not available for your installation, you'll need to install and activate the AvantRelationships plugin.


Hierarchies Option

The Hierarchies option lets you specify elements that contain hierarchical data, and for each element, indicate how you want that data displayed in search results. An example of hierarchical data for the Subject element is:

`Structures, Commercial, Lodging, Hotel`

The Hierarchies option lets you indicate whether this value displays as shown above (from its root) or as Hotel which is the leaf value.

As a general rule, the leaf value in a hierarchy should be descriptive enough to be meaningful on its own. For instance, the word "Hotel" alone implies a commercial structure for lodging. However, in some hierarchies, it may be important to show the full value.

Syntax:

The syntax for each row of the Hierarchies option is

<element-name> ":" <display-option>

Where:

  • <element-name> is the name of an Omeka element.
  • <display-option> is either root or leaf
Option Example:
Type: root
Subject: leaf

Note that this option does not affect how hierarchical data displays on Show pages.


Integer Sorting Option

The Integer Sorting option lets you specify a list of elements for columns that should be sorted as integers instead of as text. This option ensures that the data in these column is sorted numerically instead of alphabetically. For example, an alphabetic sort of 14, 116, 127, 1102 results in 1102, 116, 127, 14 because alphabetically, the character sequence 1102 precedes 14, 116, and 127. Likewise, the characters 14 are greater than the first two characters in the other three numbers and thus 14 sorts last. The values of elements specified with this option are converted to integers for sorting purposes.

Below is an example specification of the Integer Sorting option.

Identifier
Box #

Note that you can use the Integer Sorting option for elements with values that only contain integers and also for elements with values that start with integers, but are followed by text. In that case, the text is ignored and the sort is performed only on the integer portion of the value.


Address Sorting Option

This option is only supported by MariaDB and MySQL 8.0. If your server is not running one of these databases, the AvantSearch configuration page will say the option is not available for your installation. If you want to use this option, contact your web host to ask about moving to a server that has MariaDB. If your server is running one of the supporting databases and you are seeing the message that the option is not available for your installation, you'll have to add an element named Address.

Address sorting improves search results by sorting addresses first on the street name and then by the street number as an integer. Normally addresses are sorted in a database, or in an Excel spreadsheet, as ordinary text where numbers sort before letters. Furthermore, numbers are normally sorted as text, rather than as integers such that 10 appears before 9.

Without address sorting: 10 Main Street 72 Pleasant Lane * 9 Main Street

With address sorting: 9 Main Street 10 Main Street * 72 Pleasant Lane

Improving Search Results

The AvantSearch plugin will work without any modifications to your database. However, please read this section to learn how you can improve search results by changing just one setting.

Like Omeka's native search, AvantSearch performs keyword searches using the Omeka search_texts table. The Omeka installer creates this table using the MyISAM storage engine. You will get much better results from keyword searches by changing the table to use the InnoDB storage engine because MyISAM negatively affects keyword searches in two ways:

  • MyISAM uses a very long list of stopwords.
  • MyISAM's default settings ignores keywords of three characters or less (ft_min_word_len).

With MyISAM a search for "road+ map+" will ignore 'map' and thus return all items containing 'road' instead of only those items containing 'road' AND 'map'. Additionally, the MyISAM stopword list contains so many words that people commonly search for that users are often surprised when items don't appear in search results.

In contrast, InnoDB has a very short list of stopwords and only ignores keywords that are two characters or less (innodb_ft_min_token_size). Although you can change the value of ft_min_word_len to 3, this variable can only be set at the MySQL server level and a server restart is required to change them. If you are using a shared server, you probably don't have the option to change this value.

Follow these steps to change your search_texts table from MyISAM to InnoDB:

  • In phpAdmin, click on your database to see its tables
  • Click on the search_texts table (probably called omeka_search_texts or something similar)
  • Click on the Operations tab
  • In the Table options section, change Storage Engine from MyISAM to InnoDB
  • Click Go

Warning

Use it at your own risk.

License

This plugin is published under [GNU/GPL].

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Copyright

  • Created by gsoules
  • Copyright George Soules, 2016-2018.
  • See LICENSE for more information.

Credits

This plugin was originally developed for the Southwest Harbor Public Library Digital Archive. Funding was provided in part by the John S. and James L. Knight Foundation.

Inspiration for the Index View and Tree View search results came from the alphabetized index and hierarchical list features in the Daniel-KM / Reference plugin.

Version Released Minimum Omeka version
2.0.0August 31, 2018 [info]2.5