-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
203 additions
and
91 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# mdJSON Schema Style Guidelines | ||
The following guidelines should be used when editiing mdJSON schema definition files. | ||
|
||
# Guidelines | ||
- [Use lowerCamelCase](#use-lowercamelcase) | ||
- [Use singular tense](#use-singular-tense) | ||
- [Provide all translations](#provide-all-translations) | ||
|
||
## Use lowerCamelCase | ||
Use lower camel case for all schema property names. | ||
|
||
yes: | ||
``` | ||
title | ||
associatedResource{} | ||
pointOfContact[] | ||
``` | ||
|
||
no: | ||
``` | ||
Title | ||
AssociatedResource{} | ||
pointofContact[] | ||
``` | ||
|
||
## Use singular tense | ||
Use singular tense for all property names names. | ||
|
||
yes: `dataDictionary[]` | ||
|
||
no: `dataDictionaries[]` | ||
|
||
## Provide all translations | ||
Provide translations for: 1) "[__FGDC CSDGM__](https://www.fgdc.gov/metadata/csdgm-standard)", 2) "__DCAT__" ([Data Catalog Vocabulary](https://www.w3.org/TR/vocab-dcat-2/)), and 3) "[__sbJSON__]" ([ScienceBase JSON](https://www.usgs.gov/sciencebase-instructions-and-documentation/item-core-model)) when an ISO translation is provided. If no translation is available indicate ```"no translation"```. | ||
|
||
yes: | ||
``` | ||
"translation": { | ||
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"], | ||
"FGDC CSDGM": ["no translation"] | ||
"DCAT": ["no translation"], | ||
"sbJSON": ["no translation"] | ||
} | ||
``` | ||
|
||
yes: | ||
``` | ||
"translation": { | ||
"ISO 19115-2": ["MD_Keywords > thesaurusName > CI_Citation"], | ||
"FGDC CSDGM": [ | ||
"idinfo>keywords>theme>themekt", | ||
"idinfo>keywords>place>placekt", | ||
"idinfo>keywords>temporal>tempkt" | ||
], | ||
"DCAT": ["no translation"], | ||
"sbJSON": ["tags > scheme"] | ||
} | ||
``` | ||
|
||
no: | ||
``` | ||
"translation": { | ||
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"] | ||
} | ||
``` | ||
|
||
no: | ||
``` | ||
"translation": { | ||
"ISO 19115-1": ["CI_ResponsibleParty > partyIdentifier"], | ||
"FGDC CSDGM": ["no translation"] | ||
} | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
module ADIWG | ||
module MdjsonSchemas | ||
# Current schema version number | ||
VERSION = "2.10.0" | ||
VERSION = "2.10.1" | ||
end | ||
end |
Oops, something went wrong.