Skip to content

Commit 0611c88

Browse files
authored
Update fp-012-naming-conventions.md to standardize format (in progress) (#2855)
1 parent bae46ef commit 0611c88

1 file changed

Lines changed: 35 additions & 4 deletions

File tree

principles/fp-012-naming-conventions.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,19 @@ title: Naming Conventions (principle 12)
88

99
The content of this page is scheduled to be reviewed. Improved wording will be posted as it becomes available.
1010

11-
## Details
11+
GO TO: [Recommendations/Requirements](#recommendations-and-requirements) | [Implementation](#implementation) | [Examples/Counter‑Examples](#examples) | [Criteria for Review](#criteria-for-review) | [Feedback/Discussion](#feedback-and-discussion)
1212

13+
## Summary
14+
15+
The names (primary labels) for elements (classes, properties, etc.) in an ontology must be intelligible to scientists and amenable to natural language processing. Each primary label SHOULD be unique among OBO Library ontologies, and MUST be unique within its own ontology.
16+
17+
## Purpose
18+
19+
Text to be added.
20+
21+
## Recommendations and Requirements
22+
23+
Text to be added.
1324
For full details, see this paper: <http://www.biomedcentral.com/1471-2105/10/125>
1425

1526
Briefly, some important things to remember:
@@ -20,13 +31,33 @@ Briefly, some important things to remember:
2031
- avoid extra spaces between words, or at the beginning or end of the term label
2132
- spell out abbreviations. Abbreviations can be included as a separate property.
2233
- make the primary labels to be as unambiguous as possible. Remember, your ontology may be used in a different context than that for which it was originally intended. Remember also of course that the label should be unambiguous without looking at parent terms
23-
- labels should be unique within an ontology
34+
- labels MUST be unique within an ontology
2435
- use the IAO property 'obo foundry unique label' [http://purl.obolibrary.org/obo/IAO_0000589](http://purl.obolibrary.org/obo/IAO_0000589) to declare a pan-OBO unique label if required
2536

26-
[This check is automatically validated.](checks/fp_012)
37+
## Implementation
38+
39+
Text to be added.
2740

2841
## Examples
2942

30-
## Counter-Examples
43+
Text to be added.
44+
45+
## Counter Examples
46+
47+
Text to be added.
48+
49+
## Criteria for Review
50+
51+
Text to be added.
52+
53+
[This check is automatically validated.](checks/fp_012)
54+
55+
## Feedback and Discussion
56+
57+
<!-- rev. 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+%2314+%22Guidelines).
58+
59+
rev. 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+%2314+%22Guidelines).
60+
61+
rev. See also [this discussion](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/????) ??? by the OBO Foundry Operations Committee. -->
3162

3263
<Category:Principles> <Category:Accepted>

0 commit comments

Comments
 (0)