Use hcat: property name prefix in order to accomodate non-ec categories

CHANGELOG.md

@@ -27,6 +27,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - ...
 
+## [v0.2.0] - 2024-11-21
+
+- Backwards incompatible change: change `ec:` prefix to `hcat:`. Properties are now `hcat:code`, `hcat:name`, `hcat:name_en`.
+
 ## [v0.1.0] - 2024-03-01
 
 - First release

README.md

@@ -2,9 +2,9 @@
 
 - **Title:** Hierarchical Crop and Agriculture Taxonomy Extension
 - **Identifier:** <https://fiboa.github.io/hcat-extension/v0.1.0/schema.yaml>
-- **Property Name Prefix:** ec
+- **Property Name Prefix:** hcat
 - **Extension Maturity Classification:** Proposal
-- **Owner**: @cholmes
+- **Owner**: @cholmes @ivorbosloper
 
 This document explains the Hierarchical Crop and Agriculture Taxonomy (HCAT) Extension to the
 [Field Boundaries for Agriculture (fiboa) Specification](https://github.com/fiboa/specification).
@@ -17,13 +17,12 @@ almost 400 different crop types, and is currently on it's third iteration.
 The HCAT core list of names and codes is defined in the file
 [HCAT3.csv](https://github.com/maja601/EuroCrops/blob/main/hcat_core/HCAT3.csv).
 Its goal is to harmonise all declared crops across the European Union, but it is likely a useful
-as crop classification taxonomy beyond Europe.
+as crop classification taxonomy beyond Europe. In order to prepare for this wider use case, we
+will use the `hcat` abbreviations instead of `ec`.
 
 Note that this extension does not attempt to use the exact same field names as Eurocrops, as they
 were designed for use with Shapefiles, a restriction Fiboa does not share. This attempts to be
-more descriptive, and fit with the 'Fiboa style', reusing the 'EC_' prefix of the original fields,
-but adapting it to be `ec:`. But feedback is welcome, we could have it stay more true, or also
-adapt it more (like use `hcat:` as the prefix).
+more descriptive, and fit with the 'Fiboa style'.
 
 - Examples:
   - [GeoJSON](examples/geojson/)
@@ -38,11 +37,11 @@ The properties in the table below can be used in these parts of fiboa documents:
 - [ ] Collection
 - [x] Feature Properties
 
-| Property Name      | Type   | Description |
-| ------------------ | ------ | ----------- |
-| ec:hcat_name       | string | The machine-readable HCAT name of the crop |
-| ec:hcat_code       | uint32 | The 10-digit HCAT code indicating the hierarchy of the crop |
-| ec:translated_name | string | The original crop name translated into English |
+| Property Name | Type   | Description                                                 |
+|---------------|--------|-------------------------------------------------------------|
+| hcat:name     | string | The machine-readable HCAT name of the crop                  |
+| hcat:code     | uint32 | The 10-digit HCAT code indicating the hierarchy of the crop |
+| hcat:name_en  | string | The original crop name translated into English              |
 
 ## Contributing
 

examples/geojson/example.json

@@ -90,9 +90,9 @@
         "code_culture": "VRC",
         "code_group": 21,
         "determination_datetime": "2018-01-15T00:00:00Z",
-        "ec:translated_name": "Vine: wine grapes",
-        "ec:hcat_name": "vineyards_wine_vine_rebland_grapes",
-        "ec:hcat_code": 3303060000
+        "hcat:code": 3303060000,
+        "hcat:name": "vineyards_wine_vine_rebland_grapes",
+        "hcat:name_en": "Vine: wine grapes"
     },
     "links":
     [

schema/schema.yaml

@@ -1,6 +1,6 @@
 $schema: https://fiboa.github.io/schema/v0.1.0/schema.json
 properties:
-  ec:hcat_name:
+  hcat:name:
     type: string
     enum:
       - characteristics
@@ -387,7 +387,7 @@ properties:
       - peat_turf
       - unmaintained
       - not_known_and_other
-  ec:hcat_code:
+  hcat:code:
     type: uint32
     enum:
       - 3000000000
@@ -774,6 +774,6 @@ properties:
       - 3307000000
       - 3308000000
       - 3399000000
-  ec:translated_name:
+  hcat:name_en:
     type: string
     minLength: 1