Difference between revisions of "Search"

From ICA-AtoM
Jump to navigation Jump to search
Line 3: Line 3:
 
[[Main Page]] > [[User manual|(UM) User manual]] > [[UM-4|UM-4 Access content]] > UM-4.1 Search content
 
[[Main Page]] > [[User manual|(UM) User manual]] > [[UM-4|UM-4 Access content]] > UM-4.1 Search content
  
−
== Basic search ==
+
[[Image:um4-1Search1.png|500px|right|thumb|Enter a term in the Search box]]
  
−
[[Image:um4-1SearchBox.png|500px|right|thumb|Enter a term in the Search box]]
+
[[Image:um4-1Search2.png|500px|right|thumb|Search results screen]]
  
−
[[Image:um4-1SearchResults.png|500px|right|thumb|Search results screen]]
 
  
 +
Use the [[Search box]] to find descriptions in ICA-AtoM that contain matching text. The [[Search box]] is available on every screen for every user.
  
−
Use the [[Glossary#Search box|Search box]] to find descriptions in ICA-AtoM that contain matching text. The [[Glossary#Search box|Search box]] is available on every screen for every user.
 
  
 +
1. Enter a search term in the [[Search box]].
  
−
1. Enter a search term in the [[Glossary#Search box|Search box]].
 
  
 +
2. Click the [[Search button]].
  
−
2. Click the [[Glossary#Search button|Search button]].
 
  
 +
3. ICA-AtoM searches all fields in all [[Archival description|archival descripitons]] and returns matches on the [[Search results screen]] (list).
  
−
3. ICA-AtoM searches all fields in all [[Glossary#Archival descripiton|archival descripitons]] and returns matches on the [[Glossary#Search results screen|Search results screen]] (list).
 
  
 +
4. The [[Search results screen]] shows the search parametres and the numbers of matches found.
  
−
4. The [[Glossary#Search results screen|Search results screen]] shows the search parametres and the numbers of matches found.
 
  
 +
5. For each match, the [[Search results screen]] gives the description title and the first three lines of the ''Scope and content'' field (if it in fact contains any data).
  
−
5. For each match, the [[Glossary#Search results screen|Search results screen]] gives the description title and the first three lines of the "Scope and content" field (if it in fact contains any data).
 
  
 +
6. Click a title to view the full description (routes you to the record's [[View screen]]).
  
−
6. Click a title to view the full description (routes you to the record's [[Glossary#View screen|View screen]]).
 
  
−
<br clear="right">
+
'''Notes and limitations'''
−
== Notes and limitations ==
 
  
−
As of the current version of ICA-AtoM (v0.6):
+
As of the current version of ICA-AtoM (v1.0 beta):
  
 
*Search is '''not''' case-sensitive.
 
*Search is '''not''' case-sensitive.
  
−
*You can only search [[Glossary#Archival description|archival descriptions]]; you cannot currently search [[Glossary#Authority record|authority records]], [[Glossary#Archival institution|archival institutions]], or [[Glossary#Term|terms]].
+
*You can only search [[Archival description|archival descriptions]]; you cannot currently search [[Authority record|authority records]], [[Archival institution|archival institutions]], or [[Term|terms]].
  
 
*You cannot save the search results.
 
*You cannot save the search results.
  
−
*There is currently no ''Advanced search screen''. But see below for [[#Advanced search|advanced search techniques]] that can be used in the basic [[Glossary#Search box|Search box]].
+
*There is currently no ''Advanced search screen''. But see in this manual [[UM-4.2|Search: advanced (UM-4.2)]] for techniques that can be used in the basic [[Search box]].
  
−
*Search runs on the language specified by the [[Glossary#Language view|language view]]; for descriptions not translated into the preferred language, search will revert to the [[Glossary#Default source language|default source language]]. E.g. an application has ''English'' as the [[Glossary#Default source language|default source language]] and the user has switched to ''Français'' as the [[Glossary#Language view|language view]]; a query will search the French text where translations into French exist and the English text where descriptions have not been translated.
+
*Search runs on the language specified by the [[Language view|language view]]; for descriptions not translated into the [[Preferred language|preferred language]], search will revert to the [[Default source language|default source language]]. E.g. an application has ''English'' as the [[Default source language|default source language]] and the user has switched to ''Français'' as the [[Language view|language view]]; a query will search the French text where translations into French exist and the English text where descriptions have not been translated.
  
 
Future releases of ICA-AtoM (post-1.0) will address current limitations.
 
Future releases of ICA-AtoM (post-1.0) will address current limitations.
−
 
−
<br clear="right">
 
−
== Advanced search ==
 
−
 
−
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 supported by Zend's Lucene search, see:
 
−
 
−
*[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.
 
−
 
−
 
−
'''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).
 
−
 
−
*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">
 
−
<span class="revised">Last revised: 4 June 2008 (ICA-AtoM v0.6)</span>
 

Revision as of 17:33, 13 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

Enter a term in the Search box
Search results screen


Use the Search box to find descriptions in ICA-AtoM that contain matching text. The Search box is available on every screen for every user.


1. Enter a search term in the Search box.


2. Click the Search button.


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


4. The Search results screen shows the search parametres and the numbers of matches found.


5. For each match, the Search results screen gives the description title and the first three lines of the Scope and content field (if it in fact contains any data).


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


Notes and limitations

As of the current version of ICA-AtoM (v1.0 beta):

  • Search is not case-sensitive.
  • You cannot save the search results.

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

Retrieved from "https://wiki.ica-atom.org/index.php?title=Search&oldid=3459"