Skip to content

Commit c0e5def

Browse files
authored
Update fp-003-uris.md with clarifications and rearrangement (#2608)
1 parent cd44a50 commit c0e5def

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

principles/fp-003-uris.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,19 @@ A unique namespace within the OBO Foundry Library allows the source of an elemen
1515

1616
## Recommendations and Requirements
1717

18-
Each ontology MUST have a unique IRI in the form of an OBO Foundry permanent URL (PURL). The PURL must include the ontology namespace, which is abbreviated by a short set of letters approved by the OBO Foundry Operations Committee. Every element (class, property, etc.) created by the ontology MUST use the namespace in the identifier of each element, as specified in the OBO Foundry [ID policy](http://www.obofoundry.org/id-policy).
18+
Each ontology MUST have a unique IRI in the form of an OBO Foundry permanent URL (PURL). The PURL must include the ontology namespace, which is a short string of letters (usually 2-5) that represents the ontology. Namespaces MUST be approved by the OBO Foundry Operations Committee. Every element (class, property, etc.) created by the ontology MUST use the namespace in the identifier of each element, as specified in the OBO Foundry [ID policy](http://www.obofoundry.org/id-policy).
1919

2020
## Implementation
2121

2222
### Ontology Namespace:
2323

24-
The namespace is a short string of letters (usually 2-5) that represents the ontology.
25-
When used as part of a CURIE, on its own, or as part of a term ID, the namespace MUST be capitalized.
26-
As per [vote on 31st May 2024](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2596), this applies to all ontologies submitted for acceptance after the 1st June 2024. Ontologies submitted before the 1st June 2024 may retain their mixed case prefixes.
27-
When used as part of the ontology IRI, the namespace is in lower case. See examples below.
24+
The ontology namespace MUST be unique; that is, it MUST NOT be in current use or have been used in the past. When used as part of the ontology IRI, the namespace is in lower case. When used as part of a CURIE, on its own, or as part of a term ID, the namespace MUST be capitalized (<i>Note: this applies to ontologies submitted after 1st June 2024; mixed-case prefixes for ontologies submitted before this date may be retained</i>).
2825

2926
To request a new namespace, ontology developers MUST follow the guidelines outlined here. Note that very short namespaces (2-3 characters) are reserved for ontologies that cover a general domain and are likely to be frequently used.
3027

31-
The ontology namespace MUST be unique; that is, it MUST NOT be in current use or have been used in the past.
32-
3328
### Ontology IRI:
3429

35-
The primary IRI for an OBO Library IRI MUST have the following format:
30+
The primary IRI for an OBO ontology IRI MUST have the following format:
3631
https://purl.obolibrary.org/obo/$namespace.owl
3732

3833
Note: To conform with OBO Foundry [Principle 2](https://obofoundry.org/principles/fp-002-format.html), the ontology IRI MUST resolve to the ontology file, not a landing page.
@@ -41,20 +36,22 @@ For guidelines on how to create IRIs for ontology elements/terms, see the OBO Fo
4136

4237
## Examples
4338

44-
http://purl.obolibrary.org/obo/go.owl
45-
http://purl.obolibrary.org/obo/pco.owl
39+
| Namespace | Ontology IRI | Term IRI | Term CURIE |
40+
| ------------- | ------------- | ------------- | ------------- |
41+
| GO | http://purl.obolibrary.org/obo/go.owl | http://purl.obolibrary.org/obo/GO_0008150 | GO:0008150 |
42+
| PCO | http://purl.obolibrary.org/obo/pco.owl | http://purl.obolibrary.org/obo/PCO_0000000 | PCO:0000000 |
4643

4744
## Counter Examples
4845

4946
The following counter examples are valid ontology IRIs, but do not conform with OBO Foundry principles.
5047

51-
http://iridl.ldeo.columbia.edu/ontologies/SWEET.owl
48+
- http://iridl.ldeo.columbia.edu/ontologies/SWEET.owl
5249

5350
Furthermore, these IRIs do not resolve to the ontology file.
5451

55-
http://purl.org/dc/terms/
52+
- http://purl.org/dc/terms/
5653

57-
http://dbpedia.org/ontology/
54+
- http://dbpedia.org/ontology/
5855

5956
## Criteria for Review
6057

@@ -67,3 +64,5 @@ The ontology namespace MUST be registered following the procedures outlined with
6764
To suggest revisions or begin a discussion pertaining to this principle, please [create an issue on GitHub](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/new?labels=attn%3A+Editorial+WG,principles&title=Principle+%233+%22URIs%22+%3CENTER+ISSUE+TITLE%3E).
6865

6966
To suggest revisions or begin a discussion pertaining to the automated validation of this principle, please [create an issue on GitHub](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/new?labels=attn%3A+Technical+WG,automated+validation+of+principles&title=Principle+%233+%22URIs%22+-+automated+validation+%3CENTER+ISSUE+TITLE%3E).
67+
68+
See also [this discussion](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2596) of URI capitalization by the OBO Foundry Operations Committee.

0 commit comments

Comments
 (0)