Skip to content

Commit 849f348

Browse files
authored
Improve Crosswalk page introduction and contribution instructions (#95)
* Improve Crosswalk page introduction and contribution instructions * Tidy list partial to make crosswalks list easier to understand
1 parent 52480d9 commit 849f348

File tree

3 files changed

+286
-26
lines changed

3 files changed

+286
-26
lines changed

content/crosswalk/_index.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,35 @@
11
---
22
title: "Crosswalks"
3-
#layout: single
3+
layout: list
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+
CodeMeta Crosswalks provide an explicit map between the fields of existing
7+
metadata standards, as used by a broad range of software repositories,
8+
registries, and archives. When mapped by a Crosswalk, CodeMeta's terms act as
9+
a common set of properties, providing a pathway for metadata to be translated
10+
between standards.
711

8-
## Contribute!
12+
Crosswalks are not required to have a one-to-one mapping for every field.
13+
Because Crosswalks only map fields common between a standard and CodeMeta, the
14+
subset of common fields may differ a lot between Crosswalks. The diagram below
15+
demonstrates how CodeMeta maps between standards when there are differences.
916

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).
17+
![Diagram of CodeMeta mapping between two metadata standards. It shows a common term, terms unique to each standard, and terms common to only CodeMeta and each standard.](/img/crosswalkdiagram.svg)
18+
19+
### Contribute!
20+
21+
CodeMeta encourages submissions of additional vocabularies. Refer to the
22+
[CodeMeta repository contribution guide](https://github.com/codemeta/codemeta?tab=contributing-ov-file#contributing-a-new-mapping)
23+
to submit a new Crosswalks.
24+
25+
Crosswalks are not automatically listed on this website.
26+
[The guide for contributing to this website](https://github.com/codemeta/codemeta.github.io?tab=contributing-ov-file#adding-new-crosswalks)
27+
explains how to set that up.
28+
29+
Please feel welcome to propose corrections or extensions in the [CodeMeta issues tracker](https://github.com/codemeta/codemeta/issues).
30+
31+
## Crosswalk directory
32+
33+
This directory contains many of the available Crosswalks. The full Crosswalk table is
34+
[available as a `.csv`](https://github.com/codemeta/codemeta/tree/master/crosswalk.csv)
35+
file in the CodeMeta repository.

static/img/crosswalkdiagram.svg

Lines changed: 224 additions & 0 deletions
Loading

themes/CodeMeta-Pyramids/layouts/partials/list.html

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,46 @@
77
</div>
88
{{end}}
99

10-
{{ with .Title }}<h1>{{ . }}</h1>{{ end }}
1110

1211
<!-- List pages can get Content and yaml metadata from an _index.md -->
1312
{{ with .Content }}<div class="article-style" itemprop="articleBody">{{ . }}</div>{{ end }}
1413

1514

1615
<div class="row">
17-
<div class="col-11">
16+
<table class="col-11">
1817
{{ range .Paginator.Pages }}
19-
<div class="article">
20-
<h2><a href="{{ .RelPermalink }}">{{if .Params.image }} <img alt="{{ substr .Params.image 5 -4 }} logo" src="{{ .Params.image }}" height="50px"/> {{ end }}{{ .Title }}</a></h2>
21-
</div>
18+
<tr class="article">
19+
<td class="col-2 p-2 text-center">
20+
{{if .Params.image }}
21+
<img style="height:auto;max-width:75px;" alt="{{ substr .Params.image 5 -4 }} logo" src="{{ .Params.image }}" height="50px"/>
22+
{{ end }}
23+
</td>
24+
<td>
25+
<h3><a href="{{ .RelPermalink }}">{{ .Title }}</a></h3>
26+
</td>
27+
</tr>
2228
{{ end }}
23-
</div>
29+
</table>
30+
31+
{{ if or (.Paginator.HasPrev) (.Paginator.HasNext) }}
32+
<nav class="mt-5">
33+
<table class="col-12">
34+
<tr class="pager">
35+
<td class="col-4 text-end">
36+
{{ if .Paginator.HasPrev }}
37+
<a href="{{ .Paginator.Prev.URL | relURL }}">&laquo; Previous</a>
38+
{{ end }}
39+
</td>
40+
<td class="col-4 text-center">
41+
{{ .Paginator.PageNumber }} of {{ .Paginator.TotalPages }}</td>
42+
<td class="col-4 text-start">
43+
{{ if .Paginator.HasNext }}
44+
<a href="{{ .Paginator.Next.URL | relURL }}">Next &raquo;</a>
45+
{{ end }}
46+
</td>
47+
</tr>
48+
</table>
49+
</nav>
50+
{{ end }}
2451

25-
26-
27-
{{ if or (.Paginator.HasPrev) (.Paginator.HasNext) }}
28-
<nav>
29-
<ul class="pager">
30-
{{ if .Paginator.HasPrev }}
31-
<li><a href="{{ .Paginator.Prev.URL | relURL }}">&laquo; Previous</a></li>
32-
{{ end }}
33-
{{ if .Paginator.HasNext }}
34-
<li><a href="{{ .Paginator.Next.URL | relURL }}">Next &raquo;</a></li>
35-
{{ end }}
36-
</ul>
37-
</nav>
38-
{{ end }}
39-
40-
<br />
4152
</div>

0 commit comments

Comments
 (0)