Difference between revisions of "Search"

From ICA-AtoM
Jump to navigation Jump to search
Line 42: Line 42:
 
ICA-AtoM uses the [http://framework.zend.com/ ''Zend''] framework's implementation of the the [http://lucene.apache.org/ ''Lucene''] search engine. This provides a number of options for advanced searching from within the [[Glossary#Search box|Search box]]. For a full description of the features Zend's Lucene search supports, see:
 
ICA-AtoM uses the [http://framework.zend.com/ ''Zend''] framework's implementation of the the [http://lucene.apache.org/ ''Lucene''] search engine. This provides a number of options for advanced searching from within the [[Glossary#Search box|Search box]]. For a full description of the features Zend's Lucene search supports, see:
  
*[http://framework.zend.com/manual/en/zend.search.lucene.query-language.html Zend Programmers Reference Guide, chapter 33: Zend_search_Lucene].
+
*[http://framework.zend.com/manual/en/zend.search.lucene.query-language.html Zend Programmers Reference Guide, chapter 33.4: Zend_search_Lucene > Query language].
  
 
What follows is a selection of some of the most commonly used tools.
 
What follows is a selection of some of the most commonly used tools.
Line 50: Line 50:
  
 
*Use double quotes ("searchTerm") to search phrases.
 
*Use double quotes ("searchTerm") to search phrases.
 +
 
*E.g. Search ''"city hall"'' to return records containing these two words together in that exact order.
 
*E.g. Search ''"city hall"'' to return records containing these two words together in that exact order.
  
  
 
'''Boolean operators'''
 
'''Boolean operators'''
*Use AND to combine search terms to narrow your search: e.g. ''vancouver AND "city hall"'' returns only descriptions that contain '''both''' search terms.
+
 
*Use OR to to combine search terms to '''broaden''' your search: e.g. ''vancouver OR "city hall"'' returns descriptions that contain '''either''' search term.
+
*Use AND to combine search terms to '''narrow''' your search: e.g. search ''vancouver AND "city hall"'' to return only descriptions that contain '''both''' search terms.
*Use NOT to '''exclude''' terms: e.g. ''vancouver NOT "city hall"'' returns records descriptions that include ''vancouver'' but do '''not''' include the phase ''"city hall"''.
+
 
*Boolean operators need not be uppercase.
+
*Use OR to to combine search terms to '''broaden''' your search: e.g. search ''vancouver OR "city hall"'' to return descriptions that contain '''either''' search term.
 +
 
 +
*Use NOT to '''exclude''' terms: e.g. search ''vancouver NOT "city hall"'' to return descriptions that include ''vancouver'' but do '''not''' contain the phase ''"city hall"''.
 +
 
 +
*Boolean operators can be upper- or lowercase.
 +
 
 
*You can substitute symbols for words: && (AND), || (OR), ! (NOT).
 
*You can substitute symbols for words: && (AND), || (OR), ! (NOT).
 +
 
*Other Boolean operators are available; see [http://framework.zend.com/manual/en/zend.search.lucene.query-language.html Zend's documentation].
 
*Other Boolean operators are available; see [http://framework.zend.com/manual/en/zend.search.lucene.query-language.html Zend's documentation].
  
  
 +
'''Fields'''
 +
 +
*You can restrict your search to specific fields by typing the field name followed by a colon ( : ) and the search text (''fieldName:searchText'').
 +
 +
* E.g. search ''title:city'' to return descriptions which include the word ''city'' in the title.
  
 +
*You must enter the exact field name. These are not always intuitive nor do they necessarily correspond to the field label that appears on screen.
  
 +
*For the list of searchable fields and their names, see in this manual: [[UM-4.1.1|Field names for advanced searching]].
  
 
<br clear="right">
 
<br clear="right">
<span class="revised">Last revised: 3 June 2008 (ICA-AtoM v0.6)</span>
+
<span class="revised">Last revised: 4 June 2008 (ICA-AtoM v0.6)</span>

Revision as of 12:33, 4 June 2008

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

Search content

Main Page > (UM) User manual > UM-4 Access content > UM-4.1 Search content

Basic search

File:Um4-1SearchBox.png
Enter a term in the Search box
File:Um4-1SearchResults.png
Search results screen


Use the Search box to find records in ICA-AtoM that contain text matching any keyword or phase. The Search box is available on every screen for every user.


1. Enter search text in the Search box.


2. Click the Search button.


3. ICA-AtoM searches all fields in all archival descripitons and returns matches on a Search results screen (list). This shows:

  • The number of descriptions found.
  • For each match, the description title and the first three lines of the "Scope and content" field.


4. Click a title to view the full description (routes you to the record's View screen).


Limitations:

  • You cannot save the search results.

Future releases of ICA-AtoM (post-1.0) will address these limitations.


Advanced search

ICA-AtoM uses the Zend framework's implementation of the the Lucene search engine. This provides a number of options for advanced searching from within the Search box. For a full description of the features Zend's Lucene search supports, see:

What follows is a selection of some of the most commonly used tools.


Phrases

  • Use double quotes ("searchTerm") to search phrases.
  • E.g. Search "city hall" to return records containing these two words together in that exact order.


Boolean operators

  • Use AND to combine search terms to narrow your search: e.g. search vancouver AND "city hall" to return only descriptions that contain both search terms.
  • Use OR to to combine search terms to broaden your search: e.g. search vancouver OR "city hall" to return descriptions that contain either search term.
  • Use NOT to exclude terms: e.g. search vancouver NOT "city hall" to return descriptions that include vancouver but do not contain the phase "city hall".
  • Boolean operators can be upper- or lowercase.
  • You can substitute symbols for words: && (AND), || (OR), ! (NOT).


Fields

  • You can restrict your search to specific fields by typing the field name followed by a colon ( : ) and the search text (fieldName:searchText).
  • E.g. search title:city to return descriptions which include the word city in the title.
  • You must enter the exact field name. These are not always intuitive nor do they necessarily correspond to the field label that appears on screen.


Last revised: 4 June 2008 (ICA-AtoM v0.6)