Difference between revisions of "ViRR Searching"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{ESciDoc Solutions}} | {{ESciDoc Solutions}} | ||
== Introduction == | == Introduction == | ||
A small glossary for the used terms can be found under [[ViRR_Miscellaneous#Glossary|Miscellaneous]]. | A small glossary for the used terms can be found under [[ViRR_Miscellaneous#Glossary|Miscellaneous]]. | ||
== UC_VR_SR_01 Do simple search == | |||
'''Status/Schedule''' | |||
* Status: in specification | |||
* Schedule: '''R3''' | |||
'''Motivation''' | |||
* The user wants to search simple within the ViRR collection. | |||
'''Expected Outcome''' | |||
* The search results are displayed. | |||
'''Steps''' | |||
# The user chooses to execute a search. | |||
# The system displays the simple search field. | |||
# The user provides a search string into the simple search field and starts the search. | |||
#: The search string consists of one or more search tokens. A token can be a single word (= term) or a phrase (= any string in double quotes). A term may contain wildcards in the middle or at the end (* for matching zero to many characters, ? for matching zero or one character). Wildcards are not allowed as the first character. Within a phrase token, no wildcards are allowed. Phrases are automatically right truncated, thus in its context, the phrase may be followed by any character. Tokens may be combined through boolean operators (AND, OR, NOT) and grouped by parenthesis. If no boolean operator is given between the tokens AND is used as default operator. | |||
# The system searches for the search string in defined data of the items and creates a search result. | |||
containing all items visible to the user according to his privileges. If the search term or phrase was found in a file, the search result contains a text fragment including at least 10 words before and 10 words after the found term or phrase for every hit. | |||
# The system searches for the defined search criteria and creates a search result containing all pictures visible to the user according to his privileges (logged in or not). | |||
# The system displays the search query and the list of pictures of the search result. Include [[Faces_Browse_and_Display#UC_FAC_BD_01_View_picture_list|UC_FAC_BD_01 View picture list]]. | |||
# (Optionally) The user chooses to revise the search. | |||
#: 6.1 The system displays the search mask again with the filled out search criteria the user has entered before. | |||
#: 6.2 Continue with step 3. | |||
# The user is satisfied with the search result. The use case ends successfully. | |||
'''Alternatives''' | |||
'''Actors Involved''' | |||
'''Constraints''' | |||
* Simple Search | * Simple Search | ||
** One search field, which searches in every metadata field | ** One search field, which searches in every metadata field | ||
== UC_VR_SR_02 Do advanced search == | |||
* Advanced Search | * Advanced Search | ||
** Search for special metadata | ** Search for special metadata | ||
| Line 17: | Line 53: | ||
=== Open Points === | === Open Points === | ||
* Are auto suggested fields in terms of lists needed for special metadata fields (e.g. author)? | * Are auto suggested fields in terms of lists needed for special metadata fields (e.g. author)? | ||
=== Requirements === | === Requirements === | ||
Revision as of 07:58, 19 September 2008
|
Introduction[edit]
A small glossary for the used terms can be found under Miscellaneous.
UC_VR_SR_01 Do simple search[edit]
Status/Schedule
- Status: in specification
- Schedule: R3
Motivation
- The user wants to search simple within the ViRR collection.
Expected Outcome
- The search results are displayed.
Steps
- The user chooses to execute a search.
- The system displays the simple search field.
- The user provides a search string into the simple search field and starts the search.
- The search string consists of one or more search tokens. A token can be a single word (= term) or a phrase (= any string in double quotes). A term may contain wildcards in the middle or at the end (* for matching zero to many characters, ? for matching zero or one character). Wildcards are not allowed as the first character. Within a phrase token, no wildcards are allowed. Phrases are automatically right truncated, thus in its context, the phrase may be followed by any character. Tokens may be combined through boolean operators (AND, OR, NOT) and grouped by parenthesis. If no boolean operator is given between the tokens AND is used as default operator.
- The system searches for the search string in defined data of the items and creates a search result.
containing all items visible to the user according to his privileges. If the search term or phrase was found in a file, the search result contains a text fragment including at least 10 words before and 10 words after the found term or phrase for every hit.
- The system searches for the defined search criteria and creates a search result containing all pictures visible to the user according to his privileges (logged in or not).
- The system displays the search query and the list of pictures of the search result. Include UC_FAC_BD_01 View picture list.
- (Optionally) The user chooses to revise the search.
- 6.1 The system displays the search mask again with the filled out search criteria the user has entered before.
- 6.2 Continue with step 3.
- The user is satisfied with the search result. The use case ends successfully.
Alternatives
Actors Involved
Constraints
- Simple Search
- One search field, which searches in every metadata field
UC_VR_SR_02 Do advanced search[edit]
- Advanced Search
- Search for special metadata
- Should there be a possibility to save the search?
The output of a search will always be the metadata of a book, not the scans.
Open Points[edit]
- Are auto suggested fields in terms of lists needed for special metadata fields (e.g. author)?
Requirements[edit]
- When the search string is part of a title of a structural element, the user will see the first scan (in the browse book view) of the corresponding structural element