Merge branch 'develop' into 11382-featured-items-unicode-filename #11382

pdurbin · pdurbin · commit 0ae4c8c9e305 · 2025-04-30T15:58:44.000-04:00
diff --git a/.github/workflows/deploy_beta_testing.yml b/.github/workflows/deploy_beta_testing.yml
@@ -43,6 +43,7 @@ jobs:
 
   deploy-to-payara:
     needs: build
+    if: ${{ github.repository_owner == 'IQSS' }}
     runs-on: ubuntu-latest
 
     steps:
diff --git a/doc/release-notes/10941-remove-custom-guides-navbar.md b/doc/release-notes/10941-remove-custom-guides-navbar.md
@@ -0,0 +1 @@
+Navigation across the guides has been improved. You can now click in the upper left to go "home". The navbar has been simplified with fewer links. The bottom of every page now has "Next" and "Previous" links. A "Source" link at the bottom has also been added. See #10942.
diff --git a/doc/release-notes/11271-edit-files-metadata-api-call b/doc/release-notes/11271-edit-files-metadata-api-call
@@ -0,0 +1,5 @@
+Update File Metadata API (PR #11271)
+
+A new API endpoint has been added to allow updating file metadata for one or more files in a dataset.
+
+See the [Native API documentation](https://guides.dataverse.org/en/latest/api/native-api.html) for details on usage.
diff --git a/doc/release-notes/11394-versionNoteBug.md b/doc/release-notes/11394-versionNoteBug.md
@@ -0,0 +1,3 @@
+### versionNote Bug fix
+
+An issue causing more than one edit of a versionNote to fail, when done without a page refresh, has been fixed. 
diff --git a/doc/sphinx-guides/source/_static/docsdataverse_org.css b/doc/sphinx-guides/source/_static/docsdataverse_org.css
@@ -35,6 +35,10 @@ iframe {
 
 a.navbar-brand, a.navbar-brand:hover {
     color:#C55B28 !important;
+    height: 50px;
+    background: rgba(0, 0, 0, 0) url("../_static/images/dataverseicon.png") no-repeat scroll 0 8px;
+    line-height: 20px;
+    padding-left: 26px;
 }
 span.navbar-brand {color:#C55B28 !important; padding-left: 32px; height: 50px;}
 span.navbar-brand .icon-dataverse {color:#C55B28; font-size:28px; margin: -4px 0 0 -27px; position: absolute;}
@@ -48,13 +52,6 @@ ul.navbar-nav li.dropdown.open > span.dropdown-toggle {background: #e7e7e7;}
 .text-dataset {color:#31708F;}
 .text-file {color:#777777;}
 
-#dataverse-org-homepage-url {
-    height: 50px;
-    background: rgba(0, 0, 0, 0) url("../_static/images/dataverseicon.png") no-repeat scroll 0 8px;
-    line-height: 20px;
-    padding-left: 26px;
-}
-
 .navbar-default .navbar-nav > li > a {
     color: #303030 !important;
 }
@@ -189,4 +186,4 @@ div.sphinx-tabs {
 
 li div.sphinx-tabs {
     padding-left: 0;
-}
+}
diff --git a/doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js b/doc/sphinx-guides/source/_static/navbar_from_dataverse_org.js
diff --git a/doc/sphinx-guides/source/_templates/navbar.html b/doc/sphinx-guides/source/_templates/navbar.html
diff --git a/doc/sphinx-guides/source/api/native-api.rst b/doc/sphinx-guides/source/api/native-api.rst
@@ -2597,6 +2597,53 @@ The fully expanded example above (without environment variables) looks like this
 
   curl -H "X-Dataverse-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST "https://demo.dataverse.org/api/datasets/:persistentId/add?persistentId=doi:10.5072/FK2/J8SJZB" -F 'jsonData={"description":"A remote image.","storageIdentifier":"trsa://themes/custom/qdr/images/CoreTrustSeal-logo-transparent.png","checksumType":"MD5","md5Hash":"509ef88afa907eaf2c17c1c8d8fde77e","label":"testlogo.png","fileName":"testlogo.png","mimeType":"image/png"}'
 
+Update File Metadata
+~~~~~~~~~~~~~~~~~~~~
+
+Updates metadata for one or more files in a dataset. This API call allows you to modify file-level metadata without the need to replace the actual file content.
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export PERSISTENT_ID=doi:10.5072/FK2/J8SJZB
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X POST "$SERVER_URL/api/datasets/:persistentId/files/metadata?persistentId=$PERSISTENT_ID" --upload-file file-metadata-update.json
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST "https://demo.dataverse.org/api/datasets/:persistentId/files/metadata?:persistentId=doi:10.5072/FK2/J8SJZB" --upload-file file-metadata-update.json
+
+The ``file-metadata-update.json`` file should contain a JSON array of objects, each representing a file to be updated. Here's an example structure:
+
+.. code-block:: json
+
+  [
+    {
+      "dataFileId": 42,
+      "label": "Updated File Name",
+      "directoryLabel": "data/",
+      "description": "Updated file description",
+      "restricted": false,
+      "categories": ["Documentation", "Data"],
+      "provFreeForm": "Updated provenance information"
+    },
+    {
+      "dataFileId": 43,
+      "label": "Another Updated File",
+      "description": "Another updated description",
+      "restricted": true
+    }
+  ]
+
+Each object in the array must include the ``dataFileId`` field to identify the file. Other fields are optional and will only be updated if included.
+
+The API will return a JSON object with information about the update operation, including any errors that occurred during the process.
+
+Note: This API call requires appropriate permissions to edit the dataset and its files.
+
 .. _cleanup-storage-api:
 
 Cleanup Storage of a Dataset
diff --git a/doc/sphinx-guides/source/conf.py b/doc/sphinx-guides/source/conf.py
@@ -144,7 +144,7 @@
     #     ("Link", "http://example.com", True),
     # ],
     'navbar_links': [
-        ("View 3.6.2 Guides", "http://docs.dataverse.org/en/3.6.2/", True),
+        ("About Dataverse", "https://dataverse.org", True),
     ],
     
     # Global TOC depth for "site" navbar tab. (Default: 1)
diff --git a/doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html b/doc/sphinx_bootstrap_theme/bootstrap/globaltoc.html
@@ -1,9 +1,12 @@
 <li class="dropdown globaltoc-container">
+<!-- Comment out "Site" from navbar (we list guides in the sidebar anyway) -->
+<!--
   <a role="button"
      id="dLabelGlobalToc"
      data-toggle="dropdown"
      data-target="#"
      href="{{ pathto(master_doc) }}">{{ theme_navbar_site_name }} <b class="caret"></b></a>
+-->
   <ul class="dropdown-menu globaltoc"
       role="menu"
       aria-labelledby="dLabelGlobalToc">{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False, includehidden=theme_globaltoc_includehidden|tobool) }}</ul>
diff --git a/doc/sphinx_bootstrap_theme/bootstrap/layout.html b/doc/sphinx_bootstrap_theme/bootstrap/layout.html
@@ -86,6 +86,22 @@
     {%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
     <div class="{{ bs_span_prefix }}{{ bs_content_width }} content" role="main">
       {% block body %}{% endblock %}
+      <!-- Previous button -->
+      {%- if prev %}
+        <a href="{{ prev.link|e }}" title="{{ _('Previous Chapter: ') + prev.title|striptags }}">
+          {%- if theme_bootstrap_version == "2" -%}<span class="icon-chevron-left visible-tablet"></span>{%- endif -%}
+          {%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-left visible-sm"></span>{%- endif -%}
+          <span class="hidden-sm hidden-tablet">{{ "&laquo;Previous"|safe }}</span>
+        </a>
+      {%- endif %}
+      <!-- Next button -->
+      {%- if next %}
+        <a href="{{ next.link|e }}" title="{{ _('Next Chapter: ') + next.title|striptags }}" style="float: right;">
+          {%- if theme_bootstrap_version == "2" -%}<span class="icon-chevron-right visible-tablet"></span>{%- endif -%}
+          {%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-right visible-sm"></span>{%- endif -%}
+          <span class="hidden-sm hidden-tablet">{{ "Next&raquo"|safe }}</span>
+        </a>
+      {%- endif %}
     </div>
     {% block sidebar2 %} {# possible location for sidebar #} {% endblock %}
   </div>
diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbar.html b/doc/sphinx_bootstrap_theme/bootstrap/navbar.html
@@ -11,9 +11,9 @@
           {%- block sidebarlogo %}
             {%- if logo %}<span><img src="{{ pathto('_static/' + logo, 1) }}"></span>{%- endif %}
           {%- endblock %}
-          {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
+          {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}Dataverse Guides{%- endif -%}
         </a>
-        <span class="navbar-text navbar-version pull-left"><b>{{ version|e }}</b></span>
+        <span class="navbar-text navbar-version pull-left"><b><a href="{{ pathto('versions') }}">v{{ version|e }}</a></b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -31,7 +31,10 @@
             {% endblock %}
             {% if theme_navbar_sidebarrel %}
               {% block sidebarrel %}
+                <!-- comment out "prev" and "next" buttons -->
+                <!--
                 {% include "relations.html" %}
+                -->
               {% endblock %}
             {% endif %}
             {% block navbarextra %}
diff --git a/doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html b/doc/sphinx_bootstrap_theme/bootstrap/navbartoc.html
@@ -1,9 +1,12 @@
 <li class="dropdown">
+<!-- Comment out "Page" from navbar (we put contents on every page anyway) -->
+<!--
   <a role="button"
      id="dLabelLocalToc"
      data-toggle="dropdown"
      data-target="#"
      href="#">{{ _(theme_navbar_pagenav_name) }} <b class="caret"></b></a>
+-->
   <ul class="dropdown-menu localtoc"
       role="menu"
       aria-labelledby="dLabelLocalToc">{{ toc }}</ul>
diff --git a/doc/sphinx_bootstrap_theme/bootstrap/theme.conf b/doc/sphinx_bootstrap_theme/bootstrap/theme.conf
@@ -48,7 +48,7 @@ navbar_fixed_top = true
 
 # Location of link to source.
 # Options are "nav" (default), "footer" or anything else to exclude.
-source_link_position = nav
+source_link_position = footer
 
 # Bootswatch (http://bootswatch.com/) theme.
 #
diff --git a/src/main/java/edu/harvard/iq/dataverse/DatasetPage.java b/src/main/java/edu/harvard/iq/dataverse/DatasetPage.java
@@ -6803,10 +6803,10 @@ public boolean isDOI() {
         return AbstractDOIProvider.DOI_PROTOCOL.equals(dataset.getGlobalId().getProtocol());
     }
     
-    public void saveVersionNote() {
+    public String saveVersionNote() {
         this.editMode=EditMode.VERSIONNOTE;
         publishDialogVersionNote = workingVersion.getVersionNote();
-        save();
+        return save();
     }
     String publishDialogVersionNote = null;
     
diff --git a/src/main/java/edu/harvard/iq/dataverse/SettingsWrapper.java b/src/main/java/edu/harvard/iq/dataverse/SettingsWrapper.java
@@ -732,11 +732,11 @@ public Map<String, String> getGuestbookEntryOptions(DvObjectContainer target) {
             if (target.getOwner() == null) {
                 boolean defaultOption = gbDefault.get();
                 useDefault = (defaultOption ? atRequest : atDownload)
-                        + BundleUtil.getStringFromBundle("dataverse.default");
+                        + " " + BundleUtil.getStringFromBundle("dataverse.default");
             } else {
                 boolean defaultOption = target.getOwner().getEffectiveGuestbookEntryAtRequest();
                 useDefault = (defaultOption ? atRequest : atDownload)
-                        + BundleUtil.getStringFromBundle("dataverse.inherited");
+                        + " " + BundleUtil.getStringFromBundle("dataverse.inherited");
             }
             currentMap.put(DvObjectContainer.UNDEFINED_CODE, useDefault);
             currentMap.put(Boolean.toString(true), atRequest);
diff --git a/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java b/src/main/java/edu/harvard/iq/dataverse/api/Datasets.java
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/DatasetsIT.java b/src/test/java/edu/harvard/iq/dataverse/api/DatasetsIT.java
diff --git a/src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java b/src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Navigation across the guides has been improved. You can now click in the upper left to go "home". The navbar has been simplified with fewer links. The bottom of every page now has "Next" and "Previous" links. A "Source" link at the bottom has also been added. See #10942.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+### versionNote Bug fix`
	`2`	`+`
	`3`	`+An issue causing more than one edit of a versionNote to fail, when done without a page refresh, has been fixed.`