deploy: 4d51483

MESH-Research · Jan 8, 2025 · b418ee2 · b418ee2
1 parent cccd00a
commit b418ee2
Show file tree

Hide file tree

Showing 23 changed files with 562 additions and 12 deletions.
diff --git a/.buildinfo.bak b/.buildinfo.bak
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a5aca5a1685a462734e83a3c3fb2f3a5
+config: c98d14472b07a7a52cb283ce05317c0a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/CHANGES.doctree b/.doctrees/CHANGES.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/metadata.doctree b/.doctrees/metadata.doctree
diff --git a/CHANGES.html b/CHANGES.html
diff --git a/README.html b/README.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="installation.html" /><link rel="prev" title="Welcome to Knowledge Commons Works’s documentation!" href="index.html" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Changes" href="CHANGES.html" /><link rel="prev" title="Welcome to Knowledge Commons Works’s documentation!" href="index.html" />
 
     <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
         <title>About - Knowledge Commons Works 0.3.3 documentation</title>
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>
@@ -265,12 +266,12 @@ <h2>Copyright<a class="headerlink" href="#copyright" title="Link to this heading
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="installation.html">
+          <a class="next-page" href="CHANGES.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Installation</div>
+                <div class="title">Changes</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>

diff --git a/_sources/CHANGES.md.txt b/_sources/CHANGES.md.txt
@@ -0,0 +1,69 @@
+<!-- This file is part of Knowledge Commons Works. -->
+<!-- Copyright (C) 2024 Mesh Research. -->
+
+# Changes
+
+## 0.3.3-beta6 (2024-12-18)
+
+- Names
+    - Added the infrastructure to customize the division of users' names into parts so that it can be divided as desired when, e.g., the user's name is being auto-filled in the name fields of the upload form. This involves
+        - a new "name_parts_local" field to the user profile schema. This field contains the user's name parts if they have been modified within the KCWorks system. This is sometimes necessary when the user data synced from the remote user data service does not divide the user's name correctly.
+        - a cli command to update the user's name parts.
+        - a new "names" js module that contains functions to get the user's full name, full name in inverted order, family name, and given name from the user's name parts.
+        - updates to the CreatibutorsField component to use the new "names" js module and the customized name parts if they are present in a user's profile.
+- Detail page
+    - Added missing aria-label properties for accessibility
+- Collections
+    - Fixed wording of empty results message for collection members search
+        - Previously, the empty results message used "community" instead of "collection".
+    - Tweaks to layout of collection detail page header
+- Remote user data service
+    - Fixed bug where user profile data was not being updated because comparison with initial data was not being made correctly. This means that, among other things, ORCID ids will now be added correctly when the user chooses "add self" on the upload form.
+
+## 0.3.2-beta5 (2024-12-11)
+
+- Added Bluesky sharing option to detail page
+- Fixed line wrapping of long values in record sidebar details
+- Added OpenGraph image metadata property to record detail page
+    - This allows social media platforms to display the KCWorks logo instead of a random image they might find on the page.
+
+## 0.3.1-beta4 (2024-12-10)
+
+- Added sort options for publication date to record search
+    - This allows users to sort records by the date they were published.
+    - It also allows publication-date sorting in API requests to the search API. Among other things, this allows users' KC profiles to display records in publication date order.
+- Community selection modal bug fixes
+    - This affects the modal that appears both during record submission on the upload form and during collection management on the detail page.
+    - Fixed the sort order of search results in the modal. These were being sorted by record creation date, leading to a confusing sort order. It now sorts by "best match". This allows, e.g., "Knowledge Commons" to find the main KC collection.
+    - Also fixed the handling of '/' in the search query string. This allows, e.g., "ARLIS/NA" to find the ARLIS/NA collection, where previously it would produce an error.
+
+## 0.3.0-beta3 (2024-11-30)
+
+- Record detail page
+    - Added ui for collection management
+        - A new menu appears in the detail page sidebar when a user has permission to edit a record. This
+        allows users to manage the record's collections right from the detail page.
+        - With this menu users can now
+            - submit a request to have an existing published record added to a collection.
+            - add a record to multiple collections
+            - remove a record from some or all of its collections
+            - view pending collection submissions for the record
+        - change which collection appears as the primary collection for the record (i.e., the collection whose logo appears in the record's detail page sidebar)
+    - Refactored record management menu
+    - Refactored all sidebar menus (including the record management menu) to allow accessible
+      keyboard navigation
+    - Fixed display of event metadata
+    - Added display for work doi as well as version doi
+        - Each record has at least two DOIs: a work DOI and a version DOI. The work DOI is the DOI for the record as a whole. It always points to the most recent version of the work, even if the user creates new versions in the future. The other identifier is the version DOI, which will always point to the specific version of the work that the user is currently viewing. Previously, only the version DOI was displayed, which could be confusing if the user created a new version of the work.
+
+- Upload form
+    - Added proper messages to collections widget for published records
+        - since collections for published records are now managed from the detail page, the collections widget now displays messages to users pointing them to the detail page to manage collections.
+    - Added clearer titles to form when editing an existing record
+      or creating a new version
+        - Previously, the form would display "Editing Published Record" both when editing the metadata of an existing published version *and* when creating a new version. The header now displays "Creating New Version" when creating a new version, and "Editing Published Record" when editing the metadata of an existing published version.
+    - Changed default publisher from "unknown" to "Knowledge Commons"
+        - Previously, the default publisher was "unknown". This was especially confusing for resource types where the publisher field is hidden on the upload form. Now, the default publisher is "Knowledge Commons".
+
+- Solved collection links bug with custom routes
+    - This is a back-end technical fix that should not be visible to users.
diff --git a/_sources/metadata.md.txt b/_sources/metadata.md.txt
@@ -239,7 +239,7 @@ Note that no single actual record would include all of these fields. The example
         "record": "public",
         "files": "restricted",
         "embargo": {
-            "active": True,
+            "active": true,
             "until": "2029-01-01",
             "reason": "Publisher requires embargo.",
         }
@@ -268,7 +268,7 @@ The Research Organization Registry (https://ror.org/) is used for the `organizat
 
 ## Notes about Implementation of Core InvenioRDM Fields
 
-#### metadata.subjects
+### metadata.subjects
 
 Note that KCWorks employs the FAST controlled vocabulary (https://www.oclc.org/research/areas/data-science/fast.html) for the `subjects` field, complemented by the Homosaurus vocabulary (https://homosaurus.org/).
 
@@ -305,7 +305,7 @@ Example:
 }
 ```
 
-#### metadata.creators/metadata.contributors
+### metadata.creators/metadata.contributors
 
 Note that the KC username of a creator or contributor may be stored in the `person_or_org.identifiers` array of the creator or contributor object with the scheme `kc_username`.
 

diff --git a/cli_commands.html b/cli_commands.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>

diff --git a/configuration.html b/configuration.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>

diff --git a/customizations.html b/customizations.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Customizations to InvenioRDM</a></li>

diff --git a/developing.html b/developing.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>

diff --git a/genindex.html b/genindex.html
@@ -199,6 +199,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>

diff --git a/in_depth.html b/in_depth.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>

diff --git a/index.html b/index.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>
@@ -259,6 +260,13 @@ <h1>Welcome to Knowledge Commons Works’s documentation!<a class="headerlink" h
 <li class="toctree-l2"><a class="reference internal" href="README.html#copyright">Copyright</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="CHANGES.html#beta6-2024-12-18">0.3.3-beta6 (2024-12-18)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="CHANGES.html#beta5-2024-12-11">0.3.2-beta5 (2024-12-11)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="CHANGES.html#beta4-2024-12-10">0.3.1-beta4 (2024-12-10)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="CHANGES.html#beta3-2024-11-30">0.3.0-beta3 (2024-11-30)</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#quickstart">Quickstart</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation.html#full-local-development-setup">Full local development setup</a></li>

diff --git a/infrastructure.html b/infrastructure.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>

diff --git a/installation.html b/installation.html
@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Metadata Schema and Vocabularies" href="metadata.html" /><link rel="prev" title="About" href="README.html" />
+<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Metadata Schema and Vocabularies" href="metadata.html" /><link rel="prev" title="Changes" href="CHANGES.html" />
 
     <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
         <title>Installation - Knowledge Commons Works 0.3.3 documentation</title>
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>
@@ -403,14 +404,14 @@ <h2>Controlling the KCWorks (Flask) application<a class="headerlink" href="#cont
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="README.html">
+          <a class="prev-page" href="CHANGES.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">About</div>
+                <div class="title">Changes</div>
 
               </div>
             </a>

diff --git a/metadata.html b/metadata.html
@@ -201,6 +201,7 @@
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="README.html">About</a></li>
+<li class="toctree-l1"><a class="reference internal" href="CHANGES.html">Changes</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Metadata Schema and Vocabularies</a></li>
 <li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations to InvenioRDM</a></li>
@@ -487,7 +488,7 @@ <h2>Example JSON record<a class="headerlink" href="#example-json-record" title="
 <span class="w">        </span><span class="nt">&quot;record&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;public&quot;</span><span class="p">,</span>
 <span class="w">        </span><span class="nt">&quot;files&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;restricted&quot;</span><span class="p">,</span>
 <span class="w">        </span><span class="nt">&quot;embargo&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
-<span class="w">            </span><span class="nt">&quot;active&quot;</span><span class="p">:</span><span class="w"> </span><span class="err">True</span><span class="p">,</span>
+<span class="w">            </span><span class="nt">&quot;active&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
 <span class="w">            </span><span class="nt">&quot;until&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2029-01-01&quot;</span><span class="p">,</span>
 <span class="w">            </span><span class="nt">&quot;reason&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Publisher requires embargo.&quot;</span><span class="p">,</span>
 <span class="w">        </span><span class="p">}</span>

diff --git a/objects.inv b/objects.inv