HTML

specstableimplmature

HTML-Kodierung für alle unterstützten Ressourcen.

Umfang

Konformitätsklassen

Das Modul implementiert für die Ressourcen Landing Page, Conformance Declaration, Feature Collections und Feature Collection alle Vorgaben der Konformitätsklasse "HTML" von OGC API - Features - Part 1: Core 1.0open in new window.

Konfiguration

Benutzerdefinierte Templates

Die HTML-Ausgabe ist mittels Mustache-Templatesopen in new window implementiert. Anstelle der Standardtemplates können auch benutzerspezifische Templates verwendet werden. Die eigenen Templates müssen als Dateien im Datenverzeichnis unter dem relativen Pfad templates/html/{templateName}.mustache liegen, wobei {templateName} der Name des Default-Templates ist. Die Standardtemplates liegen jeweils in den Resource-Verzeichnissen der Module, die sie verwenden (Link zur Suche in GitHubopen in new window).

Optionen

NameDefaultBeschreibungTypSeit
buildingBlock
Immer HTML.
string
v2.0
extensionType
Deprecated Siehe buildingBlock.
string
v2.0
enabled
true
Soll das Modul aktiviert werden?
boolean
v2.0
noIndexEnabled
true
Steuert, ob in allen Seiten noIndex gesetzt wird und Suchmaschinen angezeigt wird, dass sie die Seiten nicht indizieren sollen.
boolean
v2.0
schemaOrgEnabled
true
Steuert, ob in die HTML-Ausgabe schema.org-Annotationen, z.B. für Suchmaschinen, eingebettet sein sollen, sofern. Die Annotationen werden im Format JSON-LD eingebettet.
boolean
v2.0
microdataEnabled
true
Deprecated Siehe schemaOrgEnabled.
boolean
v2.0
collectionDescriptionsInOverview
false
Steuert, ob in der HTML-Ausgabe der Feature-Collections-Ressource für jede Collection die Beschreibung ausgegeben werden soll.
boolean
v2.0
sendEtags
boolean
v2.0
legalName
Legal notice
Auf jeder HTML-Seite kann ein ggf. rechtlich erforderlicher Link zu einem Impressum angezeigt werden. Diese Eigenschaft spezfiziert den anzuzeigenden Text.
string
v2.0
legalUrl
null
Auf jeder HTML-Seite kann ein ggf. rechtlich erforderlicher Link zu einem Impressum angezeigt werden. Diese Eigenschaft spezfiziert die URL des Links.
string
v2.0
privacyName
Privacy notice
Auf jeder HTML-Seite kann ein ggf. rechtlich erforderlicher Link zu einer Datenschutzerklärung angezeigt werden. Diese Eigenschaft spezfiziert den anzuzeigenden Text.
string
v2.0
privacyUrl
null
Auf jeder HTML-Seite kann ein ggf. rechtlich erforderlicher Link zu einer Datenschutzerklärung angezeigt werden. Diese Eigenschaft spezfiziert die URL des Links.
string
v2.0
defaultStyle
NONE
Ein Style im Style-Repository, der standardmäßig in Karten mit Feature- und Tile-Ressourcen verwendet werden soll. Bei NONE wird ein einfacher Style mit OpenStreetMap als Basiskarte verwendet, wenn MapLibre der Map-Client ist; bei Cesium wird das Standard-3D-Tiles-Styling verwendet. Wenn der Wert nicht NONE ist und MapLibre der Map_Client ist, enthält die "Landing Page" bzw. die "Feature Collection" auch einen Link zu einer Webkarte mit dem Stil für den Datensatz bzw. die Feature Collection. Der Style sollte alle Daten abdecken und muss im Format Mapbox Style verfügbar sein.
string
v2.0
basemapUrl
https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
Das URL-Template für die Kacheln einer Hintergrundkarte.
string
v2.0
basemapAttribution
&copy; <a href='http://osm.org/copyright'>OpenStreetMap</a> contributors
Die Quellenangabe für die Hintergrundkarte.
string
v2.0
leafletUrl
https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
Deprecated Siehe basemapUrl.
string
v2.0
leafletAttribution
&copy; <a href='http://osm.org/copyright'>OpenStreetMap</a> contributors
Deprecated Siehe basemapAttribution.
string
v2.0
openLayersUrl
https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png
Deprecated Siehe basemapUrl.
string
v2.0
openLayersAttribution
&copy; <a href='http://osm.org/copyright'>OpenStreetMap</a> contributors
Deprecated Siehe basemapAttribution.
string
v2.0
footerText
null
Zusätzlicher Text, der auf jeder HTML-Seite im Footer angezeigt wird.
string
v2.0

Beispiele

Beispiel für die Angaben in der Konfigurationsdatei (aus der API für Topographische Daten in Daraa, Syrienopen in new window):


- buildingBlock: HTML
  enabled: true
  noIndexEnabled: true
  schemaOrgEnabled: true
  defaultStyle: topographic

Beispiel für die Angaben in der Konfigurationsdatei (aus der API für Weinlagen in Rheinland-Pfalzopen in new window):


- buildingBlock: HTML
  enabled: true
  noIndexEnabled: false
  schemaOrgEnabled: true
  collectionDescriptionsInOverview: true
  legalName: Legal notice
  legalUrl: https://www.interactive-instruments.de/en/about/impressum/
  privacyName: Privacy notice
  privacyUrl: https://www.interactive-instruments.de/en/about/datenschutzerklarung/
  basemapUrl: https://sg.geodatenzentrum.de/wmts_topplus_open/tile/1.0.0/web_grau/default/WEBMERCATOR/{z}/{y}/{x}.png
  basemapAttribution: '&copy;<a href="https://www.bkg.bund.de" target="_new" >Bundesamt f&uuml;r Kartographie und Geod&auml;sie</a>(2020), <a href="https://sg.geodatenzentrum.de/web_public/Datenquellen_TopPlus_Open.pdf" target="_new" >Datenquellen</a>'
  defaultStyle: default