Difference between revisions of "Search"

From ICA-AtoM
Jump to navigation Jump to search
 
(77 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<span class="pageTitle">Search content</span>
+
[[Main Page]] > [[User manual]] > [[Access content]] > Search
  
[[Main Page]] > [[User manual|(UM) User manual]] > [[UM-4|UM-4 Access content]] > UM-4.1 Search content
 
  
[[Image:um4-1SearchBox.png|500px|right|thumb|Enter a term in the Search box]]
+
<div class="clearfix">
  
[[Image:um4-1SearchResults.png|500px|right|thumb|Search results screen]]
+
== Search for resource descriptions ==
  
== Basic search ==
+
[[Image:search.png|right|thumb|500px|A search results page]]
  
Use the [[Glossary#Search box|Search box]] to find records in ICA-AtoM that contain text matching any keyword or phase. The [[Glossary#Search box|Search box]] is available on every screen for every user.
+
#Use the [[Glossary#Search box|search box]] to find [[Glossary#Archival description|archival descriptions]] that contain matching text. The [[Glossary#Search box|search box]] is available on every page to every user.
 +
#Enter a query in the [[Glossary#Search box|search box]]. Use a single keyword or more advanced queries using specific [[Glossary#Field|fields]], quotations, boolean operators etc. (see [[Advanced search]])
 +
#Click the spyglass icon to the right of the box or press Enter on your keyboard
 +
#ICA-AtoM searches all [[Glossary#Field|fields]] of all [[Glossary#Archival description|archival descriptions]] and displays results on the [[Page types#Search results|search results]] page
 +
#The [[Page types#Search results|search results]] page displays the search query and the total number of results. By default, ICA-AtoM displays results ten at a time, providing pagination at the bottom of the page to allow users to navigate through long lists of results. [[Glossary#Administrator|Administrators]] can increase or decrease this default number (See [[Global settings#Items per page|items per page]]).
 +
#Click a title to view the full description (this navigates to the description's [[Glossary#View page|view page]])
  
 +
</div>
  
1. Enter search text in the [[Glossary#Search box|Search box]].
+
<div class="note">
  
 +
As of the current ICA-AtoM version:
 +
* Search results can be saved as a report and printed (click on Printer Icon in title bar)
 +
* Search runs on the language specified by the [[Glossary#Current language|current language]]. It will not display results for descriptions that are not translated into the current language
  
2. Click the [[Glossary#Search button|Search button]].
+
Future releases will address current limitations.
  
 +
</div>
  
3. ICA-AtoM searches all fields in all [[Glossary#Archival descripiton|archival descripitons]] and returns matches on a [[Glossary#Search results screen|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.
 
  
 +
<div class="clearfix">
  
4. Click a title to view the full description (routes you to the record's [[Glossary#View screen|View screen]]).
+
== Search for authority records or archival institutions ==
  
 +
[[Image:authoritySearch.png|500px|right|thumb|Authority records search box in the Caribou theme]]
  
<br clear="right">
+
#In the [[Glossary#Search box|search box]] at the bottom of browse results for [[Glossary#Authority record|authority records]] or [[Glossary#Archival institution|archival institutions]], enter a search query. Use a single keyword or more advanced queries using quotations, boolean operators etc. (see [[Advanced search]])
== Advanced search ==
+
# The [[Page types#Search results|search results]] page will display the results
 +
# To view an [[Glossary#Authority record|authority record]] or [[Glossary#Archival institution|archival institution]], click on one of the blue links in the [[Page types#Search results|search results]]
  
ICA-AtoM uses the Zend framework's Lucene search engine. This provides a number of options for advanced searching from within the [[Glossary#Search box|Search box]].
+
== Search for accession records ==
*You can broaden your search by entering more than one word; ICA-AtoM will return any record that contains text matching any one of the words; it does not require the record to contain all of the words (e.g. entering ''city hall'' will return any description that includes the word "city" or the word "hall" anywhere in any field).
 
  
*Use double quotation marks ("") around text to search on phrases (e.g. entering ''"city hall"'' will return only descriptions that include the words "city hall" together in that order in any field.
+
[[Image:accessionSearch.png|500px|right|thumb|Accession records search box in the Trilium theme]]
  
 +
To search for [[Glossary#Accession record|accession records]], you must first have a [[Glossary#User account|user account]] with sufficient edit permissions to access the Accessions module. This includes [[Glossary#Editor|editors]], [[Glossary#Contributor|contributors]], and [[Glossary#Administrator|administrators]]; additionally, a [[Glossary#Translator|translator]] with edit permissions in both the [[Glossary#Current language|current language]] and the original language in which the
 +
accession record was created may access the accessions module.
  
'''Limitations:'''
+
* For more information on users groups and edit permissions, see [[User roles]]
 +
* For more information on creating and editing [[Glossary#Accession record|accession records]], see [[Add/edit accession records]]
  
Note the following limitations on search functionality in ICA-AtoM as of the current version (v0.6):
+
To search [[Glossary#Accession record|accession records]]:
  
*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]].
+
# Navigate to Manage > Accessions via the [[Glossary#Main menu|main menu]]
 +
#In the [[Glossary#Search box|search box]] at the bottom of browse results for [[Glossary#Accession record|accession records]], enter a search query. Use a single keyword or more advanced queries using quotations, boolean operators etc. (see [[Advanced search]])
 +
# The [[Page types#Search results|search results]] page will display the results
 +
# To view an [[Glossary#Accession record|accession records]], click on one of the blue links in the [[Page types#Search results|search results]]
  
*You cannot run advanced searches (e.g. you cannot search on specific fields only, or narrow or broaden searches with boolean operators).
+
Searches in [[Glossary#Accession record|accession records]] can also be limited to specific [[Glossary#Field|fields]] for more targeted results - See: [[Search fields#Accession record]]
  
*You cannot save the search results; when you click a link from the results list to the full record view, you cannot use the browser's back arrow to return to the [[Glossary#Search results screen|Search results list]], it must be reconstituted by running the same search again.
 
  
Future releases of ICA-AtoM will address these limitations.
+
</div>
  
<br clear="right">
+
 
<span class="revised">Last revised: 3 June 2008 (ICA-AtoM v0.6)</span>
+
<div class="clearfix">
 +
 
 +
[[Category:User manual]]

Latest revision as of 13:24, 8 August 2013

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.

Main Page > User manual > Access content > Search


Search for resource descriptions

A search results page
  1. Use the search box to find archival descriptions that contain matching text. The search box is available on every page to every user.
  2. Enter a query in the search box. Use a single keyword or more advanced queries using specific fields, quotations, boolean operators etc. (see Advanced search)
  3. Click the spyglass icon to the right of the box or press Enter on your keyboard
  4. ICA-AtoM searches all fields of all archival descriptions and displays results on the search results page
  5. The search results page displays the search query and the total number of results. By default, ICA-AtoM displays results ten at a time, providing pagination at the bottom of the page to allow users to navigate through long lists of results. Administrators can increase or decrease this default number (See items per page).
  6. Click a title to view the full description (this navigates to the description's view page)

As of the current ICA-AtoM version:

  • Search results can be saved as a report and printed (click on Printer Icon in title bar)
  • Search runs on the language specified by the current language. It will not display results for descriptions that are not translated into the current language

Future releases will address current limitations.


Search for authority records or archival institutions

Authority records search box in the Caribou theme
  1. In the search box at the bottom of browse results for authority records or archival institutions, enter a search query. Use a single keyword or more advanced queries using quotations, boolean operators etc. (see Advanced search)
  2. The search results page will display the results
  3. To view an authority record or archival institution, click on one of the blue links in the search results

Search for accession records

Accession records search box in the Trilium theme

To search for accession records, you must first have a user account with sufficient edit permissions to access the Accessions module. This includes editors, contributors, and administrators; additionally, a translator with edit permissions in both the current language and the original language in which the accession record was created may access the accessions module.

To search accession records:

  1. Navigate to Manage > Accessions via the main menu
  2. In the search box at the bottom of browse results for accession records, enter a search query. Use a single keyword or more advanced queries using quotations, boolean operators etc. (see Advanced search)
  3. The search results page will display the results
  4. To view an accession records, click on one of the blue links in the search results

Searches in accession records can also be limited to specific fields for more targeted results - See: Search fields#Accession record