Codelisten
Codelisten können zum Übersetzen von Eigenschaftswerten in einen anderen Wert genutzt werden, meist für die HTML-Ausgabe.
Konfiguration
Die nachfolgende Tabelle beschreibt die Struktur der Codelisten-Dateien.
Name | Default | Beschreibung | Typ | Seit |
---|---|---|---|---|
id | Eindeutiger Identifikator der Entity, muss dem Dateinamen entsprechen. Erlaubt sind Buchstaben (A-Z, a-z), Ziffern (0-9), der Unterstrich ("_") und der Bindestrich ("-"). | string | v2.0 | |
label | id | Eine lesbare Bezeichnung der Codelist, die im Manager angezeigt wird. | string | v2.0 |
entries | {} | Jeder Eintrag bildet einen Original-Wert auf den neuen Wert ab. | object | v2.0 |
sourceType | TEMPLATES | TEMPLATES für alle manuell erstellte Codelisten. | string | v2.0 |
fallback | the value | Optional kann ein Defaultwert angegeben werden. | string | v2.0 |
Bei den Zielwerten in entries
und bei fallback
können auch stringFormat-Transformationen genutzt werden. Ist der transformierte Wert für die HTML-Ausgabe gedacht, dann kann auch Markdown-Markup verwendet werden, dieser wird bei der HTML-Ausgabe aufbereitet.
Beispiel
Basierend auf der INSPIRE-Codelist EnvironmentalDomain werden Werte wie soil
auf das deutschsprachige Label in der INSPIRE-Codelist-Registry abgebildet:
---
id: environmental-domain
label: Umweltbereich, für den Umweltziele festgelegt werden können.
sourceType: TEMPLATES
entries:
air: Luft
climateAndClimateChange: Klima und Klimawandel
healthProtection: Gesundheitsschutz
landUse: Bodennutzung
naturalResources: natürliche Ressourcen
natureAndBiodiversity: Natur und biologische Vielfalt
noise: Lärm
soil: Boden
sustainableDevelopment: nachhaltige Entwicklung
waste: Abfall
water: Wasser
Speicherung
Die Codelisten liegen als YAML-Dateien im ldproxy-Datenverzeichnis unter dem relativen Pfad store/entities/codelists/{codelistId}.yml
.