Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ publishDir = "../website"
repo = "codemeta.github.io"
background = "img/pyramids.jpg"
supported = [
'4.0.0',
'3.0.0',
'2.0.0'
]
Expand Down
6 changes: 4 additions & 2 deletions content/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,15 +170,17 @@ with greater ease, and assists with better pipelines for publishing software.

## Extending the CodeMeta Context

The most recent version of CodeMeta is {{% badge %}}

CodeMeta explicitly defines the terms it uses from <https://schema.org>, rather
than merely extending <https://schema.org> with a few additional terms. To use
additional terms from <https://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.1) with all terms available in schema.org,
For instance, to combine CodeMeta (v4.0) with all terms available in schema.org,
you would do:

```json
"@context": ["https://w3id.org/codemeta/3.1", "http://schema.org/"]
"@context": ["https://w3id.org/codemeta/4.0", "http://schema.org/"]
```

Note that the default context should be listed last.
Expand Down
3 changes: 2 additions & 1 deletion content/jsonld.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ JSON-LD lead developer Manu Sporny explains how JSON-LD works in this short clip

## The JSON-LD Context File

[![Permanent Identifier](https://img.shields.io/badge/perma--id-https%3A%2F%2Fw3id.org%2Fcodemeta%2F3.1-blue.svg)](https://w3id.org/codemeta/3.1)
{{% badge %}}

Context file of released versions:

- CodeMeta 4.0: <https://w3id.org/codemeta/4.0>
- CodeMeta 3.1: <https://w3id.org/codemeta/3.1>
- CodeMeta 3.0: <https://w3id.org/codemeta/3.0>
- CodeMeta 2.0: <https://doi.org/10.5063/schema/codemeta-2.0>
Expand Down
2 changes: 2 additions & 0 deletions content/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ The tables in this section contain tools for supported versions of CodeMeta.
Note: Tools marked with a warning symbol ( ⚠️ ) are not known to support the *latest version* of CodeMeta.
{.tip}

The most recent version of CodeMeta is {{% badge %}}

These tools are categorised according to the context they can be used. In many cases a tool belongs to multiple categories and will be listed multiple times on this page.

{{% tools %}}
Expand Down
24 changes: 16 additions & 8 deletions content/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ individual is the `maintainer` of the software being described, like this:

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"@type": "SoftwareSourceCode",
"name": "CodemetaR",

Expand All @@ -174,7 +174,7 @@ This means the previous example is equivalent to:

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"@type": "SoftwareSourceCode",
"name": "CodemetaR",

Expand Down Expand Up @@ -202,7 +202,7 @@ object:

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"@type": "SoftwareSourceCode",
"name": "CodemetaR"
}
Expand All @@ -213,7 +213,7 @@ SoftwareApplication:

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"@type": "SoftwareSourceCode",
"name": "CodemetaR",

Expand All @@ -229,7 +229,7 @@ application:

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"@type": "SoftwareSourceCode",
"name": "CodemetaR",

Expand Down Expand Up @@ -264,7 +264,7 @@ of the document has changed. It is *_not_* equivalent to the code above.

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"@type": "SoftwareSourceCode",
"name": "CodemetaR",

Expand All @@ -286,6 +286,8 @@ represented as the `"url"` of `rmarkdown`, instead of being the url of

## Context

The most recent version of CodeMeta is {{% badge %}}

Every CodeMeta document must refer to the context file `codemeta.jsonld`, for
example via a URL. This indicates that all terms in the document should be
interpreted in the "context" of CodeMeta.
Expand Down Expand Up @@ -321,7 +323,7 @@ of the CodeMeta schema in order to refer to the appropriate context file.
For example, use the following for the latest release:

```json
"@context": "https://w3id.org/codemeta/3.1"
"@context": "https://w3id.org/codemeta/4.0"
```

## Attributions
Expand Down Expand Up @@ -452,6 +454,9 @@ under `author` or `contributor`. The example below demonstrates the `id` and

[Full example](https://github.com/oss-slu/Pi4Micronaut/blob/de4305bec9afe7f7c948e9cc97b9105fd55121f7/codemeta.json).

Note: The above real-world example is using a specific version of CodeMeta. It may not be the correct version for you. Refer to [the tools tables](/tools) to check for compatibility with the tools you use.
{.tip}

### Organizations

The properties listed in the [terms](/terms) tables with a type `Organization`
Expand Down Expand Up @@ -487,7 +492,7 @@ root of a code repository:

```json
{
"@context": "https://w3id.org/codemeta/3.1",
"@context": "https://w3id.org/codemeta/4.0",
"type": "SoftwareSourceCode",
"applicationCategory": "Biology",
"codeRepository": "https://github.com/gem-pasteur/macsyfinder",
Expand All @@ -505,6 +510,9 @@ root of a code repository:

([Link to full example](https://github.com/gem-pasteur/macsyfinder/blob/69c22b065065105e6c5ac8dcbff00a804a0a34fc/codemeta.json)).

Note: The above real-world example is using a specific version of CodeMeta. It may not be the correct version for you. Refer to [the tools tables](/tools) to check for compatibility with the tools you use.
{.tip}

## Referencing CodeMeta

All versions, including release candidates, may be referred to consistently
Expand Down
2 changes: 2 additions & 0 deletions layouts/shortcodes/badge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{{ $supported := .Site.Params.supported }}{{ $latest := $supported | sort | collections.Reverse }}{{ $latest := index $latest 0 }}
[![Permanent Identifier](https://img.shields.io/badge/perma--id-https%3A%2F%2Fw3id.org%2Fcodemeta%2F{{ substr $latest 0 3 }}-blue.svg)](https://w3id.org/codemeta/{{ substr $latest 0 3 }})
Loading