From 3f9319bd866fd2726e8651694a436b7396733d75 Mon Sep 17 00:00:00 2001 From: Michael Heppler Date: Tue, 18 Dec 2018 14:01:43 -0500 Subject: [PATCH 1/3] Added help text and link to user guide for Download URL on file pg [ref #2960] --- doc/sphinx-guides/source/user/find-use-data.rst | 8 ++++++++ src/main/java/Bundle.properties | 1 + src/main/webapp/file.xhtml | 9 ++++++++- 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/sphinx-guides/source/user/find-use-data.rst b/doc/sphinx-guides/source/user/find-use-data.rst index 6c59ebc2987..9d47361a8de 100755 --- a/doc/sphinx-guides/source/user/find-use-data.rst +++ b/doc/sphinx-guides/source/user/find-use-data.rst @@ -96,6 +96,14 @@ Ingested files can be downloaded in several different ways. - A subset of the columns of the data +.. _url_download: + +Downloading via URL +^^^^^^^^^^^^^^^^^^^^ + +Dataverse displays a plaintext URL for the location of the file. To ensure a reliable, resumable download, we recommend using `GNU Wget `_ in a command line terminal or using a download manager software of your choice. If you try to simply paste the URL into your web browser then the download may overwhelm your browser, resulting in an interrupted, timed out, or otherwise failed download. + + .. _rsync_download: Downloading a Dataverse Package via rsync diff --git a/src/main/java/Bundle.properties b/src/main/java/Bundle.properties index 09425d6ae6c..f8be46ae4fd 100755 --- a/src/main/java/Bundle.properties +++ b/src/main/java/Bundle.properties @@ -1700,6 +1700,7 @@ file.DatasetVersion=Version file.metadataTab.fileMetadata.header=File Metadata file.metadataTab.fileMetadata.persistentid.label=Data File Persistent ID file.metadataTab.fileMetadata.downloadUrl.label=Download URL +file.metadataTab.fileMetadata.downloadUrl.info=Use the Download URL in a Wget command or a download manager to avoid interrupted downloads, time outs or other failures. User Guide - Downloading via URL file.metadataTab.fileMetadata.unf.label=File UNF file.metadataTab.fileMetadata.size.label=Size file.metadataTab.fileMetadata.type.label=Type diff --git a/src/main/webapp/file.xhtml b/src/main/webapp/file.xhtml index 29fc5e93337..652b1466897 100644 --- a/src/main/webapp/file.xhtml +++ b/src/main/webapp/file.xhtml @@ -433,7 +433,14 @@ #{bundle['file.metadataTab.fileMetadata.downloadUrl.label']}
- +

+ + + + + +

+
From ceaf1c10f94bbd64bbb5eaeb0d9fd65773296557 Mon Sep 17 00:00:00 2001 From: Michael Heppler Date: Tue, 18 Dec 2018 14:02:53 -0500 Subject: [PATCH 2/3] Fixed undefined label warning in sphinx build [ref #2960] --- doc/sphinx-guides/source/installation/config.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/sphinx-guides/source/installation/config.rst b/doc/sphinx-guides/source/installation/config.rst index e9d1a031da5..f4e033263de 100644 --- a/doc/sphinx-guides/source/installation/config.rst +++ b/doc/sphinx-guides/source/installation/config.rst @@ -975,6 +975,8 @@ Otherwise, if ``:DataFilePIDFormat`` is set to *INDEPENDENT*, then each file wil Note that in either case, when using the ``sequentialNumber`` option, datasets and files share the same database sequence that was created as part of the setup described in ``:IdentifierGenerationStyle`` above. +.. _:FilePIDsEnabled: + :FilePIDsEnabled ++++++++++++++++ From 707b792ddf3f9f20c3c9f673b08d6c439a0ded8c Mon Sep 17 00:00:00 2001 From: Derek Murphy Date: Tue, 18 Dec 2018 15:30:06 -0500 Subject: [PATCH 3/3] Edit help text [#2960] Moved around and added some new info. --- .../source/user/find-use-data.rst | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/sphinx-guides/source/user/find-use-data.rst b/doc/sphinx-guides/source/user/find-use-data.rst index 9d47361a8de..8d19747fb18 100755 --- a/doc/sphinx-guides/source/user/find-use-data.rst +++ b/doc/sphinx-guides/source/user/find-use-data.rst @@ -76,9 +76,9 @@ Download Files Within the Files tab on a dataset page, you can download the files in that dataset. To download more than one file at a time, select the files you would like to download and then click the Download button above the files. The selected files will download in zip format. -You may also download a file from its file page by clicking the Download button in the upper right corner of the page, or by using the Download URL listed under the Metadata tab on the lower half of the page. The Download URL can be used to directly access the file via API (or in a web browser, if needed). Certain files do not provide Download URLs for technical reasons: those that are restricted, have terms of use associated with them, or are part of a dataverse with a guestbook enabled. +You may also download a file from its file page by clicking the Download button in the upper right corner of the page, or by :ref:`url_download` under the Metadata tab on the lower half of the page. -Tabular data files offer additional options: You can explore using the TwoRavens data visualization tool (or other :doc:`/installation/external-tools` if they have been enabled) by clicking the Explore button, or choose from a number of tabular-data-specific download options available as a dropdown under the Download button. +Tabular data files offer additional options: You can explore using any data exploration or visualization :doc:`/installation/external-tools` (if they have been enabled) by clicking the Explore button, or choose from a number of tabular-data-specific download options available as a dropdown under the Download button. Tabular Data ^^^^^^^^^^^^ @@ -101,8 +101,16 @@ Ingested files can be downloaded in several different ways. Downloading via URL ^^^^^^^^^^^^^^^^^^^^ -Dataverse displays a plaintext URL for the location of the file. To ensure a reliable, resumable download, we recommend using `GNU Wget `_ in a command line terminal or using a download manager software of your choice. If you try to simply paste the URL into your web browser then the download may overwhelm your browser, resulting in an interrupted, timed out, or otherwise failed download. +Dataverse displays a plaintext URL for the location of the file under the Metadata tab on the dataset page. This Download URL can be used to directly access the file via API (or in a web browser, if needed). When downloading larger files, in order to ensure a reliable, resumable download, we recommend using `GNU Wget `_ in a command line terminal or using a download manager software of your choice. + +Certain files do not provide Download URLs for technical reasons: those that are restricted, have terms of use associated with them, or are part of a dataverse with a guestbook enabled. +.. _package_download_url: + +Downloading a Dataverse Package via URL +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Dataverse Packages are typically used to represent extremely large files or bundles containing a large number of files. Dataverse Packages are often too large to be reliably downloaded using a web browser. When you click to download a Dataverse Package, instead of automatically initiating the download in your web browser, Dataverse displays a plaintext URL for the location of the file. To ensure a reliable, resumable download, we recommend using `GNU Wget `_ in a command line terminal or using a download manager software of your choice. If you try to simply paste the URL into your web browser then the download may overwhelm your browser, resulting in an interrupted, timed out, or otherwise failed download. .. _rsync_download: @@ -117,14 +125,6 @@ In a dataset containing a Dataverse Package, at the bottom of the dataset page, After you've downloaded the Dataverse Package, you may want to double-check that your download went perfectly. Under **Verify Data**, you'll find a command that you can run in your terminal that will initiate a checksum to ensure that the data you downloaded matches the data in Dataverse precisely. This way, you can ensure the integrity of the data you're working with. - -.. _package_download_url: - -Downloading a Dataverse Package via URL -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Dataverse Packages are typically used to represent extremely large files or bundles containing a large number of files. Dataverse Packages are often too large to be reliably downloaded using a web browser. When you click to download a Dataverse Package, instead of automatically initiating the download in your web browser, Dataverse displays a plaintext URL for the location of the file. To ensure a reliable, resumable download, we recommend using `GNU Wget `_ in a command line terminal or using a download manager software of your choice. If you try to simply paste the URL into your web browser then the download may overwhelm your browser, resulting in an interrupted, timed out, or otherwise failed download. - Explore Data ------------