Skip to content

Commit 50679d9

Browse files
committed
Review docs/template for correct requiredness info
1 parent a466ad0 commit 50679d9

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

docs/reference/schemas.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ issue_tracker = "..."
3737
helpdesk = "..."
3838
conforms_to = "..."
3939

40-
[vocabs.VOCAB_NAME.checks]
40+
[vocabs.VOCAB_NAME.checks] # Required section
4141
allow_delete = false
4242

43-
[vocabs.VOCAB_NAME.prefix_map]
43+
[vocabs.VOCAB_NAME.prefix_map] # Required section
4444
prefix = "namespace"
4545

4646
[[vocabs.VOCAB_NAME.id_range]]
@@ -93,7 +93,7 @@ These fields define vocabulary metadata shown in the Concept Scheme sheet.
9393
| `title` | Human-readable name | skos:prefLabel |
9494
| `description` | What the vocabulary covers | skos:definition |
9595
| `created_date` | Creation date (YYYY-MM-DD) | dct:created |
96-
| `creator` | Creator(s) with identifiers | dct:creator |
96+
| `creator` | Creators: name(s) with identifier(s), newline-separated | dct:creator |
9797
| `repository` | Source repository URL | - |
9898

9999
:::
@@ -106,14 +106,17 @@ These fields define vocabulary metadata shown in the Concept Scheme sheet.
106106
| Field | Description | SKOS/RDF |
107107
|-------|-------------|----------|
108108
| `prefix` | Preferred prefix for CURIEs | - |
109-
| `publisher` | Publishing organization | dct:publisher |
110-
| `custodian` | Maintenance responsibility | - |
109+
| `publisher` | Publishers: name(s) with identifier(s), newline-separated | dct:publisher |
110+
| `custodian` | Custodians: name(s) with identifier(s), newline-separated | - |
111111
| `homepage` | Public website URL | foaf:homepage |
112112
| `catalogue_pid` | DOI or persistent identifier | dct:identifier |
113113
| `documentation` | Documentation URL | - |
114114
| `issue_tracker` | Issue tracker URL | - |
115115
| `helpdesk` | Helpdesk URL | - |
116116
| `conforms_to` | SHACL profile URL | dct:conformsTo |
117+
| `provenance_url_template` | Jinja template for provenance URLs | - |
118+
| `history_note` | Auto-generated if empty from created_date and creator | skos:historyNote |
119+
| `profile_local_path` | Path to local SHACL profile file (relative to idranges.toml) | - |
117120

118121
:::
119122

@@ -134,7 +137,7 @@ Vocabulary Curator Group https://github.com/orgs/example/teams/curators
134137
"""
135138
```
136139

137-
### Prefix map
140+
### Prefix map (required)
138141

139142
Define namespace prefixes for CURIE expansion:
140143

@@ -144,7 +147,7 @@ myvoc = "https://example.org/myvocab_"
144147
skos = "http://www.w3.org/2004/02/skos/core#"
145148
```
146149

147-
### Checks configuration
150+
### Checks configuration (required)
148151

149152
Configure validation behavior:
150153

@@ -183,14 +186,14 @@ orcid = "0000-0002-3456-7890"
183186
|-------|----------|-------------|
184187
| `first_id` | Yes | First ID in range (inclusive) |
185188
| `last_id` | Yes | Last ID in range (inclusive) |
186-
| `gh_name` | Yes | GitHub username |
189+
| `gh_name` | Yes* | GitHub username |
187190
| `orcid` | Yes* | ORCID identifier (without URL prefix) |
188191
| `name` | No | Human-readable name |
189192
| `ror_id` | No | ROR identifier for institution |
190193

191194
:::
192195

193-
*At least one of `orcid` or `ror_id` is recommended.
196+
*At least one of `gh_name` or `orcid` is required.
194197

195198
### Complete example
196199

@@ -315,13 +318,13 @@ The main sheet where you define vocabulary concepts. Each row represents one con
315318
|--------|-------------|--------------|
316319
| Alternate Labels | Synonyms (comma-separated) | skos:altLabel |
317320
| Parent IRIs | Broader concepts (comma-separated) | skos:broader |
318-
| Member of collection(s) | Collection memberships | skos:member |
321+
| Member of collection(s) | Collection memberships (comma-separated) | skos:member |
319322
| Member of ordered collection # position | Position in ordered collection | - |
320323
| Provenance | Origin of concept (read-only) | dct:provenance |
321324
| Change Note | Documentation of changes | skos:changeNote |
322325
| Editorial Note | Internal notes | skos:editorialNote |
323326
| Obsoletion reason | Why deprecated | owl:deprecated |
324-
| Influenced by IRIs | Related external concepts | prov:wasInfluencedBy |
327+
| Influenced by IRIs | Related external concepts (comma-separated) | prov:wasInfluencedBy |
325328
| Source Vocab IRI or URL | Original source | prov:hadPrimarySource |
326329
| Source Vocab License | License of source | dct:license |
327330
| Source Vocab Rights Holder | Rights holder of source | dct:rightsHolder |
@@ -385,7 +388,7 @@ Collections group related concepts together without implying hierarchy.
385388
| Language Code | ISO language code |
386389
| Preferred Label | Name of the collection |
387390
| Definition | What the collection contains |
388-
| Parent Collection IRIs | Nest collections within other collections |
391+
| Parent Collection IRIs | Nest collections within other collections (comma-separated) |
389392
| Ordered? | "Yes" for ordered collection, blank for unordered |
390393
| Change Note | Documentation of changes |
391394
| Editorial Note | Internal notes |
@@ -403,17 +406,15 @@ Link your concepts to terms in other vocabularies.
403406
| Column | Description | SKOS mapping |
404407
|--------|-------------|--------------|
405408
| Concept IRI* | Your concept | - |
406-
| Related Matches | Loosely related external concepts | skos:relatedMatch |
407-
| Close Matches | Similar but not identical | skos:closeMatch |
408-
| Exact Matches | Semantically equivalent | skos:exactMatch |
409-
| Narrower Matches | More specific external concepts | skos:narrowMatch |
410-
| Broader Matches | More general external concepts | skos:broadMatch |
409+
| Related Matches | Loosely related external concepts (comma-separated) | skos:relatedMatch |
410+
| Close Matches | Similar but not identical (comma-separated) | skos:closeMatch |
411+
| Exact Matches | Semantically equivalent (comma-separated) | skos:exactMatch |
412+
| Narrower Matches | More specific external concepts (comma-separated) | skos:narrowMatch |
413+
| Broader Matches | More general external concepts (comma-separated) | skos:broadMatch |
411414
| Editorial Note | Internal notes (not exported to RDF) | - |
412415

413416
:::
414417

415-
Multiple IRIs in each field should be comma-separated.
416-
417418
### ID Ranges sheet
418419

419420
Read-only sheet showing which concept ID ranges are allocated to each contributor.
@@ -427,7 +428,6 @@ The prefixes come the `idranges.toml` configuration enriched with the default pr
427428
### Data formats
428429

429430
- **IRIs**: Full IRI or CURIE (`prefix:id`)
430-
- **Multi-value**: Comma-separated
431431
- **Language codes**: ISO 639-1 (`en`, `de`)
432432
- **Dates**: ISO 8601 (`YYYY-MM-DD`)
433433

0 commit comments

Comments
 (0)