Skip to content

Commit

Permalink
Revised the help text in the Advanced Options popup of the dataverse …
Browse files Browse the repository at this point in the history
…widgets. Added documentation to the Dataverse Management and Dataset Management pages of the User Guide. [ref #3143 #3147]
  • Loading branch information
mheppler committed May 31, 2016
1 parent 2935cde commit 4d5a20e
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 11 deletions.
13 changes: 12 additions & 1 deletion doc/sphinx-guides/source/user/dataset-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ If you restrict any files in your dataset, you will be prompted by a pop-up to e
Guestbook
--------------

This is where you will enable a particular Guestbook for your dataset, which is setup at the Dataverse-level. For specific instructions please visit the Dataverse Management Guide > `Dataset Guestbook section <../user/dataverse-management.html#dataset-guestbooks>`_.
This is where you will enable a particular Guestbook for your dataset, which is setup at the Dataverse-level. For specific instructions please visit the `Dataset Guestbooks <../user/dataverse-management.html#dataset-guestbooks>`_ section of the Dataverse Management page.

.. _permissions:

Expand All @@ -220,6 +220,17 @@ The file permissions page has two sections: Users/Groups and Files.

To give someone access to your restricted files, click on the Grant Access to Users/Groups button in the Users/Groups section.

.. _widgets:

Widgets
=============================

The Widgets feature provides you with code for you to put on your personal website to have content related to your dataset displayed there. There are two types of Widgets for a dataset, a Dataset widget and a Dataset Citation widget. From the Widgets page, you can copy and paste the code snippets for the widget you would like to add to your website.

The Dataset widget will provide the citation, metadata, files and terms of your dataset. When someone downloads a data file in the widget, it will download directly from the datasets within the widget. If a file is restricted, they will be directed to your dataverse to log in, instead of logging in through the widget on your site.

The Dataset Citation widget will provide a citation for your dataset to your personal or project website. Users can download the citation in various formats via the Cite Data button. The persistent URL in the citation will direct users to the dataset in your dataverse. You can also forward dataset citation persistent URL's to your personal website. For more information on the widgets available for a dataverse, please visit the `Widgets <../user/dataverse-management.html#widgets>`_ section of the Dataverse Management page.

Publish Dataset
====================

Expand Down
22 changes: 14 additions & 8 deletions doc/sphinx-guides/source/user/dataverse-management.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Dataverse Management
++++++++++++++++++++++++++++

A dataverse is a container for datasets (research data, code, documentation, and metadata) and other dataverses,
which can be setup for individual researchers, departments, journals and organizations.
A dataverse is a container for datasets (research data, code, documentation, and metadata) and other dataverses, which can be setup for individual researchers, departments, journals and organizations.

|image1|

Expand Down Expand Up @@ -58,19 +57,26 @@ Tip: The metadata fields you select as required, will appear on the Create Datas
Theme + Widgets
====================================================

The Theme + Widgets feature provides you with a way to customize the look of your dataverse as well as provide code for you to put on your personal website to have your dataverse appear there. (For adding your dataverse to an OpenScholar site, follow these instructions.)
Theme
-----------------------
The Theme feature provides you with a way to customize the look of your dataverse. You can decide either to use the customization from the dataverse above yours or upload your own image file. Supported image types are JPEG, TIFF, or PNG and should be no larger than 500 KB. The maximum display size for an image file in a dataverse's theme is 940 pixels wide by 120 pixels high. Additionally, you can select the colors for the header of your dataverse and the text that appears in your dataverse. You can also add a link to your personal website, the website for your organization or institution, your department, journal, etc.

Widgets
-----------------------
The Widgets feature provides you with code for you to put on your personal website to have your dataverse displayed there. There are two types of Widgets for a dataverse, a Dataverse Search Box widget and a Dataverse Listing widget. From the Widgets tab on the Theme + Widgets page, you can copy and paste the code snippets for the widget you would like to add to your website.

For Theme, you can decide either to use the customization from the dataverse above yours or upload your own image file. Supported image types are JPEG, TIFF, or PNG and should be no larger than 500 KB. The maximum display size for an image file in a dataverse's theme is 940 pixels wide by 120 pixels high. Additionally, you can select the colors for the header of your dataverse and the text that appears in your dataverse. You can also add a link to your personal website, the website for your organization or institution, your department, journal, etc.
The Dataverse Search Box widget will add a search box to your website that is linked to your dataverse. Users are directed to your dataverse in a new browser window, to display the results for search terms entered in the input field.

There are two options for Widgets, a Dataverse Search box widget and a Dataverse Listing widget. The Dataverse Search Box will add a search box to your website that when someone enters a search term in and clicks Find, will bring them to Dataverse to see the results. The Dataverse Listing widget will provide a listing of all your dataverses and datasets. When someone clicks on a dataverse or dataset in the widget, it will bring them to your dataverse to see the actual data. Within the Widgets page, you can copy and paste the code for the widget you would like to have on your website.
The Dataverse Listing widget will provide a listing of all your dataverses and datasets for users to browse, sort, filter and search. When someone clicks on a dataverse or dataset in the widget, it will display the content in the widget on your site. They can download data files directly from the datasets within the widget. If a file is restricted, they will be directed to your dataverse to log in, instead of logging in through the widget on your site.

With the Advanced Options configurations, you may forward dataset citation persistent URL's to your personal website. The page you submit as your Personal Website URL must contain the code snippet for the Dataverse Listing widget. Upon setting up this option, the persistent URL in the citation will direct users to the dataset displayed in the Dataverse Listing widget, on your personal website.

Adding Widgets to an OpenScholar Website
==============================================
----------------------------------------------
#. Log in to your OpenScholar website
#. Either build a new page or navigate to the page you would like to use to show the Dataverse widgets.
#. Click on the Settings Cog and select Layout
#. At the top right, select Add New Widget and under Misc. you will see the Dataverse Search Box and the Dataverse Listing widgets. Click on the widget you would like to add (we recommend using both), fill out the form, and then drag it to where you would like it to display in the page.

#. At the top right, select Add New Widget and under Misc. you will see the Dataverse Search Box and the Dataverse Listing widgets. Click on the widget you would like to add (we recommend using both), fill out the form, and then drag it to where you would like it to display in the page.

.. _dataverse-permissions:

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/Bundle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ dataverse.widgets.searchBox.tip=Add a way for visitors on your website to be abl
dataverse.widgets.dataverseListing.txt=Dataverse Listing
dataverse.widgets.dataverseListing.tip=Add a way for visitors on your website to be able to view your dataverses and datasets, sort, or page through them.
dataverse.widgets.advanced.popup.header=Widget Advanced Options
dataverse.widgets.advanced.prompt=Forward persistent URL's in your dataset citation to your personal website.
dataverse.widgets.advanced.prompt=Forward dataset citation persistent URL's to your personal website. The page you submit as your Personal Website URL must contain the code snippet for the Dataverse Listing widget.
dataverse.widgets.advanced.url.label=Personal Website URL
dataverse.widgets.advanced.url.watermark=http://www.example.com/page-name
dataverse.widgets.advanced.invalid.message=Please enter a valid URL
Expand Down
2 changes: 1 addition & 1 deletion src/main/webapp/themeAndWidgetsFragment.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@
</p:tab>
</p:tabView>
<p:remoteCommand name="saveRedirectUrl" process="@this" update=":#{p:component('messagePanel')}, :themeWidgetsForm, @([id$=Messages]), advancedOptions" actionListener="#{themeWidgetFragment.save()}"/>
<p:dialog modal="true" id="advancedOptions" widgetVar="advancedOptions" header="#{bundle['dataverse.widgets.advanced.popup.header']}">
<p:dialog styleClass="smallPopUp" id="advancedOptions" widgetVar="advancedOptions" modal="true" header="#{bundle['dataverse.widgets.advanced.popup.header']}">
<div class="form-horizontal">
<div>
<p class="help-block"><span class="glyphicon glyphicon-info-sign"/> #{bundle['dataverse.widgets.advanced.prompt']}</p>
Expand Down

0 comments on commit 4d5a20e

Please sign in to comment.