ViRR Browse and Display

NOTE: Please enter all comments concerning the use cases on the discussion page.

Introduction
Find a small glossary of the terms used below at Miscellaneous.

As the current state of the spec focuses on R3, earlier states of the spec can be found in the history of this page:
 * The spec for R2

UC_VR_BD_01 Browse content
Status/Schedule
 * Status: extension planned
 * Schedule: Project Phase

Motivation
 * The user wants to browse the content of the collection.

Steps
 * 1) The user chooses to browse the content of the collection alphabetically.
 * 2) The system displays the content of ViRR (multivolumes and volumes in the medium display type. The content should be sorted alphabetically by author/title (see alphabetical list of the digitalized works). The rules for the alphabetical sorting are:
 * 3) * If the creator is the editor ("HRSG.") or the legislator ("Kaiser"), the title is used as sorting key (=> roleTerm != aut)
 * 4) * Else the creator is used as sorting key
 * 5) (Optionally) The user chooses to view the volumes of a selected multivolume.
 * 3.1. The system displays all volumes of the selected multivolume.
 * 1) Extension point: view multivolume details
 * 4.1 If the user wants to view the details of a multivolume, include UC_VR_BD_02 View multivolume details.
 * 1) Extension point: view volume or monograph details
 * 4.1 If the user wants to view the details of a volume or monograph, include UC_VR_BD_03 View volume or monograph details.
 * 1) The use case ends successfully.

Future Implementation
 * 1.b The user chooses to browse the content of the collection systematically.
 * 1.1 The system displays the content in the medium display type. The content should be sorted systematically. Further on, each systematically rubric started with the corresponding headline (see systematical list of the digitalized works). Continue with Step3.

Actors Involved
 * User

UC_VR_BD_02 View multivolume details
Status/Schedule
 * Status: implemented
 * Schedule: R1

Motivation
 * The user wants to see all details of a multivolume.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_01 Browse content
 * UC_VR_BD_03 View volume or monograph details

Steps
 * 1) The user selects a multivolume.
 * 2) The system displays the bibliographic metadata of the selected multivolume (in the full display type) and lists all corresponding volumes (in the minimal display type). The use case ends successfully.

Actors Involved
 * User

UC_VR_BD_03 View volume or monograph details
Status/Schedule
 * Status: implemented
 * Schedule: R2.6

Motivation
 * The user wants to see all details of a volume or monograph.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_01 Browse content
 * UC_VR_BD_04 Browse volume or monograph

Steps
 * 1) The user selects a volume or monograph.
 * 2) The system displays the bibliographic metadata of the selected volume or monograph (in the full display type) and if a volume is selected, the notation of the corresponding multivolume in the short view.
 * 3) Extension point: view multivolume details
 * 3.1 If a volume is selected and if the user wants to view the details of the volume's multivolume, include UC_VR_BD_02 View multivolume details.
 * 1) Extension point: browse volume or monograph
 * 4.1 If the user wants to browse through the pages of the volume or monograph, include UC_VR_BD_04 Browse volume or monograph.
 * 1) Extension point: view structural content
 * 5.1 If the user wants to view the structural content of the selected volume or monograph, include UC_VR_BD_06 View structural content.
 * 1) Extension point: view metadata in ISBD style
 * 6.1 The user chooses to view the bibliographic metadata in ISBD Style.
 * 1) Extension point: view work in DFG viewer
 * 7.1 The user chooses to view the work in the DFG Viewer, include UUC_VR_BD_07 View pages in DFG Viewer.
 * 1) The use case ends successfully.

Actors Involved
 * User

UC_VR_BD_04 Browse volume or monograph
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to browse through the pages of a volume or monograph.

Pre-Condition
 * One volume or monograph is selected.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_03 View volume or monograph details
 * UC_VR_BD_06 View structural content

Steps
 * 1) The user chooses to browse within the selected volume or monograph.
 * 2) The system displays the first content page and the notation (in the full display type) of the volume or monograph.
 * 3) (Optionally) The user chooses to go to the previous, to the next, to the first or to the last page.
 * 3.1 The system displays the selected page.
 * 1) (Optionally) The user chooses to go to a special physical page number.
 * 4.1 The system displays the selected page.
 * 1) Extension point: view structural content
 * 4.1 If the user wants to view the structural content of the selected volume or monograph, include UC_VR_BD_06 View structural contents.
 * 1) Extension point: view volume or monograph details
 * 5.1 If the user wants to view the details of the volume's or monograph's metadata, include UC_VR_BD_03 View volume or monograph details.
 * 1) Extension point: view picture
 * 6.1 If the user wants to view one picture in its original size, include UC_VR_BD_05 View picture.
 * 1) The use case ends successfully.

Alternatives
 * 1.a The use case has been triggered by UC_VR_BD_06 View structural content where the user has selected a structural element where he wants to start the browsing.
 * The system displays the first content page of the selected structural element and the notation (in the full display type) of the selected volume or monograph. Continue with Step 3.

Actors Involved
 * User

UC_VR_BD_05 View picture
Status/Schedule
 * Status: implemented
 * Schedule: R1

Motivation
 * The user wants so view one picture in its original size.

Pre-Condition
 * One page is selected.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_04 Browse volume or monograph

Steps
 * 1) The user chooses to view the picture in its original size.
 * 2) The system displays the selected picture in its original size. The use case ends successfully.

Actors Involved
 * User

UC_VR_BD_06 View structural content
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to view the structural content of a volume or monograph.

Pre-Condition
 * One volume or monograph is selected.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_03 View volume or monograph details
 * UC_VR_BD_04 Browse volume or monograph

Steps
 * 1) The user chooses to view the structural content of the selected volume or monograph.
 * 2) The system displays the structural content (all structural elements with their descriptive metadata in their hierarchical order with the corresponding physical pagination) with all its hierarchy levels open.
 * 3) (Optionally) The user wants to modify the view, in order to see a certain range of open hierarchy levels.
 * 3.1 The system displays the hierarchy levels in the selected way.
 * 1) Extension point: browse volume or monograph
 * 4.1 If the user wants to browse through the pages of the corresponding volume or monograph, he selects a structural element where he wants to start the browsing. Include UC_VR_BD_04 Browse volume or monograph.
 * 1) The use case ends successfully.

Actors Involved
 * User

UC_VR_BD_07 View editors workspace
Status/Schedule
 * Status: implemented
 * Schedule: R2.6

Motivation
 * The user wants to get an overview about all editing tasks (based on the metadata elements) he can do. This should include the information of the current state of all metadata elements.

Steps
 * 1) The user chooses to view the editors workspace.
 * 2) The system displays the editors workspace with all works within ViRR. For each work, following information about the related container is displayed (if available):
 * 3) * date last modified, date last released, state
 * 4) (Optionally) The user chooses to filter the editors workspace by selecting a special status (toc released, pending or all).
 * 3.1 The system only displays the works with selected status. When a volume is displayed, the corresponding multivolume will be displayed, too.
 * 1) Extension point: edit bibliographic metadata
 * 4.1 If the user wants to edit the bibliographic metadata of a multivolume or monograph, include UC_VR_ED_07 Edit bibliographic metadata.
 * 1) Extension point: edit structural content
 * 5.1 If the user wants to edit the structural content of a volume or monograph, include UC_VR_ED_01 Edit structural content.
 * 1) Extension point: release structural content
 * 6.1 If the user wants to release the structural content in the state "pending" of a volume or monograph, include UC_VR_ED_06 Release structural content.
 * 1) The use case ends successfully.

Actors Involved
 * Editor

Constraints
 * For the bibliographic metadata and the structural content, only the latest version of the container or item will be displayed.

UC_VR_BD_08 View search results
Status/Schedule
 * Status: planned
 * Schedule: Project Phase

Motivation
 * The user executed a search and wants to see the results.

Pre-Condition
 * A search was executed.

Triggers
 * This use case can be included by following use cases
 * UC_VR_SR_01 Do simple search
 * UC_VR_SR_02 Do advanced search

Steps
 * 1) The user chooses to view a list of search results by executing one of the above mentioned use cases.
 * 2) The system displays the number of hits and the list of entries. An entry can be the metadata of a publication or a structural element. (Details of how the entries shall be displayed still have to be specified.) The defaults for the sorting order (have to be specified) and the number of hits per page are given by the system (by default: 10 hits per page).
 * 3) (Optionally) The user changes the sorting order.
 * 3.1 The system displays the entry list in the selected sorted order.
 * 1) (Optionally) The user changes the displayed hits per page.
 * 4.1 The system displays the entry list with the selected number of hits per page.
 * 1) The use case ends successfully.

Actors Involved
 * User

Status
Bibliographic Metadata Always in the state released

Structural Content Structural content are all structural elements with their descriptive metadata in their hierarchical order with the corresponding physical pagination.


 * {| border="1"


 * width="100pt"| State (EN)
 * width="200pt"| State (DE)
 * width="150pt"| State technically
 * width="500pt"| Explanation
 * Released
 * Veröffentlicht
 * released
 * Initial state of an empty ToC after ingestion. Or the editor was finished with the editing of the metadata part and has published it so that all users can view the recorded data
 * Under Rework
 * In Überarbeitung
 * pending
 * An edited, not yet released version of a ToC
 * }
 * An edited, not yet released version of a ToC
 * }