ViRR Editing

Introduction
A small glossary for the used terms can be found under Miscellaneous. NOTE: Please enter all comments concerning the use cases on the 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:
 * The spec for R2

Scenario
1. Pagination
 * ORDER: First step
 * OBLIGATION: mandatory
 * WHO: librarian
 * WHY: Physical pagination is needed for referencing single sites.
 * The user wants to get more information about a reference he saw in an interesting paper. Through the availability of the physical pagination he can directly jump to the referenced page without browsing the book.


 * GOALS: Logical and physical page numbers should be mapped.

2. Structure
 * ORDER: Second step
 * OBLIGATION: mandatory
 * WHO: librarian
 * WHY: Structures the book for a better clarity. Makes references on the basis of structural elements easier.
 * A team divided the structuring of a book in several steps. Mister X starts very fast with the rough structure so that later on Misses X can faster finished the structuring by only adding the descriptive metadata.


 * GOALS: Identification of the main structural parts of the book to prepare a further detailed description of the structure.

3. Descriptive Metadata Level 1
 * ORDER: Third step
 * OBLIGATION: optional
 * WHO: librarian
 * WHY: The user fills out only the descriptive metadata about the structural elements which are clearly related. He leaves the other, more specific metadata, to the scientist with special knowledge in this area.
 * GOALS: Preparation for Descriptive Metadata Level 2

4. Descriptive Metadata Level 2
 * ORDER: Fourth step
 * OBLIGATION: mandatory
 * WHO: scientist
 * WHY: Specifies the content of the book. Makes content retrieval via a search index.
 * The user is interested in the title of a book. As he takes a look at the toc he can identify which part(s) of the books are really interesting for him and on which page he can find this special content. In addition he gets an overview from the toc about which other topics he can find in this book. Later he told his college that chapter 20 is very interesting for their project and that he must read it. As the college wants to check the chapter he can't remember the number, but the author. So he uses the search engine and gets back the desired chapter.


 * GOALS: The whole structure of the book should be enhanced with the corresponding descriptive metadata.

5. Bibliographical Metadata
 * ORDER: unordered
 * WHO: librarian, scientist
 * WHY: Makes content retrieval via a search index. Serves as a description of the whole work.
 * The librarian wants to check if the automatic ingested metadata is still valid and if he can add further information (e.g. keywords) to make the work easier traceable.


 * GOALS: The bibliographical metadata should be completed and correct.

Variants:
 * It should be possible to perform following steps in one task:
 * Step 1 and 2
 * Step 2 and 3
 * Step 2 and 4 (if step 3 does not exist)

UC_VR_ED_01 Edit structural content
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to edit the structural content of a volume or monograph. This also includes the modification of already available and/or released structural content by providing additional data, correcting or deleting existing data.

Pre-Condition
 * One volume or monograph is selected.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_08 View editors workspace

Steps
 * 1) The user chooses to edit the structural content of the selected volume or monograph.
 * 2) Extension point: edit pagination
 * 2.1 If the user wants to edit the pagination of the selected volume or monograph, include UC_VR_ED_02 Edit pagination.
 * 1) Extension point: create structural element
 * 3.1 If the user wants to create a new structural element for the ToC, include UC_VR_ED_03 Create structural element.
 * 1) Extension point: edit structural element
 * 4.1 If the user wants to edit a structural element within the ToC or want to see all available (descriptive) metadata about a structural element, include UC_VR_ED_04 Edit structural element.
 * 1) Extension point: delete structural element
 * 5.1 If the user wants to delete a structural element within the ToC, include UC_VR_ED_05 Delete structural element.
 * 1) Extension point: release structural content
 * 7.1 If the user wants to release the structural content, include UC_VR_ED_06 Release structural content.
 * 1) The system creates a new version of the selected structural content, saves the changes and updates the state of the structural content:
 * 2) * when no released version exists to "in work"
 * 3) * when already a released version exists to "in rework"
 * 4) The use case ends successfully.

Actors Involved
 * Editor

Constraints
 * Only the latest version of the volume's or monograph's structural content is editable.

UC_VR_ED_02 Edit pagination
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to record the page labels (original physical pagination e.g.: I, II, 1, 2, 3, ...) in addition to the logical pagination (scan/page number).

Pre-Condition
 * One volume or monograph is selected

Steps
 * 1) The user chooses to create or edit the page labels of the selected volume or monograph.
 * 2) The system displays the pagination of the selected volume or monograph (all logical order numbers next to the available corresponding page labels).
 * 3) (Optionally) The user selects one page and changes the page label manually.
 * 4) (Optionally) The user selects a continuous page range, "arabische Zahlen" or "römische Zahlen" as type of the page labels, enters the start page label number (max. 5 characters) and chooses to assign the page labels.
 * 4.1 The starting page label number is an integer. The system updates the display of the pagination as defined: it starts from the selected start page with the selected page label number in a serial way till the selected end.
 * 1) (Optionally) The user selects a continuous page range, "unnummeriert" as type of the page labels, optionally enters the start page label term.
 * 5.1 The system updates the display of the pagination as defined: it starts from the selected start page with the selected page label (if no term is given by the user, the term "unnummeriert" will automatically be taken by the system) in a serial way (always uses the same page label term) till the selected end.
 * 1) The user saves his input.
 * 2) The system stores the changed page labels within the pagination. The use case ends successfully.

Alternatives
 * 4.1.a The filled in value is not an integer. The system displays a message (MSG_VR_ED_01). Continue with Step 4 (with all other user input pre-filled).

Actors Involved
 * Editor

UC_VR_ED_03 Create structural element
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to describe the structure of a volume or monograph by defining a new structural element. The detailed structural content for the volume or monograph is created by all structural elements defined.

Pre-Condition
 * One volume or monograph is selected.

Triggers
 * This use case has to be included by one of the following use cases
 * UC_VR_ED_01 Edit structural content

Steps
 * 1) The user chooses to create a new structural element for the selected volume or monograph.
 * 2) The system displays the hierarchical order of all available structural elements of the selected volume or monograph. If no structural elements are available, the hierarchy only contains the root element.
 * 3) The user selects a place in the volume's or monograph's hierarchical order where the new structural element should be placed and the type of the structural element.
 * 4) Continue with UC_VR_ED_04 Edit structural element.

Actors Involved
 * Editor

UC_VR_ED_04 Edit structural element
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user chooses to edit a structural element (e.g. enrich the metadata).

Pre-Condition
 * One structural element is selected.

Triggers
 * This use case has to be included by one of the following use cases
 * UC_VR_ED_03 Create structural element
 * UC_VR_ED_01 Edit structural content

Steps
 * 1) The user chooses to edit the selected structural element.
 * 2) The system displays an edit mask for all descriptive metadata (see ESciDoc Application Profile ViRR-Element) for the selected structural element. Already available metadata values are pre-filled.
 * 3) The user chooses to assign one or several pages to the selected structural element.
 * 3.1 The system displays a list of all available pages of the corresponding volume or monograph.
 * 3.2 The user selects one or more pages and assigns them to the selected structural element.
 * 1) (Optionally) The user edits the metadata values, adds new metadata values or modifies existing metadata values of the selected structural element.
 * 2) (Optionally) The user wants to change the place of the selected structural element in the volume's or monograph's hierarchical order.
 * 5.1 The system displays the hierarchical order (with the selected structural element highlighted) of the selected volume or monograph.
 * 5.2 The user selects a new place in the volume's or monograph's hierarchical order for the selected structural element.
 * 5.3 The system moves the selected structural element with all its metadata to the new place (Check detailed spec for tree navigation).
 * 1) (Optionally) The user wants to change the assigned page(s) of the structural element.
 * 6.1 The system displays the current assigned page(s) of the selected structural element.
 * 6.2 The user deletes one or several assigned pages or assigns one or more new pages.
 * 1) (Optionally) The user only assigns the first page for each structural element.
 * 7. The user wants the system to fill the gaps in his assignment, Continue with UC_VR_ED_08_Fill_Gap.
 * 1) The user saves his input.
 * 2) The system stores the changes. The use case ends successfully.

Actors Involved
 * Editor

Remarks
 * It could happen that one page will be assigned to more than one structural elements (e.g. one chapter begins in the middle of a page --> the page belongs to two structural elements).

UC_VR_ED_05 Delete structural element
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to delete a structural element because it is not needed any more.

Pre-Condition
 * One structural element is selected.

Triggers
 * This use case has to be included by one of the following use cases
 * UC_VR_ED_01 Edit structural content

Steps
 * 1) The user chooses to delete a structural element with all its metadata.
 * 2) The system displays the selected structural element in its hierarchical context with all its metadata and its content.
 * 3) The user confirms the deletion of the structural element which contains the deletion of all corresponding metadata and its content.
 * 4) The system deletes the selected structural element, its metadata and its content. The use case ends successfully.

Actors Involved
 * Editor

UC_VR_ED_06 Release structural content
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user is finished with the structuring of a volume or monograph (creation/editing of structural elements) and wants to release all structural content about the volume or monograph so that all users can see and work with it.

Pre-Condition
 * One volume or monograph is selected.
 * The structural content of the selected volume or monograph is in the state "in work" or in "rework".

Triggers
 * This use case can be included by the use cases
 * UC_VR_ED_02 Edit structural content
 * UC_VR_BD_08 View editors workspace

Steps
 * 1) The user chooses to release all structural content (all structural elements with their descriptive metadata in their hierarchical order with the corresponding page labels) of the selected volume or monograph.
 * 2) The system asks for a confirmation of the release.
 * 3) The user confirms the release.
 * 4) The system releases the structural content of the selected volume or monograph, sets the state of the structural content to "released" and displays a message (MSG_VR_ED_02). If already an older released version of the structural content exists, this one will be replaced. The use case ends successfully.

Actors Involved
 * Editor

Constraints
 * Only the latest version of the volume's or monograph's structural content can be released. Former released versions will automatically be overwritten. So its only possible to have maximum one version of the structural content released.

UC_VR_ED_07 Edit bibliographic metadata
Status/Schedule
 * Status: implemented
 * Schedule: R2

Motivation
 * The user wants to edit the (automatic ingested) bibliographic metadata of a multivolume together with its volumes or a monograph.

Pre-Condition
 * One multivolume or monograph is selected.

Triggers
 * This use case can be included by the use cases
 * UC_VR_BD_08 View editors workspace

Steps
 * 1) The user chooses to edit the bibliographic metadata of the selected multivolume (together with it's volumes) or monograph.
 * 2) The system displays an edit mask for all bibliographic metadata for the selected multivolume or monograph. Already available metadata values are pre-filled.
 * 3) (Optionally) The user edits the multivolume's (together with it's volumes) or monograph's metadata values, adds new metadata values or modifies existing metadata values and saves all changes.
 * 4) The system asks for a confirmation for the saving which automatically includes a release.
 * 5) The user confirms the saving.
 * 6) The system saves the modification of the bibliographic metadata of the selected multivolume or monograph and displays a message (MSG_VR_ED_04). As the state of the bibliographical metadata is always "released", the changes will automatically be visible for all users. The use case ends successfully.

Actors Involved
 * Editor

Constraints
 * Only the bibliographic metadata of the latest version of a container (multivolume or monograph) is editable.
 * The modification of bibliographic metadata can only be saved and released in one step. Its not possible to save it only.

UC_VR_ED_08 Validate Work
Status/Schedule Actors Involved
 * Status: specified
 * Schedule: R3.1
 * Editor

Steps
 * 1.     The user chooses to validate the work he edited
 * 2.     The system starts the validation of the following parameters:
 * 2.1. Are there structural elements in the work which have no assigned pages?
 * 2.2. Is the pagination sequential?
 * 2.3. Are there pages which are not assigned to a structural element
 * 2.4. Are there pages which are not paginated?
 * 3.     The system displays a validation report. The use case ends successfully

Comment
 * The validation report should only function as an information to the user. It should be possible to release a toc at any time, even if the validation report contains 'problems'.

Tree Navigation

 * Moving a page:


 * Moving a structural element:

Requirements

 * 1) Saving of the metadata of one structural element to use them for another structural element (some sort of "Zwischenablage") within all books of ViRR.