Difference between revisions of "PubMan Func Spec Display"

From MPDLMediaWiki
Jump to navigation Jump to search
 
(11 intermediate revisions by 5 users not shown)
Line 124: Line 124:


Comment: In the workspace the medium display also gives the item status.
Comment: In the workspace the medium display also gives the item status.
=== Tabled view ===
* specification see: [https://subversion.mpdl.mpg.de/repos/smc/trunk/04_Design/03_GUI_Design/02_interface_conception_and_design/02_01_Prototyping/HTML_Prototyp/R4.1_Prototype/index.html prototype for R4.1] "table view"


== Item version displays ==
== Item version displays ==
Line 287: Line 290:
== Display "View release history" ==
== Display "View release history" ==


'''Status:''' in design
'''Status:''' implemented


'''Schedule:''' R3
'''Schedule:''' R3
Line 294: Line 297:


===Future development===
===Future development===
'''Status:''' in specification
'''Schedule:''' ?


Extension: The same item data as in short display for lists are displayed. the user has the option to access each released version. Each released version is displayed as [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|(UC_PM_BD_04 view item version)]] without extension points. The user has the option to go back to the view release history view and to the item, from which s/he triggered "view release history".
Extension: The same item data as in short display for lists are displayed. the user has the option to access each released version. Each released version is displayed as [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|(UC_PM_BD_04 view item version)]] without extension points. The user has the option to go back to the view release history view and to the item, from which s/he triggered "view release history".
Line 299: Line 306:
== Display "View revisions" ==
== Display "View revisions" ==


'''Status:''' in design
'''Status:''' implemented


'''Schedule:''' R3
'''Schedule:''' R3
Line 305: Line 312:
The system displays a list of all former and a list of all later revisions of the item. Former revisions are items which have a relation of type “HasRevision” pointing to the selected item or items to which the selected item has a relation of type "IsRevisionOf". Later revisions are items which have a relation of type “IsRevisionOf” pointing to the selected item or items to which the selected item has a relation of type “HasRevision”. If a relation description exists, the system displays it. The lists are sorted descending by the date of release of the last released version. The item with the most recent date of release is listed first. The use case ends successfully.
The system displays a list of all former and a list of all later revisions of the item. Former revisions are items which have a relation of type “HasRevision” pointing to the selected item or items to which the selected item has a relation of type "IsRevisionOf". Later revisions are items which have a relation of type “IsRevisionOf” pointing to the selected item or items to which the selected item has a relation of type “HasRevision”. If a relation description exists, the system displays it. The lists are sorted descending by the date of release of the last released version. The item with the most recent date of release is listed first. The use case ends successfully.


Extension: The same item data as in short display for lists are displayed. The user has the option to access each released revision. Each released revision is displayed as [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|(UC_PM_BD_04 view item version)]] without extension points. The user has the option to go back to the revision list and to the item, from which s/he triggered "view revisions".
 
'''Extension''': The same item data as in short display for lists are displayed. The user has the option to access each released revision. Each released revision is displayed as [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|(UC_PM_BD_04 view item version)]] without extension points. The user has the option to go back to the revision list and to the item, from which s/he triggered "view revisions".
 
'''Status:''' implemented
 
'''Schedule:''' R4


==Display "View item event log"==
==Display "View item event log"==


'''Status:''' in design
'''Status:''' implemented


'''Schedule:''' R3
'''Schedule:''' R3
Line 316: Line 328:


===Future Development===
===Future Development===
'''Status:''' in specification
'''Schedule:''' ?


Extension: The same item data as in short display for lists are displayed. The user has the option to access each version. Each version is displayed as [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|(UC_PM_BD_04 view item version)]] without extension points. The user has the option to go back to the event log list and to the item, from which s/he triggered "view item event log".
Extension: The same item data as in short display for lists are displayed. The user has the option to access each version. Each version is displayed as [[PubMan_Func_Spec_Browsing_and_displays#UC_PM_BD_04_view_item_version|(UC_PM_BD_04 view item version)]] without extension points. The user has the option to go back to the event log list and to the item, from which s/he triggered "view item event log".
Line 393: Line 409:
*[http://www.niso.org/standards/standard_detail.cfm?std_id=783 http://www.niso.org/standards/standard_detail.cfm?std_id=783 ]- OpenURL standard
*[http://www.niso.org/standards/standard_detail.cfm?std_id=783 http://www.niso.org/standards/standard_detail.cfm?std_id=783 ]- OpenURL standard


[[Category:PubMan|Display]]
[[Category:PubMan_Functional_Specification|Display]]
[[Category:functional specification]]

Latest revision as of 12:11, 25 April 2012

The PubMan application will support different display types of items for lists, which can be selected by the user or defined in user preferences (item list displays).

For the display of a specific item, one view is defined (item version display).

General information on item/item list display[edit]

  • List view: Labels are always displayed, even if there is no entry. In case the metadata value is not provided, the information "no entry" is displayed.
  • Item display: Labels are always displayed, even if there is no entry. In the case the metadata value is not provided, the information "no entry" is displayed. If a complete group of Metadata (e.g. source) contains no values, no labels are displayed, just the information "no entry" for the whole group is displayed.
  • The order and grouping of elements is specified in GUI design.
  • The Labeling of the different display types for lists is specified in GUI design.


Default system settings[edit]

The default system setting for display of lists is short display.

Item list displays[edit]

Short[edit]

Status: implemented

Schedule: R3

Elements[edit]

Publication.Title

Publication.Creator

  • If creator is of type person, display: <Publication.Creator.Person.FamilyName>, <Publication.Creator.Person.GivenName>
  • If creator is of type organization, display: <Publication.Creator.Organization.Name>
  • Creators are shown in one row and separated by semicolon. They are displayed in the same order as they have been entered.

Publication.Date

  • Only one date value is displayed
  • If more than one <date> is available, the display of the dates follows the priority:
<Publication.Date.DateType = published in print>
<Publication.Date.DateType = published online>
<Publication.Date.DateType = accepted>
<Publication.Date.DateType = submitted>
<Publication.Date.DateType = modified>
<Publication.Date.DateType = created>

Publication.Genre

Number of the Files

  • If a file exists, display a fulltext symbol and show the number of attached files
  • In addition a reference to an external location, the information, that a reference to a file exists, is provided.

Comment: In the workspace the short display also gives the item status.

Medium[edit]

Status: implemented

Schedule: R3

Elements[edit]

Publication.Title

Publication.Creator and Publication.Creator.Person.Organization

  • Publication.Creator
    • Please start a new line after each creator. The display of creators might be limited for the default view, but it should be possible to view all creators also.
    • please display them in the order, they have been entered into the system
    • If creator is of type person, display <Publication.Creator.Person.FamilyName>[, ] <Publication.Creator.Person.GivenName>.
    • If creator of type organization, display <Publication.Creator.Organization.Name>
    • If creator is of type person and if the person has an affiliated organization (Publication.Creator.Person.Organization), then display a small number behind the Given Name. This numbers are numerated and beginning with 1.
    • Express the creator role of the creator.
  • Publication.Creator.Person.Organization
    • Display each information in a separate row:
<Organization.Name>
<Organization.Address>


Publication.Date

  • all dates are displayed
  • Order of dates:
<Publication.Date.DateType=created>
<Publication.Date.DateType=modified>
<Publication.Date.DateType=submitted>
<Publication.Date.DateType=accepted>
<Publication.Date.DateType=published online>
<Publication.Date.DateType=published in print>

Publication.Genre

Publishing.Info

Publishing Info: <place> : <publisher>, <edition>

Publication.Event.Title

Publication.Source (only the first source information is displayed and an information is given, that there are more sources available, which can be looked at via the view item version)

  • Publication.Source.Genre
  • Publication.Source.Title
  • Publication.Source.Volume/Publication.Source.Issue
  • Publication.Source.StartPage/Publication.Source.EndPage
  • Publication.Source.SequenceNumber
  • Publication.Source.PublishingInfo

Number of the Files

  • If a file exists, display a fulltext symbol and show the number of attached files
  • In addition a reference to an external location, the information, that a reference to a file exists, is provided.
  • If list is result of a search, display the text fragments with the highlighted search term. The text fragment contains the search term and 10 words before and after the highlighted hit.

Comment: In the workspace the medium display also gives the item status.

Tabled view[edit]

Item version displays[edit]

Item version - all status except withdrawn[edit]

Status: implemented

Schedule: R3

Item Details[edit]

The single item version view contains following elements and properties:

Publication.Title

Publication.AlternativeTitle


Publication.Creator

  • Please start a new line after each creator. The display of creators might be limeted for the default view, but it should be possible to view all creators also.
  • please display them in the order, they have been entered into the system
  • If creator is of type person, display <Publication.Creator.Person.FamilyName>[, ] <Publication.Creator.Person.GivenName>.
  • If creator of type organization, display <Publication.Creator.Organization.Name>
  • If creator is of type person and if the person has an organization (Publication.Creator.Person.Organization), then display a small number behind the Given Name. This numbers are numerated and beginning with 1.
  • Express the creator role of the creator.

Publication.Creator.Person.Organization

  • Display each information in a seperate row:
<Organization.Name>
<Organization.Adress>


Publication.Date

  • All dates are displayed, each with date type and in format YYYY-MM-DD
  • order of dates:
<Publication.Date.DateType = created>
<Publication.Date.DateType = modified>
<Publication.Date.DateType = submitted>
<Publication.Date.DateType = accepted>
<Publication.Date.DateType = published online>
<Publication.Date.DateType = published in print>


Publication.Genre


Publication.Language

Publication.ReviewMethod

Publication.Degree


Publication.PublishingInfo

  • Display: <place> : <publisher>, <edition>


Publication.TotalNumberOfPages

Publication.Event

  • Publication.Event.Title
  • Publication.Event.AlternativeTitle
    • limit the diplay to the first 50 characters
  • Publication.Event.Place
  • Publication.Event.StartDate - Publication.Event.EndDate
    • Date Format: YYYY-MM-DD - YYYY-MM-DD
  • Publication.Event.InvitationStatus
    • Display: Invited contribution (only if status is invited, then display this field)

Publication.Source

  • Publication.Source.Genre
  • Publication.Source.Title
  • Publication.Source.AlternativeTitle
    • limit the diplay to the first 50 characters
  • Publication.Source.Creator
    • Display:
Source Creator: [creators as discribed under 3. Publication.Creator]
  • Publication.Source.Volume/Publication.Source.Issue
  • Publication.Source.StartPage/Publication.Source.EndPage
  • Publication.Source.SequenceNumber
  • Publication.Source.PublishingInfo
    • <place> : <publisher>, <edition>
  • Publication.Source.Identifier

Publication.Subject

Publication.Abstract

Publication.TableOfContents

Publication.Identifier

  • If more than one identifier is available, the display follows the priority: <persistent ID>, <system ID>.

Publication.Location

File information

  • For each file, display the file information: <name of file>, <content category>, <size of file>, <MIME Type>, <file description>, <file visibility> and the same full text symbol as in short item view for lists.

In addition to the MD, please display up to two text fragments per full text file (in which was searched) with 10 words before and after the highlighted hit.

  • For an external locator, display following information:
external locator
<content category>
<visibility>
<name>
<comment>

System details[edit]

   * version ID <escdidoc:2345:8>
   * last modified
   * item state
   * collection: <publications>, affiliated to: MPI for Physics 

Item version - status withdrawn[edit]

Status: implemented

Schedule: R3

Item details[edit]

Withdrawal details[edit]

  • an icon for being withdrawn (e.g. thumbstone) and the information "This item has been withdrawn"
  • The withdrawal comment, the withdrawal date

System details[edit]

  • version ID <escdidoc:2345:8>
  • last modified
  • item state
  • collection: <publications>, affiliated to: MPI for Physics
  • Please note: for released versions: if there is a newer released version, please give the info, that there is a newer released version and a link to it
  • Please note, that for withdrawn items, no further actions (i.e. extensions points) are possible (See Use case View item version, Alternative)

Future developement[edit]

Include in view item version, for Publication.Source, the display of Source in Source.


Display "View release history"[edit]

Status: implemented

Schedule: R3

Current description: "The system displays a list of all released versions of the item. For each entry, the version number, the date of release and the release comment is displayed. The list is sorted descending by the date of release. The item with the most recent date of release is listed first."

Future development[edit]

Status: in specification

Schedule: ?

Extension: The same item data as in short display for lists are displayed. the user has the option to access each released version. Each released version is displayed as (UC_PM_BD_04 view item version) without extension points. The user has the option to go back to the view release history view and to the item, from which s/he triggered "view release history".

Display "View revisions"[edit]

Status: implemented

Schedule: R3

The system displays a list of all former and a list of all later revisions of the item. Former revisions are items which have a relation of type “HasRevision” pointing to the selected item or items to which the selected item has a relation of type "IsRevisionOf". Later revisions are items which have a relation of type “IsRevisionOf” pointing to the selected item or items to which the selected item has a relation of type “HasRevision”. If a relation description exists, the system displays it. The lists are sorted descending by the date of release of the last released version. The item with the most recent date of release is listed first. The use case ends successfully.


Extension: The same item data as in short display for lists are displayed. The user has the option to access each released revision. Each released revision is displayed as (UC_PM_BD_04 view item version) without extension points. The user has the option to go back to the revision list and to the item, from which s/he triggered "view revisions".

Status: implemented

Schedule: R4

Display "View item event log"[edit]

Status: implemented

Schedule: R3

Current description: "The system displays all item versions and their corresponding log entries see Logging. The list is sorted descending by the date of event. The most recent event is listed first".

Future Development[edit]

Status: in specification

Schedule: ?

Extension: The same item data as in short display for lists are displayed. The user has the option to access each version. Each version is displayed as (UC_PM_BD_04 view item version) without extension points. The user has the option to go back to the event log list and to the item, from which s/he triggered "view item event log".

COinS[edit]

Status: implemented partly (rft_val_fmt|| info:ofi/fmt:kev:mtx:journal is hardcoded)

Schedule: R2


In all display types, a COinS has to be provided for each item. A COinS is the representation of bibliographic information for this item in an HTML span element by re-using the key-value elements defined in the OpenURL standard,e.g.

 <span class="Z3988" 
   title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&rfr_id=info%3Asid%2Fwww.escidoc.de%3
   Apubman&&rft.genre=article&rft.atitle=Coccidiosis+of+mammary+tissue+in+the+water+shrew%2C+Sorex+palustris+navigato
   r.&rft.title=Journal+of+Parasitology&rft.issn=0022-3395&rft.date=2007&rft.volume=12&rft.issue=3&rf
   t.spage=123&rft.epage=125&rft.aulast=Bowman&rft.aufirst=Ben&rft.au=Ben+Bowman&rft_id=info:doi/10.1046%
   2F19991u38%C3%9F2">
</span> 


Following values and mapping should be used to create COinS for publication items. The complete COinS needs to be URL encoded:


key value remark
ctx_ver Z39.88-2004
rft_val_fmt info:ofi/fmt:kev:mtx:journal
rfr_id info:sid/escidoc.mpg.de:pubman name space
rft.genre <Publication.Genre>
rft.atitle <Publication.Title>
rft.title <Publication.Source.Title>
rft.aulast <Publication.Creator.Person.Lastname> of first author only
rft.aufirst <Publication.Creator.Person.Firstname> of first author only
rft.au <Publication.Creator.Person.Completename> for all users, concatenated by semicolon
rft.issn <Publication.Source.Identifier> or <Publication.Identifier> of type issn
rft.isbn <Publication.Source.Identifier> or <Publication.Identifier> of type isbn
rft_id info:doi/<Publication.Source.Identifier> of type doi
rft.volume <Publication.Source.Volume>
rft.issue <Publication.Source.Issue>
rft.pages <Publication.Source.Pages>
rft.date <Publication.Date> if more than one publication dates is available only one should be included in following order

<Publication.Date.DateType = published in print> <Publication.Date.DateType = published online> <Publication.Date.DateType = accepted> <Publication.Date.DateType = submitted> <Publication.Date.DateType = modified> <Publication.Date.DateType = created>


More information: