Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5615 "add data" button on navbar #6338

Merged
merged 40 commits into from
Nov 12, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
8749cb2
Added Add Data dropdown to navbar, plus code cleanup for dataverse he…
mheppler Oct 7, 2019
2e49ff0
Added rel=noopener
mheppler Oct 7, 2019
912427e
Additional responsive layout fixes for edit dataverse form [ref 5616]
mheppler Oct 7, 2019
a673e3e
Merge branch 'develop' into 5615-add-data-navbar
mheppler Oct 8, 2019
58d4ee3
Returned Host Dataverse component to create dataverse and dataset for…
mheppler Oct 8, 2019
52ed565
Fixed label and input references in dataverse and contact forms [ref …
mheppler Oct 15, 2019
9973038
Merge branch 'develop' into 5615-add-data-navbar
mheppler Oct 15, 2019
e6d4109
Cleaned up code and added accessibility improvements to edit dataset …
mheppler Oct 17, 2019
695a5c1
Fixed render logic used for required attributes on edit dataset form …
mheppler Oct 17, 2019
8bb1adb
Added required attribute to edit dataverse form [ref #5615]
mheppler Oct 17, 2019
4c48cb6
Added Add Data btn to My Data pg, moved Edit Account btn to Account t…
mheppler Oct 18, 2019
7054e31
Cleaned up layout of asterisk required msg on edit dataset pg, added …
mheppler Oct 21, 2019
c2944ae
Improved responsive layout of navbar, styling of language dropdown, a…
mheppler Oct 22, 2019
fe17457
More responsive layout improvements, plus deaccession reason layout f…
mheppler Oct 22, 2019
99817ee
Merge branch 'develop' into 5615-add-data-navbar
mheppler Oct 22, 2019
c41b8bb
Fixed padding issue with Metrics block on dataverse pg [ref #5615]
mheppler Oct 22, 2019
305caf0
Fixed broken render logic on edit dataset pg from recent responsivene…
mheppler Oct 23, 2019
e08a3c6
Added name to dataverse label on create/edit dataverse form, added do…
mheppler Oct 23, 2019
745ceed
Merge branch 'develop' into 5615-add-data-navbar
landreev Oct 28, 2019
c71be81
added code for dataverse/dataset page updates when a new host (owner)…
landreev Oct 29, 2019
bec5ddf
fixed the breadcrumb display (#5615)
landreev Oct 30, 2019
51a886f
fixed the breadcrumb display (#5615)
landreev Oct 30, 2019
39b3789
faster/less memory hoggish dataverse menu list via a native query (#5…
landreev Nov 1, 2019
dfa4b4d
Moved host dataverse select component on dataverse form, added bundle…
mheppler Nov 1, 2019
5b75af9
Merge branch 'develop' into 5615-add-data-navbar
landreev Nov 1, 2019
864efa1
experimental framework for pre-selecting the dataverses where the use…
landreev Nov 5, 2019
03e8f5f
switched to using the type-to-select method for choosing the host dat…
landreev Nov 6, 2019
d452c46
same, for the dataverse page as well (#5615)
landreev Nov 6, 2019
640fca1
removed some verbose debugging messages. (#5615)
landreev Nov 6, 2019
12c8971
a small pattern matching refinement (#5615)
landreev Nov 7, 2019
794b525
Cleaned up markup and CSS for autoComplete component on edit datavers…
mheppler Nov 7, 2019
059125e
put the static host dataverse display back on the dataverse page, in …
landreev Nov 7, 2019
9e962e9
added "no matches" message to the autocomplete on the dataverse page.…
landreev Nov 7, 2019
36bf30d
added "no matches" message to the autocomplete on the dataset page. (…
landreev Nov 7, 2019
09f5a71
Moved list item for Host Dataverse...
mheppler Nov 7, 2019
561d299
simplified the selection logic when performed by a superuser (#5615)
landreev Nov 7, 2019
e6c989e
reorganized the search query code/added some final optimization fine-…
landreev Nov 8, 2019
6360f4e
Changed id on hidden input to avoid duplicate id errors on create dv …
mheppler Nov 8, 2019
84e0857
fixes the "duplicate id" issue with the autocomplete component, and w…
landreev Nov 12, 2019
81020ab
removed the binding attribute from the host dataverse autoComplete. (…
landreev Nov 12, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/sphinx-guides/source/user/account.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@ You can also convert your Dataverse account to use authentication provided by Gi
My Data
-------

The My Data section of your account page displays a listing of all the dataverses, datasets, and files you have either created, uploaded or that you have a role assigned on. If you see unexpected dataverses or datasets in your My Data page, it might be because someone has assigned your account a role on those dataverses or datasets. For example, some institutions automatically assign the "File Downloader" role on their datasets to all accounts using their institutional login.
The My Data section of your account page displays a listing of all the dataverses, datasets, and files you have either created, uploaded or that you have a role assigned on. You are able to filter through all the dataverses, datasets, and files listed on your My Data page using the filter box. You may also use the facets on the left side to only view a specific Publication Status or Role.

.. note:: If you see unexpected dataverses or datasets in your My Data page, it might be because someone has assigned your account a role on those dataverses or datasets. For example, some institutions automatically assign the "File Downloader" role on their datasets to all accounts using their institutional login.

You are able to filter through all the dataverses, datasets, and files listed on your My Data page using the filter box. You may also use the facets on the left side to only view a specific Publication Status or Role.

You can use the Add Data button to create a new dataverse or dataset. By default, the new dataverse or dataset will be created in the root dataverse, but from the create form you can use the Host Dataverse dropdown menu to choose a different dataverse, for which you have the proper access privileges. However, you will not be able to change this selection after you create your dataverse or dataset.

Notifications
-------------
Expand Down
10 changes: 4 additions & 6 deletions doc/sphinx-guides/source/user/dataset-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ Each of these metadata exports contains the metadata of the most recently publis
Adding a New Dataset
====================

#. Navigate to the dataverse in which you want to add a dataset.
#. Click on the "Add Data" button and select "New Dataset" in the dropdown menu.
#. Navigate to the dataverse in which you want to add a dataset.
#. Click on the "Add Data" button and select "New Dataset" in the dropdown menu. **Note:** If you are on the root dataverse, your My Data page or click the "Add Data" link in the navbar, the dataset you create will be hosted in the root dataverse. You can change this by selecting another dataverse you have proper permissions to create datasets in, from the Host Dataverse dropdown in the create dataset form. This option to choose will not be available after you create the dataset.
#. To quickly get started, enter at minimum all the required fields with an asterisk (e.g., the Dataset Title, Author,
Description, Contact Email and Subject) to get a Data Citation with a DOI.
#. Scroll down to the "Files" section and click on "Select Files to Add" to add all the relevant files to your Dataset.
Expand All @@ -51,7 +51,7 @@ Adding a New Dataset
description and tags (via the "Edit Tag" button) for each file. Additionally, an MD5 checksum will be added for each file. If you upload a tabular file a :ref:`Universal Numerical Fingerprint (UNF) <unf>` will be added to this file.
#. Click the "Save Dataset" button when you are done. Your unpublished dataset is now created.

Note: You can add additional metadata once you have completed the initial dataset creation by going to Edit Dataset > Metadata.
Note: You can add additional metadata once you have completed the initial dataset creation by going to clicking the Edit button and selecting Metadata from the dropdown menu.

Supported HTML Fields
---------------------
Expand Down Expand Up @@ -209,8 +209,6 @@ These folder names are subject to strict validation rules. Only the following ch

.. note:: If you upload multiple .zip files to one dataset, any subdirectories that are identical across multiple .zips will be merged together when the user downloads the full dataset.



Other File Types
----------------

Expand Down Expand Up @@ -276,6 +274,7 @@ Dataset terms can be viewed and edited from the Terms tab of the dataset page, o

CC0 Public Domain Dedication
----------------------------

By default, all new datasets created through Dataverse's web UI are given a `Creative Commons CC0 Public Domain Dedication <https://creativecommons.org/publicdomain/zero/1.0/>`_.

The `Creative Commons <https://creativecommons.org>`_ organization defines a number of `licenses <https://creativecommons.org/licenses/>`_ that allow copyright holders to release their intellectual property more openly, with fewer legal restrictions than standard copyright enforces. Each Creative Commons license typically specifies simple terms for how the IP must be used, reused, shared, and attributed. In addition to these licenses, Creative Commons also provides public domain tools that make it easy to dedicate IP to the public domain.
Expand Down Expand Up @@ -540,4 +539,3 @@ If you deaccession the most recently published version of the dataset but not al

.. _Make Data Count: https://makedatacount.org
.. _Crossref: https://crossref.org

65 changes: 30 additions & 35 deletions doc/sphinx-guides/source/user/dataverse-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,40 @@ A dataverse is a container for datasets (research data, code, documentation, and

|image1|

Once a user creates a dataverse they, by default, become the
administrator of that dataverse. The dataverse administrator has access
to manage the settings described in this guide.
Once a user creates a dataverse they, by default, become the administrator of that dataverse. The dataverse administrator has access to manage the settings described in this guide.

.. contents:: |toctitle|
:local:

Create a Dataverse (Within the "Root" Dataverse)
===================================================
Create a New Dataverse
=======================

Creating a dataverse is easy but first you must be a registered user (see :doc:`/user/account`).
Creating a dataverse is easy but first you must be a registered user (see :doc:`/user/account`). Once you are logged in, click on the "Add Data" button, or "Add Data" navbar link and in the dropdown menu select "New Dataverse".

#. Once you are logged in click on the "Add Data" button and in the dropdown menu select "New Dataverse".
#. Once on the "New Dataverse" page fill in the following fields:
* **Name**: Enter the name of your dataverse.
#. **Fill in the following fields on the "New Dataverse" page** (required fields in the form are denoted by a red asterisk, next to the label):
* **Host Dataverse**: Select a dataverse you would like to create the new dataverse in, by default the root dataverse is selected if you click the Add Data button from the root dataverse, your My Data pg, the Add Data link in the navbar, or the Add a dataset button on the custom homepage (if configured), but you can select any dataverse for which you the proper permissions to create dataverses.
* **Dataverse Name**: Enter the name of your dataverse.
* **Affiliation**: Add any affiliation that can be associated with this particular dataverse (e.g., project name, institute name, department name, journal name, etc). This is automatically filled out if you have added an affiliation for your user account.
* **Identifier**: This is an abbreviation, usually lower-case, that becomes part of the URL for the new dataverse. Special characters (~,\`, !, @, #, $, %, ^, &, and \*) and spaces are not allowed. **Note**: if you change this field in the future, the URL for your Dataverse will change (http//.../'identifier'), which will break older links to the page.
* **Category**: Select a category that best describes the type of dataverse this will be. For example, if this is a dataverse for an individual researcher's datasets, select *Researcher*. If this is a dataverse for an institution, select *Organization or Institution*.
* **Email**: This is the email address that will be used as the contact for this particular dataverse. You can have more than one contact email address for your dataverse.
* **Affiliation**: Add any Affiliation that can be associated with this particular dataverse (e.g., project name, institute name, department name, journal name, etc). This is automatically filled out if you have added an affiliation for your user account.
* **Description**: Provide a description of this dataverse. This will display on the landing page of your dataverse and in the search result list. The description field supports certain HTML tags, if you'd like to format your text (<a>, <b>, <blockquote>, <br>, <code>, <del>, <dd>, <dl>, <dt>, <em>, <hr>, <h1>-<h3>, <i>, <img>, <kbd>, <li>, <ol>, <p>, <pre>, <s>, <sup>, <sub>, <strong>, <strike>, <ul>).
* **Category**: Select a category that best describes the type of dataverse this will be. For example, if this is a dataverse for an individual researcher's datasets, select *Researcher*. If this is a dataverse for an institution, select *Organization or Institution*.
* **Choose the sets of Metadata Fields for datasets in this dataverse**: By default the metadata elements will be from the host dataverse that this new dataverse is created in. Dataverse offers metadata standards for multiple domains. To learn more about the metadata standards in Dataverse please check out the :doc:`/user/appendix`.
* **Select facets for this dataverse**: Choose which metadata fields will be used as facets on your dataverse. These facets will allow users browsing or searching your dataverse to filter its contents according to the fields you’ve selected. For example, if you select “Subject” as a facet, users will be able to filter your dataverse’s contents by subject area. By default, the facets that will appear on your dataverse landing page will be from the host dataverse that this new dataverse was created in, but you can add or remove facets from this default.
#. Selected metadata elements are also used to pick which metadata fields you would like to use for creating templates for your datasets. Metadata fields can be hidden, or selected as required or optional. Once you have selected all the fields you would like to use, you can create your template(s) after you finish creating your dataverse.
#. Click "Create Dataverse" button and you're done!

\*Required fields are denoted by a red asterisk.

Edit Dataverse
=================

To edit your dataverse, navigate to your dataverse's landing page and select the "Edit Dataverse" button,
where you will be presented with the following editing options:

- :ref:`General Information <general-information>`: edit name, identifier, category, contact email, affiliation, description, Metadata Elements, and facets for your dataverse
#. **Choose the sets of Metadata Fields for datasets in this dataverse**:
* By default the metadata elements will be from the host dataverse that this new dataverse is created in.
* Dataverse offers metadata standards for multiple domains. To learn more about the metadata standards in Dataverse please check out the :doc:`/user/appendix`.
* Metadata fields can be hidden, or selected as required or optional.
* Selected metadata elements are also used to pick which metadata fields you would like to use for creating :ref:`Dataset Templates <dataset-templates>`: after you finish creating your dataverse.
#. **Choose which metadata fields will be used as browse/search facets on your dataverse**:
* These facets will allow users browsing or searching your dataverse to filter its contents according to the fields you have selected. For example, if you select “Subject” as a facet, users will be able to filter your dataverse’s contents by subject area.
* By default, the facets that will appear on your dataverse landing page will be from the host dataverse that this new dataverse was created in, but you can add or remove facets from this default.
#. **Click the "Create Dataverse" button** and you're done!

Edit Dataverse
================

To edit your dataverse, navigate to your dataverse's landing page and select the "Edit Dataverse" button, where you will be presented with the following editing options:

- :ref:`General Information <general-information>`: edit name, affiliation, identifier, category, contact email, description, metadata fields, and browse/search facets for your dataverse
- :ref:`Theme <theme>`: upload a logo for your dataverse, add a link to your department or personal website, add a custom footer image, and select colors for your dataverse in order to brand it
- :ref:`Widgets <dataverse-widgets>`: get code to add to your website to have your dataverse display on it
- :ref:`Permissions <dataverse-permissions>`: give Dataverse users permissions to your dataverse, i.e.-can edit datasets, and see which users already have which permissions for your dataverse
Expand Down Expand Up @@ -89,7 +89,6 @@ Dataverse Listing Widget

The Dataverse Listing Widget provides 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 displays the content in the widget on your website. 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 website.


Adding Widgets to an OpenScholar Website
******************************************
#. Log in to your OpenScholar website
Expand Down Expand Up @@ -125,6 +124,7 @@ Please note that even on a newly created dataverse, you may see user and groups

Setting Access Configurations
*******************************

Under the Permissions tab, you can click the "Edit Access" button to open a box where you can add to your dataverse and what permissions are granted to those who add to your dataverse.

|image4|
Expand All @@ -137,6 +137,7 @@ Both of these settings can be changed at any time.

Assigning Roles to Users and Groups
*************************************

Under the Users/Groups tab, you can add, edit, or remove the roles granted to users and groups on your dataverse. A role is a set of permissions granted to a user or group when they're using your dataverse. For example, giving your research assistant the "Contributor" role would give her the following self-explanatory permissions on your dataverse and all datasets within your dataverse: "ViewUnpublishedDataset", "DownloadFile", "EditDataset", and "DeleteDatasetDraft". She would, however, lack the "PublishDataset" permission, and thus would be unable to publish datasets on your dataverse. If you wanted to give her that permission, you would give her a role with that permission, like the Curator role. Users and groups can hold multiple roles at the same time if needed. Roles can be removed at any time. All roles and their associated permissions are listed under the "Roles" tab of the same page.

|image5|
Expand All @@ -151,6 +152,7 @@ Note: If you need to assign a role to ALL Dataverse user accounts, you can assig

Dataset Templates
-------------------

Templates are useful when you have several datasets that have the same information in multiple metadata fields that you would prefer not to have to keep manually typing in, or if you want to use a custom set of Terms of Use and Access for multiple datasets in a dataverse. In Dataverse 4.0, templates are created at the dataverse level, can be deleted (so it does not show for future datasets), set to default (not required), or can be copied so you do not have to start over when creating a new template with similar metadata from another template. When a template is deleted, it does not impact the datasets that have used the template already.

How do you create a template?
Expand All @@ -169,6 +171,7 @@ How do you create a template?

Dataset Guestbooks
-----------------------------

Guestbooks allow you to collect data about who is downloading the files from your datasets. You can decide to collect account information (username, given name & last name, affiliation, etc.) as well as create custom questions (e.g., What do you plan to use this data for?). You are also able to download the data collected from the enabled guestbooks as Excel files to store and use outside of Dataverse.

How do you create a guestbook?
Expand All @@ -179,16 +182,12 @@ How do you create a guestbook?
#. Name the guestbook, determine the account information that you would like to be required (all account information fields show when someone downloads a file), and then add Custom Questions (can be required or not required).
#. Hit the Create Dataset Guestbook button once you have finished.

What can you do with a guestbook?
After creating a guestbook, you will notice there are several options for a guestbook and appear in the list of guestbooks.
What can you do with a guestbook? After creating a guestbook, you will notice there are several options for a guestbook and appear in the list of guestbooks.

- If you want to use a guestbook you have created, you will first need to click the button in the Action column that says Enable. Once a guestbook has been enabled, you can go to the License + Terms for a dataset and select a guestbook for it.

- There are also options to view, copy, edit, or delete a guestbook.

- Once someone has downloaded a file in a dataset where a guestbook has been assigned, an option to download collected data will appear.


.. _featured-dataverses:

Featured Dataverses
Expand Down Expand Up @@ -228,7 +227,6 @@ Once your dataverse is ready to go public, go to your dataverse page, click on t
hand side of the page. A pop-up will appear to confirm that you are ready to actually Publish, since once a dataverse
is made public, it can no longer be unpublished.


.. |image1| image:: ./img/Dataverse-Diagram.png
.. |image2| image:: ./img/dvperms1.png
:class: img-responsive
Expand All @@ -240,6 +238,3 @@ is made public, it can no longer be unpublished.
:class: img-responsive
.. |image6| image:: ./img/dv5.png
:class: img-responsive



Loading