Changeset View
Changeset View
Standalone View
Standalone View
docs/metadata.rst
Show All 30 Lines | |||||
- **the authors** of the software deposit *MUST* be provided | - **the authors** of the software deposit *MUST* be provided | ||||
- **the url** representing the location of the source *MAY* be provided under | - **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 | ||||
<codemeta:url>www.url-example.com</codemeta:url> | <codemeta:url>http://example.com/my_project</codemeta:url> | ||||
- **the create\_origin** tag *SHOULD* be used to specify the URL of the origin | |||||
to create (otherwise, a fallback is created using the slug, or a random | |||||
string if missing) | |||||
- **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 | ||||
-------- | -------- | ||||
Using only Atom | Using only Atom | ||||
~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~ | ||||
.. code:: xml | .. code:: xml | ||||
<?xml version="1.0"?> | <?xml version="1.0"?> | ||||
<entry xmlns="http://www.w3.org/2005/Atom"> | <entry xmlns="http://www.w3.org/2005/Atom" | ||||
xmlns:swhdeposit="https://www.softwareheritage.org/schema/2018/deposit"> | |||||
<title>Awesome Compiler</title> | <title>Awesome Compiler</title> | ||||
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> | <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> | ||||
<updated>2017-10-07T15:17:08Z</updated> | <updated>2017-10-07T15:17:08Z</updated> | ||||
<author>some awesome author</author> | <author>some awesome author</author> | ||||
<swhdeposit:deposit> | |||||
<swhdeposit:create_origin> | |||||
<swhdeposit:origin url="http://example.com/my_project" /> | |||||
</swhdeposit:create_origin> | |||||
</swhdeposit:deposit> | |||||
</entry> | </entry> | ||||
Using Atom with CodeMeta | Using Atom with CodeMeta | ||||
~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||||
.. code:: xml | .. code:: xml | ||||
<?xml version="1.0"?> | <?xml version="1.0"?> | ||||
<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" | ||||
xmlns:swhdeposit="https://www.softwareheritage.org/schema/2018/deposit"> | |||||
<title>Awesome Compiler</title> | <title>Awesome Compiler</title> | ||||
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> | <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> | ||||
<swhdeposit:deposit> | |||||
<swhdeposit:create_origin> | |||||
<swhdeposit:origin url="http://example.com/1785io25c695" /> | |||||
</swhdeposit:create_origin> | |||||
</swhdeposit:deposit> | |||||
<codemeta:id>1785io25c695</codemeta:id> | <codemeta:id>1785io25c695</codemeta:id> | ||||
<codemeta:url>origin url</codemeta:url> | <codemeta:url>origin url</codemeta:url> | ||||
<codemeta:identifier>other identifier, DOI, ARK</codemeta:identifier> | <codemeta:identifier>other identifier, DOI, ARK</codemeta:identifier> | ||||
<codemeta:applicationCategory>Domain</codemeta:applicationCategory> | <codemeta:applicationCategory>Domain</codemeta:applicationCategory> | ||||
<codemeta:description>description</codemeta:description> | <codemeta:description>description</codemeta:description> | ||||
<codemeta:keywords>key-word 1</codemeta:keywords> | <codemeta:keywords>key-word 1</codemeta:keywords> | ||||
<codemeta:keywords>key-word 2</codemeta:keywords> | <codemeta:keywords>key-word 2</codemeta:keywords> | ||||
▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Lines | |||||
Using Atom with DublinCore and CodeMeta (multi-schema entry) | Using Atom with DublinCore and CodeMeta (multi-schema entry) | ||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||
.. code:: xml | .. code:: xml | ||||
<?xml version="1.0"?> | <?xml version="1.0"?> | ||||
<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/" | ||||
xmlns:codemeta="https://doi.org/10.5063/SCHEMA/CODEMETA-2.0"> | xmlns:codemeta="https://doi.org/10.5063/SCHEMA/CODEMETA-2.0" | ||||
xmlns:swhdeposit="https://www.softwareheritage.org/schema/2018/deposit"> | |||||
<title>Awesome Compiler</title> | <title>Awesome Compiler</title> | ||||
<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> | <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> | ||||
<swhdeposit:deposit> | |||||
<swhdeposit:create_origin> | |||||
<swhdeposit:origin url="http://example.com/225c695-cfb8-4ebb-aaaa-80da344efa6a" /> | |||||
</swhdeposit:create_origin> | |||||
<swhdeposit:deposit> | |||||
<dcterms:identifier>hal-01587361</dcterms:identifier> | <dcterms:identifier>hal-01587361</dcterms:identifier> | ||||
<dcterms:identifier>doi:10.5281/zenodo.438684</dcterms:identifier> | <dcterms:identifier>doi:10.5281/zenodo.438684</dcterms:identifier> | ||||
<dcterms:title xml:lang="en">The assignment problem</dcterms:title> | <dcterms:title xml:lang="en">The assignment problem</dcterms:title> | ||||
<dcterms:title xml:lang="fr">AffectationRO</dcterms:title> | <dcterms:title xml:lang="fr">AffectationRO</dcterms:title> | ||||
<dcterms:creator>author</dcterms:creator> | <dcterms:creator>author</dcterms:creator> | ||||
<dcterms:subject>[INFO] Computer Science [cs]</dcterms:subject> | <dcterms:subject>[INFO] Computer Science [cs]</dcterms:subject> | ||||
<dcterms:subject>[INFO.INFO-RO] Computer Science [cs]/Operations Research [cs.RO]</dcterms:subject> | <dcterms:subject>[INFO.INFO-RO] Computer Science [cs]/Operations Research [cs.RO]</dcterms:subject> | ||||
<dcterms:type>SOFTWARE</dcterms:type> | <dcterms:type>SOFTWARE</dcterms:type> | ||||
Show All 36 Lines |