Skip to content

Commit c1116ce

Browse files
committed
Improve docs #1
1 parent 03315f9 commit c1116ce

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
This document explains the Administrative Division Extension to the
1010
[Field Boundaries for Agriculture (fiboa) Specification](https://github.com/fiboa/specification).
1111

12-
It defines administrative divisions on the country and subdivision level based on ISO-3166.
12+
It defines administrative divisions on the country and subdivision level based on
13+
[ISO-3166](https://www.iso.org/iso-3166-country-codes.html).
1314

1415
- Examples:
1516
- [GeoJSON](examples/geojson/)
@@ -26,8 +27,22 @@ The properties in the table below can be used in these parts of fiboa documents:
2627

2728
| Property Name | Type | Description |
2829
| ---------------------- | ------ | ----------- |
29-
| admin:country_code | string | **REQUIRED.** ISO 3166-1 alpha-2 country code (aka admin0). Two-letter country code for the country that contains the field, e.g. DE for Germany. Can be found at <https://www.iso.org/obp/ui/#search> under the Alpha-2 code column. |
30-
| admin:subdivision_code | string | ISO 3166-2 codes for identifying the principal subdivisions (e.g., provinces or states) of a country (aka admin1) that contains the field. The feature only contains the second part of the ISO 3166-2 code, to reduce redundancy. |
30+
| admin:country_code | string | **REQUIRED.** ISO 3166-1 alpha-2 country code (aka admin0). Two-letter country code for the country that contains the field. |
31+
| admin:subdivision_code | string | ISO 3166-2 codes for identifying the principal subdivisions (e.g., provinces or states) of a country (aka admin1) that contains the field. The feature only contains the second part of the ISO 3166-2 code to reduce redundancy. |
32+
33+
The codes can be found at:
34+
35+
- Search for country codes at <https://www.iso.org/obp/ui/#search> via the Alpha-2 code column.
36+
- The subdivision codes can then be accessed at <https://www.iso.org/obp/ui/#iso:pub:PUB500001:en>
37+
38+
Please note that for some countries subdivision codes are not available.
39+
40+
### Examples
41+
42+
1. California, USA:
43+
`admin:country_code` = `US` and `admin:subdivision_code` = `CA`
44+
2. Bavaria, Germany:
45+
`admin:country_code` = `DE` and `admin:subdivision_code` = `BY`
3146

3247
## Contributing
3348

0 commit comments

Comments
 (0)