Widgets: Dataset Pg Widget

[eaquigley]

Currently only two widgets exist:

1. Dataverse + Dataset listing
2. Search box

Need to determine additional widgets (such as dataset page and file page ones) as well as improve the current widgets to be more responsive and have more features (e.g.-facets).

[eaquigley]

Related to #2498, #1011, #2090, #2469

[posixeleni]

See also #1203 which is a deliverable we need to complete for a grant funded project

[mheppler]

As the comments above show, a lot of improvements and new widget features already have development issues created. There isn't an issue for the dataset page yet, so I am narrowing the scope of this ticket to just that feature by changing the title.

[mheppler]

Reviewed this issue with @scolapasta and discussed possible dynamic solutions that would allow the dataset pg to be displayed in the widgets using a UI template specific to the widgets and not the full-featured layout of the dataverse_template.xhtml. This solution needs to be scalable so that not only the dataset pg, but also the dataverse, file and any other future pages can also use this new widget template.

Some things the new widget template needs to do:

• Functions as dataverse_template.xhtml does, serving as the layout container to multiple pages
• Delivers: CSS, JS, analytics (?), branding, breadcrumbs, message, etc.
• Page references to a template would point to dynamic logic in the bean #{dataverseSession.layoutTemplate} which determines the template to use based on the layout needed

[mheppler]

Requirements outline as copied from FRD. Checked into 2469-widgets branch.

Dataset Page

• Add “Widgets” option to “Edit” button
• New citation block layout to make it stand out a little more
  • Create new include for the citation block
  • Full citation, with persistentUrl link, opens in new window
  • Cite Data button (changed from “Download Citation”)
  • BibTex no longer downloads, but displays in browser
• Metadata HTML links in compound field values open in new window

Dataset Widgets Admin Page

• Widget code available for published data only
  • No widget code generated before published (“Why widgets…” messaging)
• Help text with link to User Guides
• Code available for Dataset “Full” and Dataset Citation widgets
• “Done” button returns to dataset pg
• Apply bug fix for User Access/Permissions Permissions - Pages w/o Log In Accessible Via URL #2841

Dataset “Full” Widget #2499

• Published data only
  • No widget code generated before published (“Why widgets…” messaging)
• Dataverse branding w/ “Data is stored at…” msg, link to installation Widgets: Add Branding to Data Listing Widget #2469
• Displays a slimmer/leaner layout intended for the widget, not full Dataverse layout intended for desktop browsers
  • YES: breadcrumbs, msg block, contact author button, title, citation, files, metadata, terms tabs
  • NO: header, footer, metrics block, link/share buttons, edit button, metadata summary block, versions tab
• “Log in” link in footer to access admin features on full Dataverse installation
• Breadcrumbs Widgets: Add Link to Individual's Dataverse Page #2090
  • Links to parent dataverse and anything higher in the hierarchy opens in a new window
• Navigation (general, see use cases for more specific…)
  • Click persistentId URL in citation, page opens in new window (this is for both the widget and full version of dataverse)
  • Click “Cite Data” button…
    • EndNote XML and RIS downloads within widget
    • BibTex new page opens in new window (this is for both the widget and full version of dataverse)
  • Click “Find” button for search, opens within widget
  • Click “Request Access” button...
    • Sign Up or Log In links, new page opens in new window
  • Click “Download” button…
  • File downloads within widget
  • Download File popup (Guestbook) opens within widget
  • Click user entered HTML link in metadata value, new page opens in new window (this is for both the widget and full version of dataverse)
  • Click “Preview Guestbook” button, popup opens within widget

Dataset Citation Widget

• New citation block layout to make it stand out a little more
  • Create new include for the citation block
• Full citation, with persistentUrl link, opens in new window
• Cite Data button (changed from “Download Citation”)
  • BibTex no longer downloads, but displays in browser
• Data Citation Standards msg + link, shortened to “Learn about…”
• Dataverse branding w/ “Data is stored at…” msg, link to installation Widgets: Add Branding to Data Listing Widget #2469
• Keep iframe pg wrapper from loading into a window, outside of the widget’s iframe

Dataset “persistentUrl” Forwarding

• Dataverse Theme + Widgets Admin Page
  • Opt-in via Advanced Options at the dataverse level only
  • Validation for Personal Website URL format
  • Success msg
• Update URL’s in DataCite
• Citation servlet
• iFrame Landing Page
  • Banner/bar with “If the site below does not load...” msg
  • Link to Dataverse installation, close msg “X” icon forwards to external site
  • Automatic delayed forward to external site (example), with counter (example)
  • DOI passed as query parameter in URL to widget

[kcondon]

OK, works as described, closing.