Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
853d99e
Add missing crosswalk intro
bact Oct 2, 2025
0d076e6
Update debian.md
bact Oct 2, 2025
6cde90d
Split Person and Thing terms into a separate table
bact Oct 3, 2025
39539b4
Update terms.md
bact Oct 3, 2025
b7cde91
Merge pull request #77 from bact/split-terms-table
moranegg Oct 6, 2025
a802fb8
Merge pull request #75 from bact/add-crosswalk-intro
moranegg Oct 6, 2025
b59c969
Add img/favicon.png (#78)
bact Oct 6, 2025
8dc6878
Add CodeMeta-Pyramids theme files
meldra Oct 7, 2025
f3b27db
Cut over to CodeMeta-Pyramids theme from hugo-material
meldra Oct 7, 2025
4f303d7
Removing the hugo-material theme as it is no longer needed.
meldra Oct 7, 2025
397152f
Removing duplicate/unnecessary css.
meldra Oct 7, 2025
c99178c
Restore material-kit js, needed for responsive navigation with tweaks
meldra Oct 9, 2025
cb4cea2
Tweak the nav js to cope with page refreshes
meldra Oct 9, 2025
34825f6
Add dark mode with toggler switch in nav.
meldra Oct 9, 2025
f660161
Make the dark mode js more robust (I hope)
meldra Oct 10, 2025
1214f1f
More darkmode js refactoring
meldra Oct 11, 2025
d21d122
Style tweaks; codeblocks now nicer in both modes
meldra Oct 13, 2025
0d8f4a8
Remove unneeded template login.html
meldra Oct 15, 2025
dd054c9
Add layout with custom TableOfContents in left sidebar
meldra Oct 15, 2025
4d37dfb
Add sidenav layout to terms, user-guide, developer-guide pages
meldra Oct 15, 2025
a665c4f
Move RSS links to a link (with icon) after the footer nav (supercedes…
meldra Oct 15, 2025
3b4a9b2
Add a partial for the supporter acknowledgements
meldra Oct 16, 2025
fbd4b95
Add a news partial for landing layout prep.
meldra Oct 16, 2025
9435b67
Add first round of changes for landing layout.
meldra Oct 16, 2025
06044a6
Swap index page to landing layout
meldra Oct 16, 2025
df0fd56
Add footer links per #83
meldra Oct 21, 2025
3600b0c
Add sidenav to additional pages
meldra Oct 21, 2025
f255450
Display tweaks for supporters section
meldra Oct 21, 2025
46be23c
Add some static news links for now
meldra Oct 22, 2025
11a694e
Make landing columns collapse to one on tiny screens
meldra Oct 22, 2025
aa8e9d5
Add buttons where crosswalks may be expected
meldra Oct 22, 2025
ee66491
Fix color contrast and link visual indicators for accessibility
meldra Oct 22, 2025
5f9d438
Add missing image alt and label text
meldra Oct 22, 2025
bd7e4ed
Add missing label for darkmode toggle
meldra Oct 22, 2025
a01d65c
Remove zoom prevention for accessibility
meldra Oct 22, 2025
257115d
Final (tm) sweep of accessibility tweaks
meldra Oct 22, 2025
37d24e2
Fix skip link alignment on tiny screens
meldra Oct 22, 2025
557bde4
Adjust skip id to h1 rather than subsequent content
meldra Oct 22, 2025
97f2fd9
Add missed non-colour visual indicators for main/footer navs
meldra Oct 22, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
27 changes: 17 additions & 10 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
theme = "hugo-material"
theme = "CodeMeta-Pyramids"
baseurl = "/"
relativeurls = true
title = "The CodeMeta Project"
Expand All @@ -7,7 +7,6 @@ disqusShortname = ""
ignoreFiles = ["\\.Rmd$", "_files$", "_cache$", "\\.csv", "\\.R"]
publishDir = "../website"


[[menu.main]]
name = "Home"
url = "/index.html"
Expand Down Expand Up @@ -41,24 +40,30 @@ publishDir = "../website"
url = "/tools"
weight = 8

[[menu.footer]]
name = "Source code on Github"
url = "https://github.com/codemeta/"
pre = "<i class='bi-github'></i>"
weight = 1
[[menu.footer]]
name = "Governance"
url = "https://codemeta.github.io/governance/"
weight = 2
[[menu.footer]]
name = "Scicodes Consortium"
url = "https://scicodes.net/"
weight = 3


[params]
name = "codemeta"
github = "codemeta"
custom_css = ["glyphicon.css"]
#custom_css = ["cboettig.css"]
repo = "codemeta.github.io"
background = "img/pyramids.jpg"

date_format = "Mon, Jan 2, 2006"
description = "A Rosetta Stone for Software Metadata"

# options for highlight.js (version, additional languages, and theme)
highlightjsVersion = "9.10.0"
highlightCDN = "//cdn.bootcss.com"
highlightjsLang = ["r", "yaml", "json"]
highlightjsTheme = "github"

[params.logo]
url = "logo.png"
width = 50
Expand All @@ -69,3 +74,5 @@ publishDir = "../website"
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
style = 'pygments'
9 changes: 1 addition & 8 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "The CodeMeta Project"
layout: landing
---

## Motivation
Expand All @@ -13,11 +14,3 @@ What metadata you want from software is determined by your use case. If your pr
Different software repositories, software languages and scientific domains denote this information in different ways, which makes it difficult or impossible for tools to work across these different sources without losing valuable information along the way. For instance, a fantastic collaboration between GitHub and figshare provides researchers a way to import software on the former into the persistent archive of the latter, getting a permanent identifier, a DOI in the process. To assign a DOI, figshare must then pass metadata about the object to DataCite, the central DOI provider for all repositories. While this makes DataCite a powerful aggregator, the lack of a crosswalk table means that much valuable metadata is currently lost along the way, such as the original software license, platform, and so forth. Any tool or approach working across software repositories faces similar challenges without a crosswalk table to translate between these.

For more detail, [visit the project on GitHub](https://github.com/codemeta/codemeta) or check back here soon.

## Special thanks to our supporters

<img width="50px" src="/img/nsf.jpg"/>
<img width="50px" src="/img/datacite.png"/>
<img width="50px" src="/img/github.png"/>
<img width="50px" src="/img/figshare.png"/>
<img width="50px" src="/img/zenodo.jpg"/>
2 changes: 1 addition & 1 deletion content/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Need to generate a CodeMeta compliant metadata file? Try out the [CodeMeta Gener

{{< rawhtml >}}
<a href="https://www.softwareheritage.org">
<img src="/img/swh-logo.png" style="height: 50px;"/> Software Heritage</a>
<img alt="Software Heritage logo" src="/img/swh-logo.png" style="height: 50px;"/> Software Heritage</a>
{{< /rawhtml >}}
4 changes: 1 addition & 3 deletions content/crosswalk/datacite.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
title: "Crosswalk for DataCite metadata"
image: "/img/datacite.png"
date: "2017-06-01"

---

<img src="/img/datacite.png" width="400" />

[DataCite](https://datacite.org/) metadata is a standardized set of schema used when registering a DOI to ensure research outputs are findable, citable, and connected within the global scholarly ecosystem.

{{< crosswalk name="DataCite" >}}
3 changes: 1 addition & 2 deletions content/crosswalk/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
title: "Crosswalk for Debian packages"
image: "/img/debian.png"
date: "2017-06-01"

---

The [Debian package system](https://www.debian.org/doc/manuals/debian-reference/ch02.en.html#_archive_meta_data) defines archive metadata that is used by the popular `apt` package management system on Debian and Ubuntu Linux distributions.
The [Debian package system](https://www.debian.org/doc/manuals/debian-reference/ch02.en.html#_archive_meta_data) defines archive metadata that is used by the popular [`apt`](https://wiki.debian.org/Apt) package management system on Debian and Ubuntu Linux distributions.

{{< crosswalk name="Debian Package" >}}
1 change: 0 additions & 1 deletion content/crosswalk/doap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ date: "2017-06-01"

[DOAP](https://github.com/ewilderj/doap) (Description of a Project) is an XML/RDF vocabulary to describe software projects, and in particular open source projects.


{{< crosswalk name="DOAP" >}}
1 change: 1 addition & 0 deletions content/crosswalk/dublincore.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Crosswalk for Dublin Core metadata"
image: "/img/dcmi.png"
---

[Dublin Core](https://www.dublincore.org/) vocabulary (or the Dublin Core Metadata Terms - DCMT) is a widely used, general-purpose metadata vocabulary for describing any type of resource.

{{< crosswalk name="Dublin Core" >}}
3 changes: 1 addition & 2 deletions content/crosswalk/figshare.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: "Crosswalk for figshare metadata"
image: "/img/figshare.jpg"
---

[figshare](https://figshare.com) is a general purpose scientific data repository that provides DataCite DOIs.

[figshare](https://figshare.com) is a general purpose scientific data repository that provides [DataCite](https://datacite.org/) DOIs.

{{< crosswalk name="Figshare" >}}
2 changes: 2 additions & 0 deletions content/crosswalk/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ image: "/img/github.png"
date: "2017-06-01"
---

[GitHub](https://github.com/) is a widely-used proprietary developer platform that allows users to store, manage, and share code using Git for distributed version control.

[GitHub API](https://docs.github.com/en/rest) provides a programmatic way to retrieve repository metadata.

{{< crosswalk name="GitHub" >}}
2 changes: 0 additions & 2 deletions content/crosswalk/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
title: "Crosswalk for Java's Maven metadata"
image: "/img/java.png"
date: "2017-06-01"

---

[Maven](https://maven.apache.org/what-is-maven.html) is a popular packaging/build system for Java-based projects.


{{< crosswalk name="Java (Maven)" >}}
5 changes: 3 additions & 2 deletions content/crosswalk/node.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: "Crosswalk for NodeJS package.json"
title: "Crosswalk for Node.js package.json"
image: "/img/npm.png"
date: "2017-06-01"
---

The `npm` package manager for NodeJS [defines](https://docs.npmjs.com/files/package.json) software metadata using a `package.json` file.
The `npm` package manager for JavaScript [defines](https://docs.npmjs.com/files/package.json) software metadata using a `package.json` file.

`npm` is the default package manager for the JavaScript runtime environment Node.js.

{{< crosswalk name="NodeJS" >}}
1 change: 0 additions & 1 deletion content/crosswalk/publiccode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: "Crosswalk for publiccode.yml"
image: "/img/publiccode.png"
date: "2025-08-10"

---

The [publiccode.yml](https://github.com/publiccodeyml/publiccode.yml) spec defines metadata for public sector OSS software projects, used by national and international catalogs to index, present, and facilitate the reuse of open source software developed by or for public administrations.
Expand Down
4 changes: 1 addition & 3 deletions content/crosswalk/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
title: "Crosswalk for Python distutils"
image: "/img/python.png"
date: "2017-06-01"

---

[Python `distutils`](https://docs.python.org/3.6/distutils/) allows users to associate a range of metadata information when packaging and distributing python-based applications or source code.

[Python `distutils`](https://docs.python.org/3.6/distutils/) allows users to associate a range of metadata information when packaging and distributing Python-based applications or source code.

{{< crosswalk name="Python Distutils (PyPI)" >}}
2 changes: 0 additions & 2 deletions content/crosswalk/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
title: "Crosswalk for Ruby gems"
image: "/img/ruby.png"
date: "2017-06-01"

---

Ruby gems [specify metadata](http://guides.rubygems.org/specification-reference/) in a `.gemspec` file.


{{< crosswalk name="Ruby Gem" >}}
5 changes: 3 additions & 2 deletions content/crosswalk/swo.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ image: "/img/swo.png"
date: "2017-01-05"
---

The [Software Ontology (SWO)](http://theswo.sourceforge.net/) is a resource for describing software tools, their types, tasks, versions, provenance and data associated. SWO is part of the JISC funded SWORD project (Software Ontology for Resource Description), an inter-disciplinary effort to capture software descriptions used in the preservation of data. The work is a collaboration between the European Bioinformatics Institute and the University of Manchester.

The [Software Ontology (SWO)](http://theswo.sourceforge.net/) is a resource for describing software tools, their types, tasks, versions, provenance and data associated.
SWO is part of the JISC funded [SWORD project](https://www.software.ac.uk/blog/sword-software-ontology-research-description) (Software Ontology for Resource Description), an inter-disciplinary effort to capture software descriptions used in the preservation of data.
The work is a collaboration between the European Bioinformatics Institute and the University of Manchester.

{{< crosswalk name="Software Ontology" >}}
2 changes: 1 addition & 1 deletion content/crosswalk/trove.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ title: "Crosswalk for Trove Software Map"
image: "/img/sourceforge.png"
---

[Trove Software Map](https://sourceforge.net/p/easyhtml5/tracinst/Software%20Map%20and%20Trove/#what-is-trove). Trove is the system used by SourceForge.net to classify software projects.
[Trove](https://web.archive.org/web/20240420104333/https://sourceforge.net/p/easyhtml5/tracinst/Software%20Map%20and%20Trove/#what-is-trove) is the system used by [SourceForge.net](https://sourceforge.net/) software development hosting platform to classify software projects.

{{< crosswalk name="Trove Software Map" >}}
5 changes: 3 additions & 2 deletions content/crosswalk/wikidata.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
title: "Crosswalk for WikiData Properties"
image: "/img/wikidata.png"
date: "2017-06-04"

---

[Wikidata](https://www.wikidata.org/wiki/Wikidata:Introduction) provides internationalized set of properties for machine-readable linked data. (Surprisingly wikidata does not have a native JSON-LD format, [distributing in plain json](https://www.wikidata.org/wiki/Wikidata:Database_download).)
[Wikidata](https://www.wikidata.org/wiki/Wikidata:Introduction) provides internationalized set of properties for machine-readable linked data.

Surprisingly Wikidata does not have a native JSON-LD format,
[distributing in plain JSON and RDF dumps](https://www.wikidata.org/wiki/Wikidata:Database_download).

{{< crosswalk name="Wikidata" >}}
3 changes: 0 additions & 3 deletions content/crosswalk/zenodo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Crosswalk for Zenodo metadata"
image: "/img/zenodo.jpg"
---



[Zenodo.org](https://zenodo.org) is a data archive based at CERN which is popularly used to archive and provide DOIs to academic software from GitHub, as described in the official GitHub guide to [Making your code citable](https://guides.github.com/activities/citable-code/).


{{< crosswalk name="Zenodo" >}}
1 change: 1 addition & 0 deletions content/developer-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: CodeMeta Developer Guide
layout: sidenav
---

This guide is intended for software developers who require detailed information about the CodeMeta project's
Expand Down
1 change: 1 addition & 0 deletions content/jsonld.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "The CodeMeta JSON-LD Representation"
layout: sidenav
---

CodeMeta uses JSON-LD to represent and translate between software metadata formats.
Expand Down
24 changes: 22 additions & 2 deletions content/terms.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,36 @@
---
title: CodeMeta Terms
layout: sidenav
---

## Terms from Schema.org

### Schema.org Software terms

Recognized properties for CodeMeta `SoftwareSourceCode` and `SoftwareApplication` includes the following terms from <https://schema.org>. These terms are part of the CodeMeta specification and can be used without any prefix.

{{< properties-description matchParentType="schema:(SoftwareSourceCode|SoftwareApplication|CreativeWork|Thing)">}}

These terms are all recognized properties of <https://schema.org/SoftwareSourceCode> or <https://schema.org/SoftwareApplication> Types. Note that while most properties take basic data types as values (`Text`, `URL`), several take other node types, such as `Person`, `Organization`, `Review`, or `Role`. Recommended fields for these node types in CodeMeta documents are given below.
These terms are all recognized properties of <https://schema.org/SoftwareSourceCode> or <https://schema.org/SoftwareApplication> Types.

Note that while most properties take basic data types as values (`Text`, `URL`), several take other node types, such as `Person`, `Organization`, `Review`, or `Role`.
Recommended fields for these node types in CodeMeta documents are given below.

### Schema.org Thing terms

{{< properties-description matchParentType="schema:(Thing)">}}

### Schema.org Person terms

{{< properties-description matchParentType="schema:(Person)">}}

### Schema.org Review terms

{{< properties-description matchParentType="schema:(Review)">}}

### Schema.org Role terms

{{< properties-description matchParentType="schema:(Person|Thing|Review|Role)">}}
{{< properties-description matchParentType="schema:(Role)">}}

## CodeMeta terms

Expand Down
1 change: 1 addition & 0 deletions content/tools.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tools
layout: sidenav
---

This page lists some existing tools to help with CodeMeta files.
Expand Down
3 changes: 2 additions & 1 deletion content/user-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: User guide
title: User Guide
layout: sidenav
---

## Generating a CodeMeta file
Expand Down
27 changes: 27 additions & 0 deletions data/supporters.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[
{
"name": "National Science Foundation",
"logo": "/img/nsf.jpg",
"url": "https://www.nsf.gov"
},
{
"name": "DataCite",
"logo": "/img/datacite.png",
"url": "https://datacite.org"
},
{
"name": "GitHub",
"logo": "/img/github.png",
"url": "https://github.com"
},
{
"name": "figshare",
"logo": "/img/figshare.png",
"url": "https://figshare.com"
},
{
"name": "Zenodo",
"logo": "/img/zenodo.jpg",
"url": "https://zenodo.org"
}
]
Loading