diff --git a/docs/api/metadata.rst b/docs/api/metadata.rst --- a/docs/api/metadata.rst +++ b/docs/api/metadata.rst @@ -194,7 +194,11 @@ Note ---- + We aim on harmonizing the metadata from different origins and thus metadata will be translated to the `CodeMeta -v.2 `__ vocabulary if +v2.0 `__ vocabulary if possible. + +See :ref:`deposit-protocol` for details on the content of ```` +elements. diff --git a/docs/api/user-manual.rst b/docs/api/user-manual.rst --- a/docs/api/user-manual.rst +++ b/docs/api/user-manual.rst @@ -131,7 +131,8 @@ (deposit)$ Please read the :ref:`deposit-metadata` page for a more detailed view on the -metadata file formats and semantics. +metadata file formats and semantics. and :ref:`deposit-create_origin` for +a description of the ```` tag. Push a deposit diff --git a/docs/specs/protocol-reference.rst b/docs/specs/protocol-reference.rst --- a/docs/specs/protocol-reference.rst +++ b/docs/specs/protocol-reference.rst @@ -15,6 +15,7 @@ All these tags are in the ``https://www.softwareheritage.org/schema/2018/deposit`` XML namespace, denoted using the ``swhdeposit`` prefix in this section. +.. _deposit-create_origin: Origin creation with the ```` tag ----------------------------------------------------------- @@ -91,6 +92,7 @@ This fallback is provided for compliance with SWORDv2_ clients, but we do not recommend relying on it, as it usually creates origins URL that are not meaningful. +.. _deposit-add_to_origin: Adding releases to an origin, with the ```` tag -------------------------------------------------------------------------