Add docs about new metadata field type uri_no. IQSS#7117

poikilotherm · Jul 23, 2020 · 51b4fe5 · 51b4fe5
1 parent e171eb5
commit 51b4fe5
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/doc/sphinx-guides/source/admin/metadatacustomization.rst b/doc/sphinx-guides/source/admin/metadatacustomization.rst
@@ -197,6 +197,7 @@ Each of the three main sections own sets of properties:
 |                       | is meant to contain.  | | \• text              |
 |                       |                       | | \• textbox           |
 |                       |                       | | \• url               |
+|                       |                       | | \• uri_no            |
 |                       |                       | | \• int               |
 |                       |                       | | \• float             |
 |                       |                       | | \• See below for     |
@@ -418,7 +419,18 @@ FieldType definitions
 |                                   | Management page in the User Guide.|
 +-----------------------------------+-----------------------------------+
 | url                               | If not empty, field must contain  |
-|                                   | a valid URL.                      |
+|                                   | a valid URL, restricted to schemes|
+|                                   | ``http``, ``https``,              |
+|                                   | ``file``, ``jar``. (A limitation  |
+|                                   | of `Java URL class`_.)            |
++-----------------------------------+-----------------------------------+
+| uri_no                            | If not empty, field must contain  |
+|                                   | a valid, non-opaque, absolute URI.|
+|                                   | (Meaning an URL.)                 |
+|                                   | See also :rfc:`3986`,             |
+|                                   | `Good practices for URIs`_,       |
+|                                   | `W3C Axioms`_,                    |
+|                                   | `W3C URI Clarification`_.         |
 +-----------------------------------+-----------------------------------+
 | int                               | An integer value destined for a   |
 |                                   | numeric field.                    |
@@ -427,6 +439,11 @@ FieldType definitions
 |                                   | for a numeric field.              |
 +-----------------------------------+-----------------------------------+
 
+.. _Java URL class: https://docs.oracle.com/javase/8/docs/api/java/net/URL.html#URL-java.lang.String-java.lang.String-int-java.lang.String-
+.. _Good practices for URIs: https://www.ebi.ac.uk/rdf/documentation/good_practice_uri
+.. _W3C Axioms: https://www.w3.org/DesignIssues/Axioms.html
+.. _W3C URI Clarification: https://www.w3.org/TR/uri-clarification
+
 displayFormat variables
 ~~~~~~~~~~~~~~~~~~~~~~~