Skip to content

Commit 25568e3

Browse files
committed
Changes for Context and Referencing sections
1 parent 7e5bae7 commit 25568e3

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

content/user-guide.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -310,15 +310,15 @@ root of a code repository:
310310

311311
## The context
312312

313-
Every CodeMeta document must refer to the context file *codemeta.jsonld*, for
313+
Every CodeMeta document must refer to the context file `codemeta.jsonld`, for
314314
example via a URL. This indicates that all terms in the document should be
315315
interpreted in the "context" of CodeMeta.
316316

317317
Most terms are chosen to match the equivalent terms in <http://schema.org>,
318318
but CodeMeta provides a few additional terms not found in <http://schema.org>
319319
which may be helpful for software projects.
320320

321-
CodeMeta also restricts the context to use only those <https://schema.org>
321+
CodeMeta also restricts the context to use only those <http://schema.org>
322322
terms that are explicitly listed on the [terms](/terms/) page. Users wanting
323323
to include additional terms may:
324324

@@ -329,21 +329,25 @@ as `"schema:releaseNotes"` [in this example](https://github.com/SciCodes/somef-c
329329
The context file may be modified and updated in the future, if new JSON
330330
properties are added or existing ones modified.
331331

332-
The CodeMeta GitHub repository defines tags to allow specific versions of a
333-
file to be referenced, and assigns *digital object identifiers*, or DOIs, to
334-
each release tag. Please use the
335-
[appropriate release](https://github.com/codemeta/codemeta/releases) of the
336-
CodeMeta schema in order to refer to the appropriate context file, e.g.
332+
The CodeMeta GitHub repository [defines tags](https://github.com/codemeta/codemeta/tags)
333+
to allow specific versions of a file to be referenced, and assigns permanant
334+
identifiers for each release tag. Early releases used Digital Object
335+
Identifiers (DOIs), and recent releases use W3IDs. Please use the
336+
[appropriate release](https://github.com/codemeta/codemeta/releases)
337+
of the CodeMeta schema in order to refer to the appropriate context file.
338+
339+
For example, use the following for the latest release:
337340

338341
```json
339342
"@context": "https://w3id.org/codemeta/3.1"
340343
```
341344

342345
## Referencing CodeMeta
343346

344-
Release candidate versions may be referred to consistently using their
345-
[git tag](https://github.com/codemeta/codemeta/tags) for the raw version, e.g.
346-
<https://raw.githubusercontent.com/codemeta/codemeta/2.0-rc/codemeta.jsonld>.
347+
All versions, including release candidates, may be referred to consistently
348+
using their [git tag](https://github.com/codemeta/codemeta/tags) for the raw
349+
version, e.g. <https://raw.githubusercontent.com/codemeta/codemeta/2.0-rc/codemeta.jsonld>.
350+
347351
*Please do not refer to the raw GitHub URL for the master branch*, as this is
348352
subject to change and will not guarantee a stable metadata file.
349-
353+
{.warning}

0 commit comments

Comments
 (0)