1.36 Karten

Für im Goobi viewer verwendete Karten existiert der folgende Block in der Konfigurationsdatei:

config_viewer.xml

<maps>
    <mapbox>
        <token></token>
        <user></user>
        <styleId><styleId>
        <addressSearch enabled="true" />
    </mapbox>
    <markers>
        <marker icon="fa-info" markerColor="green" shape="circle" extraClasses="fa-2x">maps__marker_1</marker>
        <marker icon="fa-building" markerColor="orange-dark" shape="square">maps__marker_2</marker>
        <marker icon="fa-user" markerColor="cyan"  shape="penta">maps__marker_3</marker>
        <marker icon="fa-rocket" markerColor="pink"  shape="star">maps__marker_4</marker>
        <marker icon="fa-spinner" markerColor="yellow" extraClasses="fa-2x fa-spin">maps__marker_5</marker>
        <marker icon="fa-coffee" markerColor="white" prefix="fa" iconColor="black" iconRotate="270">maps__marker_6</marker>
        <marker icon="fa-number" markerColor="black" number="42" svg="true">maps__marker_7</marker>
    </markers>
    <metadata>
        <option label="cms__geomaps__popup_content__option__none" name=""/>
        <option label="cms__geomaps__popup_content__option__place" name="NORM_NAME">
            <title>
                <template name="_DEFAULT">
                        <metadata label="" value="{NORM_NAME}">
                                <param type="field" key="NORM_NAME" altKey="LABEL" />
                </metadata>
            </template>
        </title>
        </option>
        <option label="cms__geomaps__popup_content__option__metadata" name="MD_VALUE">
            <title>
                <template name="_DEFAULT">
                        <metadata label="" value="{MD_VALUE}">
                                <param type="field" key="MD_VALUE" altKey="LABEL" />
                </metadata>
            </template>
            </title>
                <entity>
                <title>
                    <template name="_DEFAULT">
                            <metadata label="" value="{MD_TITLE}">
                                    <param type="field" key="MD_TITLE" altKey="LABEL" />
                    </metadata>
                </template>
                        </title>
               </entity>
        </option>
    </metadata>       
    <coordinateFields>
        <field>MD_GEOJSON_POINT</field>
        <field>NORM_COORDS_GEOJSON</field>
    </coordinateFields>
    <cms>
        <heatmap enabled="false" />
    </cms>
    <facet>
        <heatmap enabled="false" />
        <marker icon="fa-circle" markerColor="red" svg="true" />
        <selection color="blue"/>
    </facet>
    <search>
        <heatmap enabled="false" />
        <marker icon="fa-circle" markerColor="red"  svg="true" />
        <selection color="blue"/>
    </search>
    <record>
        <template name="_DEFAULT">
            <marker>default</marker>
            <featureSets>
                <featureSet type="docStructs">
                    <marker>default</marker>
                    <labelConfig>MD_VALUE</labelConfig>
                </featureSet>
                <featureSet type="annotations">
                    <marker>default</marker>
                </featureSet>
            </featureSets>
        </template>
    </record>
</maps>

Einstellungen im Element <mapbox>

Hier können Zugangsdaten zu MapBox-Karten hinterlegt werden. Wenn das Element <token> gefüllt ist, werden Karten grundsätzlich von MapBox abgerufen. Mit den optionalen Werten <user> und <styleId> können speziell konfigurierte Kartenlayouts abrufen werden.

Bei Verwendung von MapBox-Karten kann ein Feature zur Suche nach Orten in der Karte verwendet werden. Dies wird aktiviert durch <addressSearch enabled="true">. Das Feature ist per default aktiviert.

Einstellungen im Element <markers>

Es kann eine beliebige Anzahl an Marker Konfigurationen hinterlegt werden. Der Goobi viewer verwendet das Leaflet Plugin ExtraMarkers. Mehr zu den Konfigurationsmöglichkeiten gibt es auf der folgenden Seite:

• https://github.com/coryasilva/Leaflet.ExtraMarkers

Einstellungen im Element <metadata>

Dieses Element gliedert sich in mehrere Unterlemente namens <option>. Jedes <option> Element taucht im CMS-Karten-Backend als Option für "Popups" auf. Damit wählt man aus, nach welchem Schema die Beschriftungen der Markers (in den Popups) generiert werden. Innerhalb einer <option> gibt es <title> worin die Beschriftung des Popups festgelegt wird, und optional <entity><title>, worin Beschriftungen von Untertreffern festgelegt werden. Untertreffer sind alle Marker, die die gleichen Koordinaten und den gleichen Titel haben. Diese werden als ein Marker mit einer Zahl, die die Anzahl Untertreffer angibt, angezeigt. So lange <entity><title> konfiguriert ist, hat jeder Marker mindestens einen Untertreffer, andernfalls gibt es keine Untertreffer. Marker mit Untertreffern öffnen beim Klick auf sie immer eine Liste mit der Beschriftung des Markers und aller Untertreffer als overlay auf der Karte. Innerhalb von <title> und <entity><title> gibe es immer <template><metadata> Konfigurationen, die Analog zu den <metadataList> Konfigurationen funktionieren. Der Name eines Templates ist der Name des Strukturtyp des SOLR-Dokumentes, aus dem der Marker erzeugt wurde. Wurde ein Marker aus einem Dokument mit DOCTYPE:METADATA erzeugt, gilt der Wert von LABEL des SOLR-Dokumentes als Strukturtyp.

Einstellungen im Element <coordinateFields>

hierin müssen alle SOLR-Felder aufgeführt werden, in denen Geo-Koordinaten stehen, die der Viewer zum Erstellen von Karten verwenden kann. In den Feldern können Koordinaten entweder als Text im Format GeoJson vorliegen, oder in der Form <latitude> <longitude>, also z.B. 51.82 9.42

Einstellungen in den Element <cms>, <facet> und <search>

In diesen Bereichen kann für CMS-Karten, die Suchseiten-Facettierung und die Kartensuche respektive die serverseitige Heatmapfunktionalität ein- oder ausgeschaltet sowie die Marker individuell angepasst werden.

Einstellungen im Element <record>

In der Werksansicht können geographische Karten angezeigt werden, wenn das Werk Metadaten mit Koordinatenangaben enthält und diese im Konfigurationsbereich maps.record konfiguriert sind. Diese Konfigurationen sind unterteilt in ein oder mehr template-Elemente, die jeweils für bestimmte Dokumenttypen gelten. Für jedes Template gibt es folgende Konfigurationsmöglichkeiten

Attribut oder Element	Beschreibung
@name	Das template gilt für alle Werke mit dem hier angegebenen Dokumenttyp (DOCSTRCT). Das erste Element ohne name oder mit name="_DEFAULT" wird für alle Dokumenttypen verwendet, die nicht in einem eigenen template konfiguriert sind.
marker	Der Name einer Geomap-Marker Konfiguration aus maps.markers.marker. Der hier angegebene Marker wird für alle Ortsmarkierungen auf der Karte verwendet, die nicht in einem featureSet Unterelement festgelegt werden.
featureSets	Liste von featureSet Elementen, die jeweils eine Gruppe von Markierungen innerhalb der Karte konfigurieren.

Featuresets

Jedes featureSet Element innerhalb von featureSets beschreibt eine Gruppe von Markierungen, die eine eigene Optik und eine eigene Datengrundlage haben können. Sie werden durch folgende Elemente konfiguriert:

Attribut oder Element	Beschreibung
@type	Eine Beschreibung der Datenherkunft der Gruppe. Die möglichen Werte von @type werden in einer eigenen Übersicht beschrieben
name	Name der Gruppe, die im Frontend referenziert werden kann
marker	Der Name einer Geomap-Marker Konfiguration aus maps.markers.marker. Der hier angegebene Marker wird für die Ortsmarkierungen der Gruppe verwendet
labelConfig	Der Name einer maps.metadata.option, die zur Konfiguration der Brschriftung der Markierungen verwendet wird
query	Ein Term zur Filterung der anzuzeigenden Werte. Die genaue Funktion hängt vom @type des featureSet ab, und ist dort jeweils beschrieben.
filters.filter	Liste von Filter-Konfigurationen, die im Frontend eine Auswahl zur Verfügung stellen, die Markierungen der Gruppe nach verschiedenen Kriterien zu filtern. Jedes filter Element in filters enthält ein Unterelement field, das den Wert des Metadatums enthält, über dessen Werte gefiltert werden soll. Zusätzlich enthält field zwei Attribute, die die Darstellung des Filters steuern: @label enthält einen Message-Key, der als Überschrift für diese Filtergruppe verwendet wird, @styleClass enthält einen String, der als css-Klasse für die Filtergruppe eingesetzt wird.

Typen von Featuresets

@type	Beschreibung
docStruct	Sucht nach Ortsdaten in Metadaten des Haupt-Strukturelementes. Gibt es ein query Unterelement, wird dieses Featureset nur für Dokumente erstellt, auf welche die in query konfigurierte einfache SOLR-Query zutrifft
docStructs	Sucht nach Ortsdaten in allen Strukturelementen innerhalb des Haupt-Strukturelements, inklusive des Haupt-Strukturelements. Gibt es ein query Unterelement, wird dieses Featureset nur für solche Haupt-Dokumente erstellt, auf welche die in query konfigurierte einfache SOLR-Query zutrifft
metadata	Sucht nach Ortsdaten in gruppierten Metadaten des aktuellen Haupt-Strukturelementes. Nur Metadaten, deren Name auf den im Unterelement query konfigurierten Filter passt, werden berücksichtigt
relation	Sucht nach Ortsdaten in "verwandten" Werken. "Verwandt" in diesem Sinne sind alle Dokumente mit einem Wert im SOLR-Feld MD_PROCESSID, der in einem Unterelementes des aktuellen Haupt-Strukturelementes vom Typ METADATA durch das Feld MD_IDENTIFIER referenziert wird. Diese verwandten" Dokumente können zusätzlich durch die einfache SOLR-Query im Unterelement query eingeschränkt werden.
annotations	Sucht nach Ortsdaten in zum Werk gehörigen Annotationen aus dem Crowdsourcing-Bereich. Hier ist keine weitere Einschränkung durch ein query Element vorgesehen, ebensowenig eine labelConfig, da die Beschriftungen direkt aus den Annotationen entnommen werden.

Beispiel:

<maps>
    <record>
      <template name="DocTypeA">
          <marker>maps__marker_A</marker>
          <featureSets>
            <featureSet type="docStructs">
                <name>docstructs_locations</name>
                <marker>maps__marker_B</marker>
                <labelConfig>docstructs_locations</labelConfig>
                <query>DOCSTRCT:A</query>
            <featureSet type="metadata">
                <name>metadata_group_locations</name>
                <marker>maps__marker_C</marker>
                <labelConfig>metadata_group_locations</labelConfig>
                <query>MD_CREATIONPLACE MD_PUBLICATIONPLACE MD_PLACE_*</query>
                <filters>
                    <filter>
                        <field label="message__place_types" styleClass="place-types">MD_TYPE</field>
                    </filter>
                </filter>
            </featureSet>
          </featureSets>
      </template>
      <template name="DocTypeB">
          <featureSets>
            <featureSet type="annotations">
                <name>annotations</name>
                <marker>maps__marker_D</marker>
            </featureSet>
          </featureSets>
      </template>
    </record>
    <!--required configurations for marker layout-->
    <markers>
        <marker type="divIcon" class="marker-circle marker-circle-a">maps__marker_A</marker>
        <marker type="divIcon" class="marker-circle marker-circle-b">maps__marker_B</marker>
        <marker type="divIcon" class="marker-circle marker-circle-c">maps__marker_C</marker>
        <marker type="divIcon" class="marker-circle marker-circle-d">maps__marker_D</marker>
    </markers>
    <!--required configuration for marker label--> 
    <metadata>
        <option name="docstructs_locations" label="message__docstructs_locations">
            <title>
                <template name="_DEFAULT">
                    <metadata label="" value="{MD_TITLE}">
                        <param type="field" key="MD_TITLE" altKey="LABEL" />
                    </metadata>
                </template>
            </title>
        </option>
        <option name="metadata_group_locations" label="message__metadata_group_locations">
            <title>
                <template name="_DEFAULT">
                    <metadata label="" value="{MD_VALUE}: {MD_LOCATION}">
                        <param type="field" key="MD_VALUE" altKey="LABEL" />
                        <param type="field" key="MD_LOCATION"/>
                    </metadata>
                </template>
            </title>
        </option>
    </metadata>
</maps>