Skip to content

Commit

Permalink
Update docs to Components.js v6
Browse files Browse the repository at this point in the history
  • Loading branch information
rubensworks committed Mar 4, 2024
1 parent f1e7abf commit 3e73aba
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/general.md
Expand Up @@ -53,6 +53,6 @@ The following vocabularies are understood by Components.js:
| owl | http://www.w3.org/2002/07/owl# |
| xsd | http://www.w3.org/2001/XMLSchema# |

If the JSON-LD serialization is used, shortcuts can be used for most of the URLs using Components.js's context: [https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld](https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld)
If the JSON-LD serialization is used, shortcuts can be used for most of the URLs using Components.js's context: [https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld](https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld)

These vocabularies will be referenced by their prefix and JSON-LD shortcut in the following sections.
2 changes: 1 addition & 1 deletion docs/configuration/modules.md
Expand Up @@ -20,7 +20,7 @@ Modules can be configured using the following type and predicates:
A module can be defined as follows:
```json
{
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
"@id": "http://example.org/MyModule",
"@type": "Module",
"requireName": "my-module",
Expand Down
10 changes: 5 additions & 5 deletions docs/getting_started/basics/workflow_js.md
Expand Up @@ -16,7 +16,7 @@ As we only define a module here, no dependency on Components.js needs to be adde
The contents of a module file looks as follows:
```json
{
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
"@id": "http://example.org/MyModule",
"@type": "Module",
"requireName": "my-module"
Expand All @@ -35,7 +35,7 @@ The contents of a module file looks as follows:

{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
{ "ex": "http://example.org/" }
],
"@id": "ex:MyModule",
Expand Down Expand Up @@ -71,7 +71,7 @@ Following the module from last section, the contents of a components file looks
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
{ "ex": "http://example.org/" }
],
"@id": "ex:MyModule",
Expand Down Expand Up @@ -112,7 +112,7 @@ but when multiple components are available, separate files for each component sh
When separate component files are created, they must be included in the main module file as follows:
```json
{
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"@context": "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
"@id": "http://example.org/MyModule",
...
"import": [
Expand Down Expand Up @@ -141,7 +141,7 @@ These can look as follows:
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
{ "ex": "http://example.org/" }
],
"@id": "ex:myInstance",
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/basics/workflow_ts.md
Expand Up @@ -100,7 +100,7 @@ These can look as follows:
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/my-package/^2.0.0/components/context.jsonld"
{ "ex": "http://example.org/" }
],
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Expand Up @@ -89,7 +89,7 @@ export class MyClass {
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/my-package/^2.0.0/components/context.jsonld"
],
"@id": "urn:my-package:myInstance",
Expand Down Expand Up @@ -147,7 +147,7 @@ export class MyClass {
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
{ "ex": "http://example.org/" }
],
"@id": "ex:MyPackage",
Expand Down Expand Up @@ -179,7 +179,7 @@ The constructor of `MyClass` takes a single `name` argument.
```json
{
"@context": [
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
"https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
{
"ex": "http://example.org/",
"name": "ex:MyPackage/MyClass#name"
Expand Down

0 comments on commit 3e73aba

Please sign in to comment.