Skip to content

Commit e1a3561

Browse files
bactherrboyer
authored andcommitted
Tidy up pages
- Put missing title metadata to pages - Update developer guide to use v3 context file - Update User guide to use v3 context file (by @herrboyer) - Update JSON-LD page to use v3 context file (by @herrboyer) - Update Python versions for tools in Tools (by @herrboyer) - Sort entries in table - Sort column names in tables "File Generation" and "Integrations" to be the same order - Fix small case "codemeta" to "CodeMeta" Co-Authored-By: Renaud Boyer <[email protected]>
1 parent a3cc7be commit e1a3561

File tree

9 files changed

+74
-67
lines changed

9 files changed

+74
-67
lines changed

content/create.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: "Create a CodeMeta file"
33
#layout: login
44
---
55

6-
Need to generate a CodeMeta compliant metadata file? Try out the [CodeMeta Generator](https://codemeta.github.io/codemeta-generator), which was created by the folks at [Software Heritage](https://www.softwareheritage.org).
7-
6+
Need to generate a CodeMeta compliant metadata file? Try out the [CodeMeta Generator](https://codemeta.github.io/codemeta-generator), which was created by the folks at [Software Heritage](https://www.softwareheritage.org).
87

98
{{< rawhtml >}}
109
<a href="https://www.softwareheritage.org">

content/crosswalk/R.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ image: "/img/R.png"
44
date: "2017-06-01"
55
---
66

7-
The following table displays the crosswalk mapping of terms from the R package DESCRIPTION file to codemeta properties.
7+
The following table displays the crosswalk mapping of terms from the R package DESCRIPTION file to CodeMeta properties.
88

99
{{< crosswalk name="R Package Description" >}}

content/crosswalk/_index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ title: "Crosswalks"
33
#layout: single
44
---
55

6-
The codemeta crosswalk provides an explicit map between the metadata fields used by a broad range of software repositories, registries and archives. Here are the currently available mappings from existing standards into CodeMeta properties. Mapping onto a common set of properties should facilitate translation between any two crosswalked standards. The full crosswalk table is [available as a `.csv`](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv) file on the CodeMeta repository.
6+
The CodeMeta crosswalk provides an explicit map between the metadata fields used by a broad range of software repositories, registries and archives. Here are the currently available mappings from existing standards into CodeMeta properties. Mapping onto a common set of properties should facilitate translation between any two crosswalked standards. The full crosswalk table is [available as a `.csv`](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv) file on the CodeMeta repository.
77

88
## Contribute!
99

10-
CodeMeta encourages submissions of additional vocabularies by making Pull Requests against the [full crosswalk table](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv). Feel free to propose corrections or extensions in the [codemeta issues tracker](https://github.com/codemeta/codemeta/issues).
11-
10+
CodeMeta encourages submissions of additional vocabularies by making Pull Requests against the [full crosswalk table](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv). Feel free to propose corrections or extensions in the [CodeMeta issues tracker](https://github.com/codemeta/codemeta/issues).

content/developer-guide.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
2-
# CodeMeta Developer Guide
1+
---
2+
title: CodeMeta Developer Guide
3+
---
34

45
This guide is intended for software developers who require detailed information about the CodeMeta project's
56
usage of JavaScript Object Notation for Linked Data ([JSON-LD](http://json-ld.org/)) for defining a
@@ -28,7 +29,7 @@ The JSON-LD [Best Practices guide](http://json-ld.org/spec/latest/json-ld-api-be
2829
> Linked Data is a way to create a network of standards-based machine interpretable data
2930
> across different documents and Web sites. It allows an application to start at one piece of Linked
3031
> Data, and follow embedded links to other pieces of Linked Data that are hosted on different
31-
> sites across the Web."
32+
> sites across the Web.
3233
3334
JSON-LD is a W3C standard, specified at https://www.w3.org/TR/json-ld/
3435

@@ -43,11 +44,11 @@ A CodeMeta software description, or *CodeMeta document*, uses the JSON names con
4344
Because the CodeMeta document refers to the context file, the mapping between the local JSON names and the
4445
IRIs is always known, thereby giving the local names universal context.
4546

46-
An example usage of the CodeMeta document is for the author of research software package to generate a CodeMeta Document when the software package is published to a repository. The CodeMeta Document can be used to aid in any repository ingest processing. The CodeMeta Document can be made available in the repository with the software package as it may contain additional metadata that was not used by the repository. In addition this file may be used in other transactions involving the software package after the package has been downloaded from the repository.
47+
An example usage of the CodeMeta document is for the author of research software package to generate a CodeMeta Document when the software package is published to a repository. The CodeMeta Document can be used to aid in any repository ingest processing. The CodeMeta Document can be made available in the repository with the software package as it may contain additional metadata that was not used by the repository. In addition this file may be used in other transactions involving the software package after the package has been downloaded from the repository.
4748

48-
The producer of an CodeMeta Document, i.e. the creators of the software, must use the JSON names from the CodeMeta context file. The consumer of the CodeMeta Document can use these same JSON names from the CodeMeta Document for any necessary processing tasks.
49+
The producer of an CodeMeta Document, i.e. the creators of the software, must use the JSON names from the CodeMeta context file. The consumer of the CodeMeta Document can use these same JSON names from the CodeMeta Document for any necessary processing tasks.
4950

50-
As an alternative to using the producer supplied JSON names, the consumer can use the [JSON-LD API](https://www.w3.org/TR/json-ld-api/) to translate the JSON names to their own local JSON names that may be in use by their local processing scripts. This is done by first using the JSON-LD *expand* function that replaces each JSON name in the CodeMeta Document with it's corresponding IRI from the CodeMeta context file. For example, the producer's CodeMeta Document may contain the following line:
51+
As an alternative to using the producer supplied JSON names, the consumer can use the [JSON-LD API](https://www.w3.org/TR/json-ld-api/) to translate the JSON names to their own local JSON names that may be in use by their local processing scripts. This is done by first using the JSON-LD *expand* function that replaces each JSON name in the CodeMeta Document with it's corresponding IRI from the CodeMeta context file. For example, the producer's CodeMeta Document may contain the following line:
5152

5253
```json
5354
"codeRepository": "https://github.com/DataONEorg/rdataone"
@@ -59,7 +60,7 @@ Using the JSON-LD API *expand* function, this is converted to:
5960
"http://schema.org/codeRepository": "https://github.com/DataONEorg/rdataone"
6061
```
6162

62-
Next, the consumer can use their own context file that maps from each IRI to their own local JSON names. For example, the consumer may have a context that maps the local JSON name 'repository' (as in `package.json` documents used by NPM, see [/crosswalk/node/]) to "http://schema.org/codeRepository", so using the JSON API *compact* function would result in a new CodeMeta Document with the entry:
63+
Next, the consumer can use their own context file that maps from each IRI to their own local JSON names. For example, the consumer may have a context that maps the local JSON name 'repository' (as in `package.json` documents used by NPM, see [/crosswalk/node/]) to "http://schema.org/codeRepository", so using the JSON API *compact* function would result in a new CodeMeta Document with the entry:
6364

6465
```json
6566
"repository": "https://github.com/DataONEorg/rdataone"
@@ -84,10 +85,10 @@ Tools will be created that assist in the generation of CodeMeta documents. For e
8485

8586
## Extending the CodeMeta Context
8687

87-
CodeMeta explicitly defines the terms it uses from <http://schema.org>, rather than merely extending <http://schema.org> with a few additional terms. To use additional terms from <http://schema.org> not listed on the [terms page](/terms/) (or terms from any other context), you must extend your context appropriately. For instance, to combine codemeta (v2.0-rc) with all terms available in schema.org, you would do:
88+
CodeMeta explicitly defines the terms it uses from <http://schema.org>, rather than merely extending <http://schema.org> with a few additional terms. To use additional terms from <http://schema.org> not listed on the [terms page](/terms/) (or terms from any other context), you must extend your context appropriately. For instance, to combine CodeMeta (v3.0) with all terms available in schema.org, you would do:
8889

8990
```json
90-
"@context": ["https://raw.githubusercontent.com/codemeta/codemeta/2.0-rc/codemeta.jsonld", "http://schema.org/"]
91+
"@context": ["https://w3id.org/codemeta/3.0", "http://schema.org/"]
9192
```
9293

9394
Note the default context should be listed last.

content/examples.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
---
22
title: Examples
33
---
4-

content/jsonld.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22
title: "The CodeMeta JSON-LD Representation"
33
---
44

5-
6-
CodeMeta uses JSON-LD to represent and translate between software metadata formats. JSON-LD lead developer Manu Sporny explains how JSON-LD works in this short clip:
7-
5+
CodeMeta uses JSON-LD to represent and translate between software metadata formats.
6+
JSON-LD lead developer Manu Sporny explains how JSON-LD works in this short clip:
87

98
{{< youtube Tm3fD89dqRE >}}
109

11-
12-
1310
## The JSON-LD Context File
1411

15-
The current codemeta context file can be found at [![DOI](https://img.shields.io/badge/doi%3A-10.5063%2FSCHEMA%2FCODEMETA--2.0-blue.svg)](https://doi.org/10.5063/schema/codemeta-2.0)
16-
17-
18-
19-
CodeMeta properties are built on and extend software properties from <https://schema.org>. A list of all properties provided by the current CodeMeta `context` file can be found on the [terms](/terms) page. Here's an example [codemeta.json file](https://github.com/codemeta/codemetar/blob/master/codemeta.json) for the `codemetar` R package.
12+
[![W3IDCodeMeta v3](https://img.shields.io/badge/W3ID-CodeMeta_v3-blue)](https://w3id.org/codemeta/3.0)
2013

21-
## Compaction & expansion examples:
14+
The current CodeMeta context file can be found at[`https://w3id.org/codemeta/3.0`](https://w3id.org/codemeta/3.0).
2215

16+
CodeMeta properties are built on and extend software properties from
17+
<https://schema.org>.
18+
A list of all properties provided by the current CodeMeta `context` file can be
19+
found on the [terms](/terms) page. Here's an example
20+
[codemeta.json file](https://github.com/gem-pasteur/macsyfinder/blob/master/codemeta.json)
21+
for the `gem-pasteur/macsyfinder` project.

content/terms.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,4 @@ The CodeMeta project also introduces the following additional properties, which
1818

1919
{{< properties-description matchParentType="codemeta:">}}
2020

21-
22-
Please suggest additional terms or adjustments to this representation in the [codemeta issues](https://github.com/codemeta/codemeta/issues)
21+
Please suggest additional terms or adjustments to this representation in the [CodeMeta issues](https://github.com/codemeta/codemeta/issues).

content/tools.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
1-
# Tools
1+
---
2+
title: Tools
3+
---
24

3-
This page lists some existing tools to help with CodeMeta files
5+
This page lists some existing tools to help with CodeMeta files.
46

57
## File Generation
68

7-
Some of the early tools still need a little updating to use the latest version of the codemeta context.
9+
Some of the early tools still need a little updating to use the latest version of the CodeMeta context.
810

911
{.table .table-striped}
1012

11-
tool | language | codemeta version | maintainer | notes
12-
-----|----------|------------------|------------|--------------
13-
[CodeMeta file generator](https://gist.github.com/arfon/478b2ed49e11f984d6fb) | Ruby | 0.1.0 | [arfon](http://github.com/arfon) | (no support for current schema)
14-
[Bolognese](https://github.com/datacite/bolognese) | Ruby | 1.0.0 | [mfenner](https://github.com/mfenner) | primarily a tool for conversion between formats provided by DataCite, including codemeta and schema.org
15-
[codemetar](https://ropensci.github.io/codemetar) | R | 2.0.0 | [cboettig](https://github.com/cboettig) | Generate codemeta for R packages; + generic codemeta manipulation
16-
[codemetapy](https://github.com/proycon/codemetapy) | Python | 2.0.0 | [proycon](https://github.com/proycon) | Generate codemeta for Python, NodeJS, Java packages and others; + generic codemeta manipulation
17-
[tributors](https://con.github.io/tributors/) | Python | 2.0.0 | [vsoch](https://github.com/vsoch) | Generate codemeta contributors section from GitHub API and Orcid API
13+
Name | Language | CodeMeta versions | Maintainers | Description
14+
-----|----------|-------------------|------------|--------------
15+
[AutoCodemeta Generator](https://w3id.org/autocodemeta) | JavaScript | 3.0.0 | [dgarijo](http://github.com/dgarijo) | Optimized version of CodeMeta Generator that automatically creates a CodeMeta file from a given repository
16+
[Bolognese](https://github.com/datacite/bolognese) | Ruby | 1.0.0 | [mfenner](https://github.com/mfenner) | Primarily a tool for conversion between formats provided by DataCite, including CodeMeta and schema.org
1817
[cff-converter](https://github.com/citation-file-format/cff-converter-python) | Python | 2.0.0 | [jspaaks](https://github.com/jspaaksh) | Convert `CITATION.cff` files to codemeta
19-
[CodeMeta generator](https://codemeta.github.io/codemeta-generator/) | Javascript | 2.0.0 | [ProgVal](https://github.com/ProgVal) | Online form to create or complete a codemeta file
20-
[codemeta-harvester](https://github.com/proycon/codemeta-harvester) | POSIX Shell | 2.0.0 | [proycon](https://github.com/proycon) | Automatic software metadata conversion pipeline that uses codemetapy and other tools
21-
[codemeta-server](https://github.com/proycon/codemeta-server) | Python | 2.0.0 | [proycon](https://github.com/proycon) | Webservice offering an API (including SPARQL) and simple human web-interface so search and browse software metadata
22-
[openCARP-CI](https://opencarp.org/CI) | Python | openCARP developers | GitLab CI pipelines including the conversion from CodeMeta to other formats (Citation File Format (CFF), DataCite, BagIt and BagPack)
23-
[AutoCodemeta Generator](https://w3id.org/autocodemeta) | Javascript | 3.0.0 | [dgarijo](http://github.com/dgarijo) | Optimized version of CodeMeta Generator that automatically creates a codemeta file from a given repository
24-
[Somef](https://github.com/KnowledgeCaptureAndDiscovery/somef) | Python | OEG developers | [dgarijo](http://github.com/dgarijo) | Tool that automatically extracts software metadata from repositories and scientific publications.
18+
[CodeMeta file generator](https://gist.github.com/arfon/478b2ed49e11f984d6fb) | Ruby | 0.1.0 | [arfon](http://github.com/arfon) | (no support for current schema)
19+
[CodeMeta generator](https://codemeta.github.io/codemeta-generator/) | JavaScript | 2.0.0, 3.0.0 | [ProgVal](https://github.com/ProgVal) | Online form to create or complete a CodeMeta file
20+
[codemeta-harvester](https://github.com/proycon/codemeta-harvester) | POSIX Shell | 2.0.0, 3.0.0 | [proycon](https://github.com/proycon) | Automatic software metadata conversion pipeline that uses codemetapy and other tools
21+
[codemeta-server](https://github.com/proycon/codemeta-server) | Python | 2.0.0, 3.0.0 | [proycon](https://github.com/proycon) | Webservice offering an API (including SPARQL) and simple human web-interface so search and browse software metadata
22+
[codemetapy](https://github.com/proycon/codemetapy) | Python | 2.0.0, 3.0.0 | [proycon](https://github.com/proycon) | Generate CodeMeta for Python, NodeJS, Java packages and others; + generic CodeMeta manipulation
23+
[codemetar](https://ropensci.github.io/codemetar) | R | 2.0.0 | [cboettig](https://github.com/cboettig) | Generate CodeMeta for R packages; + generic CodeMeta manipulation
24+
[openCARP-CI](https://opencarp.org/CI) | Python | 2.0.0| [openCARP developers](https://opencarp.org/) | GitLab CI pipelines including the conversion from CodeMeta to other formats (Citation File Format (CFF), DataCite, BagIt and BagPack)
25+
[Somef](https://github.com/KnowledgeCaptureAndDiscovery/somef) | Python | OEG developers | [dgarijo](http://github.com/dgarijo) | Tool that automatically extracts software metadata from repositories and scientific publications
26+
[tributors](https://con.github.io/tributors/) | Python | 2.0.0 | [vsoch](https://github.com/vsoch) | Generate CodeMeta contributors section from GitHub API and ORCID API
2527

2628
## Integrations
2729

28-
Integrations indicate existing platforms & services which understand CodeMeta descriptions. These do not provide a user-facing software tool for generating codemeta.json, but can ingest
30+
Integrations indicate existing platforms & services which understand CodeMeta descriptions.
31+
These do not provide a user-facing software tool for generating codemeta.json, but can ingest
2932
existing codemeta.json files automatically.
3033

3134
{.table .table-striped}
3235

33-
Name | Description | Authors | Language | CodeMeta Version
36+
Name | Language | CodeMeta versions | Maintainers | Description
3437
-----|-------------|----------|----------|--------------------
35-
[Fidgit](https://github.com/arfon/fidgit): | An ungodly union of GitHub and Figshare | Arfon Smith, Kaitlin Thaney, Mark Hahnel | Ruby | 0.1.0
36-
[Software Heritage](https://docs.softwareheritage.org/devel/swh-indexer/metadata-workflow.html#adding-support-for-additional-ecosystem-specific-metadata)|The metadata indexers | SWH team | Python | 2.0
38+
[Fidgit](https://github.com/arfon/fidgit) | Ruby | 0.1.0 | Arfon Smith, Kaitlin Thaney, Mark Hahnel | An ungodly union of GitHub and Figshare
39+
[Software Heritage](https://docs.softwareheritage.org/devel/swh-indexer/metadata-workflow.html#adding-support-for-additional-ecosystem-specific-metadata) | Python | 2.0 | SWH team | The metadata indexers
3740

3841
Pending:
3942

0 commit comments

Comments
 (0)