Skip to content

Commit

Permalink
Merge pull request #5410 from IQSS/2960-download-manager-help-msg
Browse files Browse the repository at this point in the history
2960 download manager help msg
  • Loading branch information
kcondon authored Dec 19, 2018
2 parents 0ec3b73 + 6f64acf commit 0ca7d73
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 11 deletions.
2 changes: 2 additions & 0 deletions doc/sphinx-guides/source/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
++++++++++++++++

Expand Down
28 changes: 18 additions & 10 deletions doc/sphinx-guides/source/user/find-use-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^
Expand All @@ -96,6 +96,22 @@ 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 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 <https://www.gnu.org/software/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 <https://www.gnu.org/software/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
Expand All @@ -109,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 <https://www.gnu.org/software/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
------------

Expand Down
1 change: 1 addition & 0 deletions src/main/java/Bundle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -1702,6 +1702,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. <a href="{0}/{1}/user/find-use-data.html#downloading-via-url" title="User Guide - Downloading via URL" target="_blank">User Guide - Downloading via URL</a>
file.metadataTab.fileMetadata.unf.label=File UNF
file.metadataTab.fileMetadata.size.label=Size
file.metadataTab.fileMetadata.type.label=Type
Expand Down
9 changes: 8 additions & 1 deletion src/main/webapp/file.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,14 @@
#{bundle['file.metadataTab.fileMetadata.downloadUrl.label']}
</label>
<div class="col-sm-9">
<h:outputText value="#{FilePage.publicDownloadUrl}"/>
<p class="help-block">
<span class="glyphicon glyphicon-info-sign"></span>
<h:outputFormat value=" #{bundle['file.metadataTab.fileMetadata.downloadUrl.info']}" escape="false">
<f:param value="#{systemConfig.guidesBaseUrl}"/>
<f:param value="#{systemConfig.guidesVersion}"/>
</h:outputFormat>
</p>
<code><h:outputText value="#{FilePage.publicDownloadUrl}"/></code>
</div>
</div>
<div class="form-group" jsf:rendered="#{!(empty FilePage.file.unf)}">
Expand Down

0 comments on commit 0ca7d73

Please sign in to comment.