KLEKSI Frontend-Widget-Installation
DocsDas KLEKSI-Frontend wird als Widget in Ihre bestehende Website eingebunden. Dadurch bleiben Design und Navigation Ihrer Website erhalten, während die Kollektionspräsentation von KLEKSI innerhalb der Seite geladen wird. Das Widget wird idealerweise zwischen Header und Footer Ihrer Website platziert. Der Header enthält üblicherweise Elemente wie Ihr Logo und das Navigationsmenü. Der Footer enthält in der Regel weitere Navigationselemente, Kontaktdaten und allgemeine Informationen. Fügen Sie den folgenden Code an der gewünschten Stelle ein, um die Kollektion anzuzeigen:
<link href="https://eu.cdn.kleksi.com/uwcode/app.js" rel="preload" as="script"><kleksi-results></kleksi-results><script type="module"src="https://eu.cdn.kleksi.com/uwcode/app.js"></script>
Struktur des Widget-Codes
Der Code besteht aus drei Teilen. Die erste Zeile stellt sicher, dass das notwendige KLEKSI-Skript bereits vom Browser ausgeführt wird.
geladen:
<link href="https://eu.cdn.kleksi.com/jouwcode/app.js"rel="preload" as="script">
Als Nächstes bestimmt das folgende Element, wo auf der Seite das KLEKSI-Frontend angezeigt wird:
<kleksi-results></kleksi-results>
Schließlich wird die JavaScript-Datei geladen, mit der das Frontend erstellt und aktiviert wird:
<script type="module"src="https://eu.cdn.kleksi.com/jouwcode/app.js"></script>
Platzierung innerhalb einer bestehenden Seite
Eine vereinfachte HTML-Seite könnte beispielsweise so aussehen:
<header><!-- Header en navigatie van uw eigen website --></header>
<main>
<link href="https://eu.cdn.kleksi.com/jouwcode/app.js"rel="preload" as="script"><kleksi-results></kleksi-results><script type="module"src="https://eu.cdn.kleksi.com/jouwcode/app.js"></script>
</main>
<footer><!-- Footer van uw eigen website --></footer>
Dadurch bleibt der Besucher auf Ihrer eigenen Website, und nur der Bereich zwischen Kopf- und Fußzeile wird vom KLEKSI-Frontend ausgefüllt.
Ihr persönlicher Widget-Code
Im obigen Beispiel dient „yourcode“ lediglich als Beispiel. Dieser Wert muss durch den eindeutigen Code Ihrer Organisation ersetzt werden. Lautet Ihr persönlicher Code beispielsweise „abcde“, ergeben sich folgende Verweise:
https://eu.cdn.kleksi.com/ abcde /app.js
Verwenden Sie hierfür immer die Anwendungs-ID Ihrer KLEKSI-Anwendung. Sie können diese auch bei Ihrem Ansprechpartner oder dem Support-Team erfragen.
Platzierung in einem CMS
Wenn Ihre Website ein Content-Management-System (CMS) wie WordPress, Joomla, Drupal oder ein anderes CMS verwendet, lässt sich das Widget in der Regel über einen HTML- oder Codeblock einbinden. Wichtig ist, dass der verwendete Block das Einfügen von benutzerdefiniertem HTML- und JavaScript-Code ermöglicht. Einige CMS-Systeme oder Page-Builder entfernen <script>-Elemente automatisch. In diesem Fall muss das Widget vom Website-Administrator oder Webentwickler in die Seitenvorlage eingebunden werden. Nach dem Einfügen des Codes können Sie die Seite öffnen und überprüfen, ob die Sammlung korrekt zwischen dem bestehenden Header und Footer Ihrer Website angezeigt wird.
Nutzen Sie die gesamte verfügbare Seitenbreite.
Das KLEKSI-Widget wurde so entwickelt, dass es die gesamte Seitenbreite nutzt. Einige Websites verwenden jedoch eine zentrale Inhaltsspalte mit festen Rändern, Leerraum oder einer maximalen Inhaltsbreite links und rechts. Dadurch kann der verfügbare Platz für das Widget kleiner als gewünscht ausfallen. Dies kann dazu führen, dass bei bestimmten Bildschirmauflösungen weniger Objekte nebeneinander angezeigt werden und die responsive Darstellung nicht optimal oder korrekt funktioniert. Wir empfehlen daher, alle festen Seitenränder, maximalen Inhaltsbreiten oder andere einschränkende Layout-Einstellungen auf der Seite, auf der das KLEKSI-Widget platziert ist, zu entfernen, damit das Widget die gesamte Seitenbreite ausnutzen kann.
Verlinken Sie Detailseiten mit Ihrer eigenen Domain.
Wenn ein Besucher ein Objekt im KLEKSI-Frontend öffnet, wird eine separate Detailseite für dieses Objekt angezeigt. Standardmäßig stellt KLEKSI diese Detailseiten über eine KLEKSI-Domain bereit. Es wird jedoch empfohlen, die Detailseiten unter der Domain Ihrer Organisation bereitzustellen. Dadurch wird sichergestellt, dass der Besucher beim Betrachten eines Objekts auf Ihrer Website bleibt und dass die öffentlichen Sammlungsseiten von Suchmaschinen ebenfalls mit der Domain Ihrer Organisation und nicht mit der KLEKSI-Domain verlinkt werden.
Eine Detailseite kann dann beispielsweise über folgende Schritte geöffnet werden:
https://www.jouworganisatie.nl/collectie/detail/12345
anstatt direkt über eine KLEKSI-Domäne.
Funktionsweise der Kupplung
Dazu wird auf dem Webserver eine sogenannte Reverse-Proxy-Regel eingerichtet. Öffnet ein Besucher eine URL unter /collectie/detail/, ruft der Webserver im Hintergrund die entsprechende Detailseite von KLEKSI ab. Die URL im Browser bleibt die Ihrer eigenen Website. Der Besucher wird daher nicht sichtbar auf eine andere Domain weitergeleitet. Bei einer Website mit einem Apache-Webserver kann zu diesem Zweck folgende Zeile in die .htaccess-Datei eingefügt werden:
RewriteRule ^collectie/detail/(.*)http://eu.detail.kleksi.com/jouwcode/$1 [P]
Geben Sie Ihren persönlichen KLEKSI-Anwendungscode ein.
In der obigen Zeile ist „yourcode“ ein Beispielwert. Dieser muss durch den eindeutigen KLEKSI-Code ersetzt werden, der Ihrer Organisation zur Verfügung gestellt wurde.
Wenn Ihr KLEKSI-Code beispielsweise abcde lautet, gilt folgende Regel:
RewriteRule ^collectie/detail/(.*)http://eu.detail.kleksi.com/abcde/$1 [P]
Verwenden Sie immer den Code, den Sie von KLEKSI erhalten haben.
Die Regel zu .htaccess hinzufügen
Die .htaccess-Datei befindet sich üblicherweise im Stammverzeichnis der Website. Öffnen Sie diese Datei und prüfen Sie zunächst, ob mod_rewrite bereits aktiviert ist:
RewriteEngine On
Wenn diese Regel bereits vorhanden ist, müssen Sie sie nicht erneut hinzufügen. Eine einfache Konfiguration könnte beispielsweise so aussehen:
RewriteEngine On
RewriteRule ^collectie/detail/(.*)http://eu.detail.kleksi.com/jouwcode/$1 [P]
Viele Websites, insbesondere solche, die ein Content-Management-System (CMS) wie WordPress, Drupal oder Joomla verwenden, enthalten bereits mehrere Rewrite-Regeln. In diesem Fall sollte die KLEKSI-Regel ganz oben stehen, vor den allgemeinen oder sogenannten Catch-All-Regeln, die alle anderen URLs auf das CMS umleiten.
Dies ist wichtig, da das CMS andernfalls die URL /collection/detail/... möglicherweise bereits verarbeitet, bevor die KLEKSI-Regel ausgeführt wird.
Erforderliche Serverunterstützung
Das Hinzufügen von [P] zur RewriteRule gibt an, dass die Anfrage als Proxy-Anfrage verarbeitet werden soll. Hierfür muss der Apache-Webserver unter anderem mod_rewrite und die notwendige Proxy-Funktionalität unterstützen. Dies ist in vielen Hosting-Umgebungen gegeben, einige Hosting-Anbieter erlauben jedoch keine Proxy-Regeln in der .htaccess-Datei. Falls die Regel einen Serverfehler verursacht oder die Detailseite nach dem Einfügen nicht angezeigt wird, wenden Sie sich bitte an Ihren Hosting-Anbieter oder Website-Administrator. Bitten Sie diese, einen Apache-Reverse-Proxy über die .htaccess-Datei für /collectie/detail/ zuzulassen.
Verknüpfung Ihres Domainnamens in KLEKSI
Nachdem die oben beschriebenen Einstellungen für die Detailseite Ihrer Website konfiguriert wurden, stellen wir in KLEKSI eine Verbindung zu Ihrer Unternehmensdomain her. Ab diesem Zeitpunkt leitet die Ergebnisseite des KLEKSI-Frontends beim Öffnen eines Objekts automatisch auf die entsprechende Detailseite Ihrer Domain weiter. Besucher, die ein Objekt aus den Suchergebnissen öffnen, bleiben somit vollständig auf Ihrer Unternehmenswebsite und werden nicht auf eine KLEKSI-Domain weitergeleitet. Daher ist es wichtig, dass die technische Konfiguration Ihrer Website korrekt implementiert ist, bevor wir diese Domainverbindung in KLEKSI aktivieren.
Prüfen Sie, ob die Verbindung funktioniert.
Nachdem Sie alle oben genannten Schritte ausgeführt haben, öffnen Sie ein Objekt aus Ihrer Sammlung über das KLEKSI-Frontend. Überprüfen Sie anschließend die URL in der Adressleiste Ihres Browsers. Sie muss weiterhin zu Ihrer eigenen Domain gehören, zum Beispiel:
https://www.jouworganisatie.nl/collectie/detail/12345
Die detaillierten Informationen werden von KLEKSI bereitgestellt, für Besucher und Suchmaschinen ist die Seite jedoch Teil der Website Ihrer Organisation. Dadurch entsteht eine einheitliche, konsistente Umgebung für die öffentliche Sammlung: Sowohl die Suche und Filterung über das KLEKSI-Widget als auch die Detailseiten der einzelnen Objekte werden unter der eigenen Domain Ihrer Organisation angeboten.
Prüfen Sie dies nach Aktualisierungen Ihrer Website oder Ihres CMS.
Nach einem Update Ihres CMS, Themes, Ihrer Hosting-Konfiguration oder Ihrer .htaccess-Datei kann die zuvor konfigurierte RewriteRule geändert oder überschrieben werden. Wenn ein Besucher anschließend eine Objektdetailseite aufruft, kann dies zu einem 404-Fehler führen. Wird diese Fehlermeldung auf der Design- oder Fehlerseite Ihrer Website angezeigt, bedeutet dies in der Regel, dass die RewriteRule fehlt oder nicht korrekt ausgeführt wird und das Problem auf der Website oder dem Webserver liegt. Überprüfen Sie in diesem Fall, ob die RewriteRule noch in der .htaccess-Datei vorhanden und korrekt (am Anfang) platziert ist.
Sollte eine Fehlermeldung von einer KLEKSI-Domain erscheinen, kontaktieren Sie uns bitte. In diesem Fall wird die Anfrage an KLEKSI weitergeleitet, aber es liegt wahrscheinlich ein Fehler auf unserer Seite vor.
Verwenden Sie das Widget auf mehreren Seiten
Das KLEKSI-Widget kann mehrfach innerhalb derselben Website platziert werden. Sie können es beispielsweise auf einer allgemeinen Kollektionsseite, aber auch auf separaten Seiten verwenden, auf denen Sie eine bestimmte Auswahl der Kollektion hervorheben möchten.
Das Widget muss nicht jedes Mal neu konfiguriert werden. Die Auswahl der Objekte kann über die Filter im Frontend erfolgen.
Die Filtereinstellungen sind in der URL enthalten.
Wenn Sie im Frontend einen oder mehrere Filter festlegen, werden diese Filtereinstellungen automatisch in die Seiten-URL eingearbeitet. Wenn Sie beispielsweise einen Filter für eine bestimmte Kollektion, einen Hersteller, einen Objekttyp oder ein anderes verfügbares Filterfeld festlegen, wird eine URL generiert, in der diese Auswahl gespeichert wird. Beim erneuten Öffnen dieser URL wird die gefilterte Auswahl automatisch angezeigt.
Dies ermöglicht es Ihnen, direkt auf eine bestimmte Objektgruppe innerhalb Ihrer eigenen Website zu verlinken. Beispielsweise können Sie von einer Themenseite, einer Ausstellung oder einer Informationsseite einen Link einfügen, der den Besucher direkt zur entsprechenden Auswahl im KLEKSI-Frontend führt.
Siehe spezifische Auswahlen
Auf diese Weise können Sie von verschiedenen Bereichen Ihrer Website aus unterschiedliche Einstiegspunkte zur selben Kollektion anbieten.
Zum Beispiel können Sie:
- Direkter Link von der Künstlerseite zu allen Objekten dieses Künstlers
- Verweisen Sie direkt auf eine bestimmte Unterkollektion von einer Seite über diese Kollektion.
- Öffnen Sie eine vorausgefilterte Auswahl relevanter Objekte von einer Themenseite.
- Verweisen Sie auf eine bestimmte Gruppe von Objekten innerhalb der Sammlung aus Nachrichtenartikeln oder anderen Seiten.
Das zugrundeliegende KLEKSI-Widget bleibt unverändert. Nur die URL bestimmt, welche Filtereinstellungen beim Öffnen der Seite angewendet werden.
Eine gefilterte Auswahl teilen
Dieselbe Methode lässt sich auch verwenden, um eine bestimmte Auswahl mit anderen zu teilen. Wenn beispielsweise jemand Informationen zu einer bestimmten Objektgruppe anfordert, können Sie die gewünschten Filter im Frontend festlegen und anschließend die URL aus der Adressleiste kopieren. Diese URL können Sie per E-Mail, Nachricht oder auf anderem Wege weitergeben. Der Empfänger öffnet dann sofort dieselbe gefilterte Auswahl, ohne die Filter erneut einstellen zu müssen. Dadurch eignet sich die Filterfunktion nicht nur für die Navigation auf Ihrer eigenen Website, sondern auch zum einfachen Teilen bestimmter Teile Ihrer Sammlung.
Seien Sie beim Filterwechsel vorsichtig.
Gemeinsam genutzte oder intern verwendete Filterlinks funktionieren weiterhin korrekt, solange die entsprechenden Filterfelder und Filterwerte in KLEKSI verfügbar sind. Wird ein Filterfeld entfernt, umbenannt oder nicht mehr als Filter angeboten, kann ein zuvor erstellter Link möglicherweise nicht mehr dieselbe Auswahl liefern. Es empfiehlt sich daher, bei Änderungen an der Filterkonfiguration auch die Links auf wichtigen Seiten Ihrer Website zu überprüfen.
- © Copyright KLEKSI - KLEKSI ist ein Produkt von Sofco
- Datenschutzrichtlinien zu
- Cookies
- Developed by Sofco