Changeset View
Changeset View
Standalone View
Standalone View
docs/metadata.rst
.. _deposit-metadata: | |||||
Deposit metadata | Deposit metadata | ||||
================ | ================ | ||||
When making a software deposit into the SWH archive, one can add | When making a software deposit into the SWH archive, one can add | ||||
information describing the software artifact and the software project. | information describing the software artifact and the software project. | ||||
Metadata requirements | Metadata requirements | ||||
--------------------- | --------------------- | ||||
- **the schema/vocabulary** used *MUST* be specified with a persistent url | - **the schema/vocabulary** used *MUST* be specified with a persistent url | ||||
(DublinCore, DOAP, CodeMeta, etc.) | (DublinCore, DOAP, CodeMeta, etc.) | ||||
.. code:: xml | .. code:: xml | ||||
<entry xmlns="http://www.w3.org/2005/Atom"> | <entry xmlns="http://www.w3.org/2005/Atom"> | ||||
or | or | ||||
<entry xmlns="http://www.w3.org/2005/Atom" | <entry xmlns="http://www.w3.org/2005/Atom" | ||||
xmlns:dcterms="http://purl.org/dc/terms/"> | xmlns:dcterms="http://purl.org/dc/terms/"> | ||||
or | or | ||||
<entry xmlns="http://www.w3.org/2005/Atom" | <entry xmlns="http://www.w3.org/2005/Atom" | ||||
xmlns:codemeta="https://doi.org/10.5063/SCHEMA/CODEMETA-2.0"> | xmlns:codemeta="https://doi.org/10.5063/SCHEMA/CODEMETA-2.0"> | ||||
- **the url** representing the location of the source *MUST* be provided under | - **the name** of the software deposit *MUST* be provided [atom:title, | ||||
codemeta:name, dcterms:title] | |||||
- **the authors** of the software deposit *MUST* be provided | |||||
- **the url** representing the location of the source *MAY* be provided under | |||||
the url tag. The url will be used for creating an origin object in the | the url tag. The url will be used for creating an origin object in the | ||||
archive. | archive. | ||||
.. code:: xml | .. code:: xml | ||||
<url>www.url-example.com</url> | |||||
or | |||||
<codemeta:url>www.url-example.com</codemeta:url> | <codemeta:url>www.url-example.com</codemeta:url> | ||||
moranegg: erase, we keep only the codemeta option (but I haven't had the time to modify it myself) | |||||
Done Inline Actionskeep moranegg: keep | |||||
or | |||||
<dcterms:url>www.url-example.com</dcterms:url> | |||||
- **the external\_identifier** *MUST* be provided as an identifier | |||||
- **the name** of the software deposit *MUST* be provided [atom:title, | |||||
codemeta:name, dcterms:title] | |||||
Done Inline Actionserase (this does not mean we change the code, just the way we present what we want moranegg: erase (this does not mean we change the code, just the way we present what we want | |||||
- **the authors** of the software deposit *MUST* be provided | - **the external\_identifier** *MAY* be provided as an identifier | ||||
- **the external\_identifier** *SHOULD* match the Slug external-identifier in | - **the external\_identifier** *SHOULD* match the Slug external-identifier in | ||||
the header | the header | ||||
- **the description** of the software deposit *SHOULD* be provided | - **the description** of the software deposit *SHOULD* be provided | ||||
[codemeta:description]: short or long description of the software | [codemeta:description]: short or long description of the software | ||||
- **the license/s** of the software | - **the license/s** of the software | ||||
deposit *SHOULD* be provided [codemeta:license] | deposit *SHOULD* be provided [codemeta:license] | ||||
- other metadata *MAY* be added with terms defined by the schema in use. | - other metadata *MAY* be added with terms defined by the schema in use. | ||||
Examples | Examples | ||||
-------- | -------- | ||||
▲ Show 20 Lines • Show All 132 Lines • Show Last 20 Lines |
erase, we keep only the codemeta option (but I haven't had the time to modify it myself)