Faces Browse and Display

From MPDLMediaWiki
Jump to navigation Jump to search
FACES

Scope · Functionalities
Disclaimer and Copyright
Support

Application Profiles
Release Agreement

Specification:
Browse and Display · Search
Albums · Users
Note Pads · Versioning

Related Projects:
Imeji

edit


Introduction[edit]

A small glossary for the used terms can be found under Miscellaneous.
Please enter all comments concerning the use cases on the discussion page.

As the current state of the spec focuses on R3.5, earlier states of the spec can be found in the history of this page:

Pictures[edit]

UC_FAC_BD_01 View picture list[edit]

Status/Schedule

  • Status: in design
  • Schedule: R3.5

Motivation

  • The user wants to view several or all pictures of the collection in the list view.

Triggers

Steps

  1. The user chooses to view the whole list of available pictures or executed one of the above mentioned use cases.
  2. The system displays the pictures list and the number of hits. The defaults for the sorting order and the number of hits per page are given by the system:
    • sorted by Emotion (alphabetically: anger, disgust, fear, happiness, neutrality and sadness) - Person-ID (ascending) - Picture Set (ascending)
    • number of hits per page: 12
  3. (Optionally) The user changes the sorting order by changing one or several sorting criteria, one or several ascending/descending arrows and confirms his choice.
    3.1 The system displays the picture list depending on the selected sorting criteria.
  4. (Optionally) The user chooses another number of hits to be displayed per page (12, 24, 60, 90).
    4.1 The system displays the picture list with the selected number of hits per page.
  5. (Optionally) The user goes to a special page, to the last page or to the first page.
    5.1 The system displays the selected page.
  6. Extension point: add pictures to album
    6.1 If the user wants to add pictures to one of his (shared) private albums, include UC_FAC_AM_02 Add picture to album.
  7. The use case ends successfully.

Actors Involved

  • User

Display Types[edit]

The FACES application will support different display types of lists for items (pictures and albums), which can be selected by the user.

For Picture Lists[edit]

The default display type is always the Picture View.

  1. Picture View
    • The first 2 metadata values (no labels) of the currently selected sorting order will be displayed (--> displayed metadata will change when the sorting is changed)
  2. Metadata View (Bibliographic View in PubMan)
    1. Short
      • The first 4 metadata values with labels of the default sorting order will be displayed (--> displayed metadata will not changed, also when the sorting is changed)
      • PLEASE NOTE: That means, that in the implementation, a default sorting order for all metadata (not only the first three) has to be defined.
    2. Medium
      • The next 4 metadata values with labels of the default sorting order will be displayed
  3. Grid View
    • The same 4 metadata values of the Short Metadata View will be displayed

For Albums Lists[edit]

The default display type is always the Grid View.

  1. Picture View
    • The album name is displayed (no label)
    • The icon in the middle is the state of the item (as there are no more differentiation between "my albums" and "public albums", the states have to be more specific:
      1. private + I am the owner
      2. private + I am the owner + I share the album
      3. private + I share the album (someone else is the owner)
      4. published + I am the owner
      5. published + I shared the album( someone else is the owner)
      6. published + someone else is the owner
      7. withdrawn
    • The icon in the right corner informs about the number of available note pads
  2. Metadata View (Bibliographic View in PubMan)
    1. Short
      • Following metadata values and labels will be displayed
      (1) Album.Name, (2) Album.NumberOfPictures, (3) Album.Owner, (4) Album.State (it must be visible if an album is shared not)
    2. Medium
      • All metadata from the short view and following metadata values and labels will be displayed
      (5) Album.Description, (6) Album.FurtherAuthors, (7) Album.DateLastModified, (8) Album.Owner.Affiliation
  3. Grid View
    • The same 4 metadata values of the Short Metadata View will be displayed

UC_FAC_BD_02 View picture details[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R1

Motivation

  • The user wants to view one picture in detail (a higher resolution of the picture and its attributes).

Steps

  1. The user selects one picture.
  2. The system displays the picture in the web resolution (detailed view) and all available attributes of the picture. One metadata value (the one that is currently used as first sorting criteria) will be displayed a second time as header of the metadata.
  3. Extension point: add pictures to album
    3.1 If the user wants to add pictures to one of his (shared) private albums, include UC_FAC_AM_02 Add picture to album.
  4. The use case ends successfully.

Actors Involved

  • User

UC_FAC_BD_03 View picture for comparison[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R1

Motivation

  • The user wants to see both picture sets of one image to compare them with each other.

Pre-Condition

  • One picture is selected (in the detailed view).

Steps

  1. The user chooses to view the picture for comparison (same image from the other picture set).
  2. The system displays the picture for comparison next to the selected one in the web resolution.
  3. Extension point: add pictures to album
    3.1 If the user wants to add pictures to one of his (shared) private albums, include UC_FAC_AM_02 Add picture to album.
  4. The use case ends successfully.

Actors Involved

  • User

Albums[edit]

UC_FAC_BD_04 View album details[edit]

Status/Schedule

  • Status: in design
  • Schedule: R3.5

Motivation

  • The user wants to view the details of an album.

Triggers

  • This use case can be included by following use cases:

Pre-Condition

  • One album is selected.
  • Further pre-conditions are based on the state of the album:
pending: The user is the owner of the item or has administrator rights.
released: None.
withdrawn: None.

Steps

  1. The user chooses to view the selected album.
  2. The system displays the metadata of the album (see Application Profile Album) and following further information depending on the state of the album:
    pending:
    • For all albums: date created, date last modified
    • For shared albums: the user who has done the last modification of the album, all active shared users (user names) and user groups and the owner of the album
    • For shared albums the user is the owner: all shared users (user names for active users and e-mail address for inactive users) inclusive the state of the shared users and all user groups.
    • If the user is an account user, include UC_FAC_BD_01 View picture list.
    released:
    • date created, date published
    • the affiliation of the album owner
    • the PID of the album
    • If the user is an account user, include UC_FAC_BD_01 View picture list.
    withdrawn:
    • date created, date published, date withdrawn
    • the affiliation of the album owner
    • the crossed out PID of the album
    • the withdrawl comment
    • If the user is the owner of the item or has administrator rights, include UC_FAC_BD_01 View picture list.
  3. Extension point: remove picture from album
    3.1 If the album is in the state pending or submitted, the user is the owner of the album or a shared user of the album and wants to remove a picture from the album, include UC_FAC_AM_03 Remove picture from album.
  4. Extension point: edit album
    4.1 If the album is in the state pending or submitted, the user is the owner of the album or a shared user of the album and wants to edit the album, include UC_FAC_AM_04 Edit album.
  5. Extension point: share album
    5.1 If the album is in the state pending and the user is the owner of the album, include UC_FAC_AM_09 Share album.
  6. Extension point: unshare album
    6.1 If the album is in the state submitted, the user is the owner of the album and at least one shares user for the album exists, include UC_FAC_AM_11 Unshare album.
  7. Extension point: delete album
    7.1 If the album is in the state pending or submitted, the user is the owner of the album and wants to delete the album, include UC_FAC_AM_05 Delete album.
  8. Extension point: release album
    8.1 If the album is in the state pending or submitted, the user is the owner of the album and wants to release the album, include UC_FAC_AM_06 Release album.
  9. Extension point: export album
    9.1 If the album is in the state pending or submitted (the user is the owner of the album or a shared user of the album) or in the state released and the user wants to export the pictures of the album, include UC_FAC_AM_08 Export album.
  10. Extension point: withdraw album
    10.1 If the album is in the state released, the user is the owner of the album and wants to withdraw the album, include use case UC_FAC_AM_07 Withdraw album.
  11. Extension point: create private note pad
    11.1 If the user is the owner of the album or a shared user of the album and wants to create a private note pad for the album, include use case UC_FAC_NP_01 Create private note pad.
  12. Extension point: view note pad
    12.1 If a corresponding note pad in the state pending exists, the user is the owner or a shared user of the note pad and wants to view it, include UC_FAC_NP_02 View note pad.
    12.2 If a corresponding note pad in the state released or withdrawn exists and the user wants to view it, include UC_FAC_NP_02 View note pad.
  13. Extension point: view album event log
    13.1 If the user is the owner of the album or a shared user of the album and wants to view the event log of the album, include UC_FAC_VS_01 View album event log.
  14. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_BD_05 View my albums[edit]

Status/Schedule

  • Status: in design
  • Schedule: R3.5

Motivation

  • The user wants to overview all his albums and all albums of other users he is sharing.
  • R4: The administrator wants to overview all albums of a special user).

Pre-Condition

  • One account user is selected.

Triggers

  • This use case can be included by following use cases

Steps

  1. The user chooses to overview his albums (including his shared albums).
  2. The system displays the list of all albums the selected user is the owner or an active shared user and the number of list entries.
    • In this list are displayed following information about each album:
    For all albums: the name, the number of pictures, the description if available, the date last modified and the state of the album.
    For shared albums: the information that the album is shared and the owner of the album.
    • The defaults for the sorting order and the number of hits per page are given by the system (by default: date last modified (beginning with the newest date), number of hits per page: 10).
  3. (Optionally) The user changes the sorting order (each entry can be used as sorting criteria).
    3.1 The system displays the album list in the selected sorting order.
  4. (Optionally) The user chooses another number of hits per page (following numbers are available: 10, 25, 50, 75, 100).
    4.1 The system displays the album list with the selected number of hits per page.
  5. (Optionally) The user goes to a special page, to the last page or to the first page.
    5.1 The system displays the selected page.
  6. Extension point: view album details
    6.1 If the user wants to view the details of a selected album, include UC_FAC_BD_04 View album details.
  7. Extension point: copy album content
    7.1 If the album is in the state pending (the user is the owner of the album or an active shared user of the album) or in the state released and the user wants to copy the content of the album, include UC_FAC_AM_12 Copy album content.
  8. Extension point: view not pad
    8.1 If the user wants to view the corresponding note pad of the album, include UC_FAC_BD_12 View note pad.
  9. The use case ends successfully.

Alternatives

1.a R4: The administrator chooses to overview all albums of a selected user. Continue with Step 2.

Actors Involved

  • Account user

UC_FAC_BD_06 View released albums[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2

Motivation

  • The user wants to overview all released albums.

Steps

  1. The user chooses to overview all released albums.
  2. The system displays the list of all released albums and the number of list entries. In this list are displayed following information about each album: the name, the number of pictures, the description if available, the owner, the affiliation of the owner and the date published. The defaults for the sorting order and the number of hits per page are given by the system (by default: date released (beginning with the newest date), number of hits per page: 10).
  3. (Optionally) The user changes the sorting order (each entry can be used as sorting criteria).
    3.1 The system displays the album list in the selected sorting order.
  4. (Optionally) The user chooses another number of hits to be displayed per page (following numbers are available: 10, 25, 50, 75, 100).
    4.1 The system displays the album list containing the selected number of hits per page.
  5. (Optionally) The user goes to a special page, to the last page or to the first page.
    5.1 The system displays the selected page.
  6. Extension point: search within album list
    6.1 If the user wants to search within the album list, include UC_FAC_SR_03 Search within list.
  7. Extension point: copy album content
    7.1 If the album is in the state pending (the user is the owner of the album or an active shared user of the album) or in the state released and the user wants to copy the content of the album, include UC_FAC_AM_12 Copy album content.
  8. The use case ends successfully.

Actors Involved

  • User

UC_FAC_BD_07 Resolve album by URL[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R2

Motivation

  • A not logged in user follows a (published) link to a released album.

Steps

  1. The user requests an album by providing the URL assigned by the system for persistently citing the album.
  2. The system displays the metadata of the album (see Application Profile Album) and following further information depending on the state of the album:
    released: The affiliation of the album owner, the PID of the album and its publishing date.
    withdrawn: The affiliation of the album owner, the crossed out PID of the album, its publishing and withdrawn dates and the withdrawl comment.

Actors Involved

  • User

UC_FAC_BD_08 View file metadata[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3

Motivation

Pre-Condition

  • One picture is selected.

Triggers

Steps

  1. The user chooses to view file metadata about the selected picture.
  2. The system displays the available resolutions (thumbnail, web resolution, original resolution) of the selected picture.
  3. The user chooses one resolution for which he wants to see the file metadata.
  4. The system displays the file metadata (in XML) of the selected resolution. The use case ends successfully.

Actors Involved

  • User

Administration[edit]

UC_FAC_BD_09 View administrator workspace[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3

Motivation

  • A user wants to have an overview about all tasks he can perform with his special rights as administrator.

Steps

  1. The user chooses to view the administrator workspace.
  2. The system displays the administrator workspace, where all tasks that can be performed by an administrator are listed.
  3. Extension point: view statistics
    3.1 If the user wants to view the Faces statistics, include UC_FAC_BD_10 View Statistics.
  4. R4: Extension point: view account users
    4.1 If the user wants to get an overview about all account users of Faces, include UC_FAC_UM_03 View account users list.
  5. R4: Extension point: create account user
    5.1 If the user wants to create an account user, include UC_FAC_UM_04 Create account user.
  6. The use case ends successfully.

Actors Involved

  • Administrator

UC_FAC_BD_10 View statistics[edit]

Status/Schedule

  • Status: implemented
  • Schedule: R3

Motivation

  • The user chooses view the usage statistics (see Faces Statistics) for the Faces solution.

Triggers

  • This use case is included by the use cases

Steps

  1. The user chooses to view the usage statistics for Faces.
  2. The system displays the statistical data of the last 12 months (including the current month) which have been collected per month. The use case ends successfully.

Actors Involved

  • Administrator

Digilib[edit]

UC_FAC_BD_11 Navigate within one picture[edit]

Status/Schedule

  • Status: in design
  • Schedule: R3.5

Motivation

  • The user wants to analyze one picture. Therfore, the Digilib tool will be used.

Pre-Condition

  • One picture is selected (in the detailed view).

Steps

  1. (Optionally) The user zooms in and out within the picture.
  2. (Optionally) The user navigates left, right, up and down within the zoomed picture.
  3. (Optionally) The user switches back to see the whole picture.
  4. The use case ends successfully.

Actors Involved

  • User

Note Pad[edit]

UC_FAC_BD_12 View note pad[edit]

Status/Schedule

  • Status: in design
  • Schedule: R3.5

Motivation

  • The user wants to view a note pad.

Pre-Condition

  • One note pad is selected.
  • Further pre-conditions are based on the state of the album:
    pending:
    • For private note pads: the user is the owner of the note pad.
    • For shared note pads: the user shares the notepad or is the owner of the note pad.
    released: None.
    withdrawn: None.

Triggers

  • This use case can be included by following use cases

Steps

  1. The user chooses to view the selected note pad.
  2. The system displays the note pad and its metadata (see Note Pad Metadata Set).
    For shared note pads, additionally following properties will be displayed
    1. For the owner of the note pad:
      • List of shared users (e-mail address, user name) and list of invited users (e-mail address)
    2. For the shared users of the note pad:
      • List of shared users (e-mail address, user name) and number of invited users
  3. Extension point: edit private note pad
    3.1 If the note pad is a private one in the state pending, the user is the owner of the note pad and wants to edit it, include UC_FAC_NP_02 Edit private note pad.
  4. Extension point: comment shared note pad
    4.1 If the note pad is a shared one in the state pending, the user is the owner or a shared user of the note pad and wants to add a comment on the note pad, include UC_FAC_NP_03 Comment shared note pad.
  5. Extension point: delete private note pad
    5.1 If the note pad is a private one in the state pending, the user is the owner of the note pad and wants to delete it, include UC_FAC_NP_04 Delete private note pad.
  6. Extension point: release note pad
    6.1 If the note pad is in the state pending, the user is the owner of the note pad and wants to release it, include UC_FAC_NP_05 Release note pad.
  7. Extension point: withdraw note pad
    7.1 If the note pad is in the state released, the user is the owner of the note pad and wants to withdraw it, include UC_FAC_NP_06 Withdraw note pad.
  8. Extension point: view album details
    8.1 If the user wants to view the album the note pad corresponds to, include UC_FAC_BD_04 View album details.
  9. The use case ends successfully.

Actors Involved

  • Account user

UC_FAC_BD_13 View my note pads[edit]

Status/Schedule

  • Status: in design
  • Schedule: R3.5

Motivation

  • It could happen that note pads without a corresponding album exist in FACES, because the album was deleted, but not the note pad. Therefore the user needs a possibility to view these note pads.

Pre-Condition

  • One account user is selected.

Steps

  1. The user chooses to overview his note pads.
  2. The system displays a list of all note pads the user is the owner of.
    • In this list, following information is displayed about each note pad:
      name, state, corresponding album (if still exists), date created, date last modified, information if the note pad is shared or not
  3. (Optionally) The user changes the sorting order (each entry can be used as sorting criteria).
    3.1 The system displays the note pad list in the selected sorting order.
  4. (Optionally) The user chooses another number of hits per page (following numbers are available: 10, 25, 50, 75, 100).
    4.1 The system displays the note pad list with the selected number of hits per page.
  5. (Optionally) The user goes to a special page, to the last page or to the first page.
    5.1 The system displays the selected page.
  6. Extension point: view note pad
    6.1 If the user wants to view the note pad, include UC_FAC_BD_12 View note pad.
  7. Extension point: view album details
    7.1 If the user wants to view the album the note pad corresponds to, include UC_FAC_BD_04 View album details.
  8. The use case ends successfully.

Actors Involved

  • Account user

Further development[edit]

Further list view of an album

Two possible ideas:
  1. Business Card View
    • Only three (instead of six) pictures are displayed in one row
    • Next to each picture, the six main attributes are displayed (when there isn't enough space, without the label)
  2. MD View
    • The pictures will be displayed in a much smaller thumbnail
    • The focus will lay on the display of metadata
--> Has to be checked with the institute. Could be part of R3.5.

Use Case

Identifier

Publication Management

Global Release Identifier

Persistent Identifer or Identification

Uniform Resource Locator

Extensible Markup Language

Web Based Server Technology for Viewing and Working with Images

Metadata

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