Difference between revisions of "Search"

From ICA-AtoM
Jump to navigation Jump to search
 
(67 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
 
  
−
== Basic search ==
+
<div class="clearfix">
  
−
[[Image:um4-1SearchBox.png|500px|right|thumb|Enter a term in the Search box]]
+
== Search for resource descriptions ==
  
−
[[Image:um4-1SearchResults.png|500px|right|thumb|Search results screen]]
+
[[Image:search.png|right|thumb|500px|A search results page]]
  
 +
#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]])
  
−
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.
+
</div>
  
 +
<div class="note">
  
−
1. Enter search text in the [[Glossary#Search box|Search box]].
+
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
  
 +
Future releases will address current limitations.
  
−
2. Click the [[Glossary#Search button|Search button]].
+
</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:
+
<div class="clearfix">
−
*The number of descriptions found.
 
−
*For each match, the description title and the first three lines of the "Scope and content" field.
 
  
 +
== Search for authority records or archival institutions ==
  
−
4. Click a title to view the full description (routes you to the record's [[Glossary#View screen|View screen]]).
+
[[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]])
−
== Notes and limitations ==
+
# 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]]
  
−
As of the current version of ICA-AtoM (v0.6):
+
== Search for accession records ==
  
−
*Search is '''not''' case-sensitive.
+
[[Image:accessionSearch.png|500px|right|thumb|Accession records search box in the Trilium theme]]
  
−
*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]].
+
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.  
  
−
*You cannot save the search results.
+
* 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]]
  
−
*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]].
+
To search [[Glossary#Accession record|accession records]]:
  
−
*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.
+
# 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]]
  
 +
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]]
  
−
Future releases of ICA-AtoM (post-1.0) will address limitations.
 
  
−
<br clear="right">
+
</div>
−
== 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 Zend's Lucene search supports, 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].
+
<div class="clearfix">
  
−
What follows is a selection of some of the most commonly used tools.
+
[[Category:User manual]]
−
 
 
−
 
 
−
'''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>
 

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



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