Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add business rules for adding new ISO codelists #44

Open
hmaier-fws opened this issue Mar 7, 2023 · 0 comments
Open

Add business rules for adding new ISO codelists #44

hmaier-fws opened this issue Mar 7, 2023 · 0 comments

Comments

@hmaier-fws
Copy link
Contributor

hmaier-fws commented Mar 7, 2023

Update contribution guidelines to add business rules for creating new ISO code lists.

The following guidelines apply to ISO specified codelists (e.g. codelists.html, codelists.xml). The ISO "CI_DateTypeCode" codelist will be used for the following examples.

Specifying attributes for ISO maintained codelists

codelistName

  1. Identify the desired ISO codelist name (e.g. "CI_DateTypeCode")
  2. Remove class identifier prefix and "Code" suffix (CI_DateTypeCode -> DateType)
  3. Convert shortened name to lowerCamelCase and add "iso_" prefix (DateType -> iso_dateType)
  4. CI_DateTypeCode -> codelistName = iso_dateType
  5. Use the newly created codelistName as the file name (e.g. iso_dateType.yml, iso_dateType.json)

source

  1. Use value "ISO"

sourceName

  1. Use the ISO specified codelist name. See the <cat:name> element from codelists.xml snippet below:

<cat:codelistItem>
<cat:CT_Codelist id="CI_DateTypeCode">
<cat:identifier>
<gco:ScopedName codeSpace="http://standards.iso.org/iso/19115/-3/cit/1.0">CI_DateTypeCode</gco:ScopedName>
</cat:identifier>
<cat:name>
<gco:ScopedName codeSpace="http://standards.iso.org/iso/19115/-3/cit/1.0">CI_DateTypeCode</gco:ScopedName>
</cat:name>

  1. sourceName = "CI_DateTypeCode"

description

  1. Use the ISO specified codelist description

<cat:definition>
<gco:CharacterString>identification of when a given event occurred</gco:CharacterString>
</cat:definition>

  1. description = "identification of when a given event occurred"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant