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 |
---|---|---|---|---|
label | id | Eine lesbare Bezeichnung der Codelist. | string | v2.0 |
description | null | Eine Beschreibung der Codelist. | string | v4.3 |
entries | {} | Jeder Eintrag bildet einen Original-Wert auf den neuen Wert ab. | object | v2.0 |
sourceType | TEMPLATES | Immer TEMPLATES . | 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:
---
label: Umweltbereich, für den Umweltziele festgelegt werden können.
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 im Store als Values mit Typ codelists
.
Codelisten haben einen Pfad anstatt einer Id. Das heißt z.B. values/codelists/bar.yml
würde als bar
referenziert, aber man könnte zusätzlich values/codelists/foo/bar.yml
definieren. Um diese Codelist an anderer Stelle in der Konfiguration zu referenzieren würde man foo/bar
verwenden.