Difference between revisions of "ViRR Browse and Display"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{ViRR}}
{{ViRR}}
'''NOTE:''' Please enter all comments concerning the use cases on the [[Talk:ViRR_Browse_and_Display|discussion page]].


== Introduction ==
== Introduction ==
A small glossary for the used terms can be found under [[ViRR_Miscellaneous#Glossary|Miscellaneous]].<br/>
Find a small glossary of the terms used below at [[ViRR_Miscellaneous#Glossary|Miscellaneous]].<br/>
'''NOTE:''' Please enter all comments concerning the use cases on the [[Talk:ViRR_Browse_and_Display|discussion page]].


As '''the current state of the spec focuses on R3''', earlier states of the spec can be found in the history of this page:
As '''the current state of the spec focuses on R3''', earlier states of the spec can be found in the history of this page:
Line 10: Line 11:
== UC_VR_BD_01 Browse content ==
== UC_VR_BD_01 Browse content ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: extension planned
* Schedule: '''''R3'''''
* Schedule: '''''Project Phase'''''


'''Motivation'''
'''Motivation'''
Line 18: Line 19:
'''Steps'''
'''Steps'''
# The user chooses to browse the content of the collection alphabetically.
# The user chooses to browse the content of the collection alphabetically.
# The system displays the content (all available multivolumes and monographs) of ViRR (multivolumes and volumes in the short [[ViRR_Display#Display_of_bibliographical_Metadata|display type]], volumes in the minimal one). The content should be sorted alphabetically by author/title (see [https://zim01.gwdg.de/repos/smc/trunk/03_Functional_Description/02_Scenarios_Concepts/Concepts/Virtueller_Raum_Reichsrecht/01_Documentation/Browsen_alphabetisch.doc alphabetical list of the digitalized works]). The rules for the alphabetical sorting are:
# The system displays the content of ViRR (multivolumes and volumes in the medium [[ViRR_Display#Medium_View|display type]]. The content should be sorted alphabetically by author/title (see [https://zim01.gwdg.de/repos/smc/trunk/03_Functional_Description/02_Scenarios_Concepts/Concepts/Virtueller_Raum_Reichsrecht/01_Documentation/Browsen_alphabetisch.doc alphabetical list of the digitalized works]). The rules for the alphabetical sorting are:
#* If the creator is the editor ("HRSG.") or the legislator ("Kaiser"), the title is used as sorting key (=> roleTerm != aut)
#* If the creator is the editor ("HRSG.") or the legislator ("Kaiser"), the title is used as sorting key (=> roleTerm != aut)
#* Else the creator is used as sorting key
#* Else the creator is used as sorting key
Line 29: Line 30:
# The use case ends successfully.  
# The use case ends successfully.  


'''Alternatives'''
'''Future Implementation'''
:''1.b The user chooses to browse the content of the collection systematically.''
:''1.b The user chooses to browse the content of the collection systematically.''
::''1.1 The system displays the content (multivolumes and volumes in the short [[ViRR_Display#Display_of_bibliographical_Metadata|display type]], volumes in the minimal one). The content should be sorted systematically. Further on, each systematically rubric started with the corresponding headline (see [https://zim01.gwdg.de/repos/smc/trunk/03_Functional_Description/02_Scenarios_Concepts/Concepts/Virtueller_Raum_Reichsrecht/01_Documentation/Browsen_systematisch.doc systematical list of the digitalized works]). Continue with Step3.''
::''1.1 The system displays the content in the medium [[ViRR_Display#Medium_View|display type]]. The content should be sorted systematically. Further on, each systematically rubric started with the corresponding headline (see [https://zim01.gwdg.de/repos/smc/trunk/03_Functional_Description/02_Scenarios_Concepts/Concepts/Virtueller_Raum_Reichsrecht/01_Documentation/Browsen_systematisch.doc systematical list of the digitalized works]). Continue with Step3.''


'''Actors Involved'''
'''Actors Involved'''
Line 59: Line 60:
'''Status/Schedule'''
'''Status/Schedule'''
* Status: implemented
* Status: implemented
* Schedule: '''''R2'''''
* Schedule: '''R2.6'''


'''Motivation'''  
'''Motivation'''  
Line 76: Line 77:
# Extension point: '''browse volume or monograph'''
# Extension point: '''browse volume or monograph'''
#: 4.1 If the user wants to browse through the pages of the volume or monograph, include [[ViRR_Browse_and_Display#UC_VR_BD_04_Browse_volume_or_monograph|UC_VR_BD_04 Browse volume or monograph]].
#: 4.1 If the user wants to browse through the pages of the volume or monograph, include [[ViRR_Browse_and_Display#UC_VR_BD_04_Browse_volume_or_monograph|UC_VR_BD_04 Browse volume or monograph]].
# ''Extension point: '''view structural content''' ''
# Extension point: '''view structural content'''  
#: 5.1 ''If the user wants to view the structural content of the selected volume or monograph, include [[ViRR_Browse_and_Display#UC_VR_BD_06_View_structural_content|UC_VR_BD_06 View structural content]].''
#: 5.1 If the user wants to view the structural content of the selected volume or monograph, include [[ViRR_Browse_and_Display#UC_VR_BD_06_View_structural_content|UC_VR_BD_06 View structural content]].
# Extension point: '''view metadata in ISBD style'''  
#: 6.1 The user chooses to view the bibliographic metadata in [[ViRR_Display#ISBD_Style | ISBD Style]].
# Extension point: '''view work in DFG viewer'''
#: 7.1 The user chooses to view the work in the DFG Viewer, include [[ViRR_Browse_and_Display#UC_VR_BD_07_View_pages_in_DFG_Viewer|UUC_VR_BD_07 View pages in DFG Viewer]].
# The use case ends successfully.
# The use case ends successfully.


Line 109: Line 114:
#: 4.1 If the user wants to view the structural content of the selected volume or monograph, include [[ViRR_Browse_and_Display#UC_VR_BD_06_View_structural_content|UC_VR_BD_06 View structural contents]].
#: 4.1 If the user wants to view the structural content of the selected volume or monograph, include [[ViRR_Browse_and_Display#UC_VR_BD_06_View_structural_content|UC_VR_BD_06 View structural contents]].
# Extension point: '''view volume or monograph details'''
# Extension point: '''view volume or monograph details'''
#: 5.1 If the user wants to view the details of the volume's or monograph's metadate, include [[ViRR_Browse_and_Display#UC_VR_BD_03_View_volume_or_monograph_details|UC_VR_BD_03 View volume or monograph details]].
#: 5.1 If the user wants to view the details of the volume's or monograph's metadata, include [[ViRR_Browse_and_Display#UC_VR_BD_03_View_volume_or_monograph_details|UC_VR_BD_03 View volume or monograph details]].
# Extension point: '''view picture'''
# Extension point: '''view picture'''
#: 6.1 If the user wants to view one picture in its original size, include [[ViRR_Browse_and_Display#UC_VR_BD_05_View_picture|UC_VR_BD_05 View picture]].
#: 6.1 If the user wants to view one picture in its original size, include [[ViRR_Browse_and_Display#UC_VR_BD_05_View_picture|UC_VR_BD_05 View picture]].
Line 115: Line 120:


'''Alternatives'''
'''Alternatives'''
:1.a ''The use case has been triggered by [[ViRR_Browse_and_Display#UC_VR_BD_06_View_structural_content|UC_VR_BD_06 View structural content]] where the user has selected a structural element where he wants to start the browsing.''
:1.a The use case has been triggered by [[ViRR_Browse_and_Display#UC_VR_BD_06_View_structural_content|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 [[ViRR_Display#Display_of_bibliographical_Metadata|display type]]) of the selected volume or monograph. Continue with Step 3.''
:# The system displays the first content page of the selected structural element and the notation (in the full [[ViRR_Display#Display_of_bibliographical_Metadata|display type]]) of the selected volume or monograph. Continue with Step 3.


'''Actors Involved'''  
'''Actors Involved'''  
Line 171: Line 176:
* User
* User


== UC_VR_BD_07 View pages in [[DFG Viewer]] ==
== UC_VR_BD_07 View editors workspace ==
'''Status/Schedule'''
* Status: implemented
* Schedule: '''R2'''
 
'''Motivation'''
* To demonstrate the compatibility of ViRR with the DVG viewer, the user should have the possibility to view a selected volume or monograph in the DFG viewer.
 
'''Pre-Condition'''
* One volume or monograph is selected.
 
'''Steps'''
# The user chooses to view the selected volume or monograph in the DFG viewer.
# The system opens a new tab, goes to the DFG viewer and displays the first content page of the selected volume or monograph in the DFG viewer (with all its functionalities available). The use case ends successfully.
 
'''Actors Involved'''
* User
 
== UC_VR_BD_08 View editors workspace ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: implemented
* Status: implemented
* Schedule: '''R2'''
* Schedule: '''R2.6'''


'''Motivation'''  
'''Motivation'''  
Line 201: Line 188:
# The system displays the editors workspace with all works within ViRR. For each work, following information about the related container is displayed (if available):  
# The system displays the editors workspace with all works within ViRR. For each work, following information about the related container is displayed (if available):  
#* date last modified, date last released, state
#* date last modified, date last released, state
# (Optionally) The user chooses to filter the editors workspace by selecting a special state. <font color="red">Not In</font>
# (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 in the selected state. When a volume is displayed, the corresponding multivolume will be displayed, too.
#: 3.1 The system only displays the works with selected status. When a volume is displayed, the corresponding multivolume will be displayed, too.
# Extension point: '''edit bibliographic metadata'''
# Extension point: '''edit bibliographic metadata'''
#: 4.1 If the user wants to edit the bibliographic metadata of a '''multivolume''' or '''monograph''', include [[ViRR_Editing#UC_VR_ED_07_Edit_bibliographic_metadata|UC_VR_ED_07 Edit bibliographic metadata]].
#: 4.1 If the user wants to edit the bibliographic metadata of a multivolume or monograph, include [[ViRR_Editing#UC_VR_ED_07_Edit_bibliographic_metadata|UC_VR_ED_07 Edit bibliographic metadata]].
# Extension point: '''edit structural content'''
# Extension point: '''edit structural content'''
#: 5.1 If the user wants to edit the structural content of a '''volume''' or '''monograph''', include [[ViRR_Editing#UC_VR_ED_01_Edit_structural_content|UC_VR_ED_01 Edit structural content]].
#: 5.1 If the user wants to edit the structural content of a volume or monograph, include [[ViRR_Editing#UC_VR_ED_01_Edit_structural_content|UC_VR_ED_01 Edit structural content]].
# Extension point: '''release structural content'''
# Extension point: '''release structural content'''
#: 6.1 If the user wants to release the structural content in the state "in work" of a '''volume''' or '''monograph''', include [[ViRR_Editing#UC_VR_ED_06_Release_structural_content|UC_VR_ED_06 Release structural content]].
#: 6.1 If the user wants to release the structural content in the state "pending" of a volume or monograph, include [[ViRR_Editing#UC_VR_ED_06_Release_structural_content|UC_VR_ED_06 Release structural content]].
# The use case ends successfully.
# The use case ends successfully.


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


'''Remarks'''
== UC_VR_BD_08 View search results ==
* The system can display the editors workspace with a list of all '''multivolumes''', '''volumes''' and '''monographs''' within ViRR (multivolumes and monographs are displayed in the short, volumes in the minimal [[ViRR_Display#Display_of_bibliographical_Metadata|display type]]).
* The system can display the browsing tree of the works within the editors workspace.
 
== UC_VR_BD_09 View search results ==
'''Status/Schedule'''
'''Status/Schedule'''
* Status: in specification
* Status: planned
* Schedule: '''R3'''
* Schedule: '''Project Phase'''


'''Motivation'''
'''Motivation'''
Line 251: Line 234:
== Additional Information ==
== Additional Information ==


=== States ===
=== Status ===
'''Bibliographic Metadata'''
'''Bibliographic Metadata'''<br/>
* is always in the state '''released'''
Always in the state '''released'''
'''Structural Content'''
 
* Structural content means all structural elements with their descriptive metadata in their hierarchical order with the corresponding physical pagination
'''Structural Content'''<br/>
* Following states are available:
''Structural content are all structural elements with their descriptive metadata in their hierarchical order with the corresponding physical pagination.''


::{| border="1"
::{| border="1"
Line 262: Line 245:
|width="200pt"| '''State (DE)'''
|width="200pt"| '''State (DE)'''
|width="150pt"| '''State technically'''
|width="150pt"| '''State technically'''
|width="500pt"| '''Explenation'''
|width="500pt"| '''Explanation'''
|-
| No toc
| Kein Inhaltsverzeichnis vorhanden
| submitted
| never touched by the user
|-
| In work
| In Bearbeitung
| submitted
| in the process of being edited, but not finished for a release
|-
|-
| Released
| Released
| Veröffentlicht
| Veröffentlicht
| released
| released
| the editor was finished with the editing of the metadata part and has published it so that all users can view the recorded data
| Initial state of an empty ToC after ingestion. <br/>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
|-
|-
| In rework
| Under Rework
| In Überarbeitung
| In Überarbeitung
|  
| pending
| the older version is still released + a working copy (revision?) in the state submitted exists
| An edited, not yet released version of a ToC
|}
|}


* When ingesting a volume or monograph within ViRR, the state of the corresponding structural content should always be "no toc"
== Further Requirements ==
* Index list
: What should be indexed? --[[User:Wfrank|Wilhelm]] 16:57, 29 July 2008
'''Detailed views'''
* Digilib functionalities to navigate within one picture (in the "detailed view")
** Zooming in, zooming out, framing of a zoom area, switching back to see the whole picture
** Left, right, up and down navigation within a zoomed picture
** "View negative" functionality
** Dynamic creation of a "identification stamp" (Herkunftsnachweis) on all pictures in the "detailed view" (also after zooming)
* METS document in XML of one book
: What is the purpose and the content of this METS document? --[[User:Wfrank|Wilhelm]] 16:57, 29 July 2008
'''Linking to the OPAC of the institute'''
* Each multivolume, volume or monograph can be linked to the corresponding entry in the [http://sunrise.mpier.uni-frankfurt.de/webOPAC/ OPAC of the institute].


'''Open Points'''
* Is a browsing via the names of the documents (law titles) needed?




[[Category:Virtueller Raum Reichsrecht|Browse and Display]]
[[Category:Virtueller Raum Reichsrecht|Browse and Display]]
[[Category:Functional_specification]]
[[Category:VIRR_Functional_specification | Browse and Display]]

Latest revision as of 10:24, 18 May 2010

Virr Medium Multivolume 31 Static.gif Virtueller Raum Reichsrecht

Overview
Functionalities
Support
Copyright and Disclaimer
Scope

Metadata:
Application Profile · Content Models
Metadata Display · ViRR Metadata
Action Matrix

Transformations:
virr 2 mets · mab 2 mods
mods 2 oai dc · mods 2 marc21

Specification

Intern:
Meetings · GUI · Miscellaneous
Development · Planning · Feedback
Related Projects:
Judicial Journals · Late Scholasticism
Digitization Lifecycle

edit

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


Introduction[edit]

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:

UC_VR_BD_01 Browse content[edit]

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:
    • If the creator is the editor ("HRSG.") or the legislator ("Kaiser"), the title is used as sorting key (=> roleTerm != aut)
    • Else the creator is used as sorting key
  3. (Optionally) The user chooses to view the volumes of a selected multivolume.
    3.1. The system displays all volumes of the selected multivolume.
  4. 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.
  5. 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.
  6. 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[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R1

Motivation

  • The user wants to see all details of a multivolume.

Triggers

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[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2.6

Motivation

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

Triggers

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.
  4. 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.
  5. 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.
  6. Extension point: view metadata in ISBD style
    6.1 The user chooses to view the bibliographic metadata in ISBD Style.
  7. 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.
  8. The use case ends successfully.

Actors Involved

  • User

UC_VR_BD_04 Browse volume or monograph[edit]

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

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.
  4. (Optionally) The user chooses to go to a special physical page number.
    4.1 The system displays the selected page.
  5. 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.
  6. 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.
  7. 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.
  8. 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.
  1. 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[edit]

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

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[edit]

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

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.
  4. 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.
  5. The use case ends successfully.

Actors Involved

  • User

UC_VR_BD_07 View editors workspace[edit]

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):
    • date last modified, date last released, state
  3. (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.
  4. 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.
  5. 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.
  6. 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.
  7. 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[edit]

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

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.
  4. (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.
  5. The use case ends successfully.

Actors Involved

  • User

Additional Information[edit]

Status[edit]

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.

State (EN) State (DE) State technically 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

Use Case

Virtueller Raum Reichsrecht

International Standard Bibliographic Description

Deutsche Forschungsgemeinschaft

Table of Contents

Retrieved from "https://colab.mpdl.mpg.de/mw010/index.php?title=ViRR_Browse_and_Display&oldid=51652"