Page MenuHomeSoftware Heritage

D5654.id.diff
No OneTemporary

D5654.id.diff

diff --git a/docs/persistent-identifiers.rst b/docs/persistent-identifiers.rst
--- a/docs/persistent-identifiers.rst
+++ b/docs/persistent-identifiers.rst
@@ -4,7 +4,7 @@
SoftWare Heritage persistent IDentifiers (SWHIDs)
=================================================
-**version 1.5, last modified 2020-05-14**
+**version 1.6, last modified 2021-04-30**
.. contents::
:local:
@@ -228,6 +228,24 @@
maintained in future versions of this scheme (or Git).
+Automatically fixing invalid SWHIDs
+-----------------------------------
+
+User interfaces may fix invalid SWHIDs, by lower-casing the
+``<identifier_core>`` part of a SWHID, if it contains upper-case letters
+because of user errors or limitations in software displaying SWHIDs.
+
+However, implementations displaying or generating SWHIDs should not rely
+on this behavior, and must display or generate only valid SWHIDs when
+technically possible.
+
+User interfaces should show an error when such an automatic fix occurs,
+so users have a chance to fix their SWHID before pasting it to an other interface
+that does not perform the same corrections.
+This also makes it easier to understand issues when a case-sensitive
+qualifier has its casing altered.
+
+
Examples
========

File Metadata

Mime Type
text/plain
Expires
Nov 4 2024, 8:35 PM (19 w, 3 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3219037

Event Timeline