diff --git a/principles/fp-012-naming-conventions.md b/principles/fp-012-naming-conventions.md index d0eb66f86..b5a5c8b96 100644 --- a/principles/fp-012-naming-conventions.md +++ b/principles/fp-012-naming-conventions.md @@ -8,8 +8,19 @@ title: Naming Conventions (principle 12) The content of this page is scheduled to be reviewed. Improved wording will be posted as it becomes available. -## Details +GO TO: [Recommendations/Requirements](#recommendations-and-requirements) | [Implementation](#implementation) | [Examples/Counter‑Examples](#examples) | [Criteria for Review](#criteria-for-review) | [Feedback/Discussion](#feedback-and-discussion) +## Summary + +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. + +## Purpose + +Text to be added. + +## Recommendations and Requirements + +Text to be added. For full details, see this paper: Briefly, some important things to remember: @@ -20,13 +31,33 @@ Briefly, some important things to remember: - avoid extra spaces between words, or at the beginning or end of the term label - spell out abbreviations. Abbreviations can be included as a separate property. - 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 -- labels should be unique within an ontology +- labels MUST be unique within an ontology - 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 -[This check is automatically validated.](checks/fp_012) +## Implementation + +Text to be added. ## Examples -## Counter-Examples +Text to be added. + +## Counter Examples + +Text to be added. + +## Criteria for Review + +Text to be added. + +[This check is automatically validated.](checks/fp_012) + +## Feedback and Discussion + +