Tutorial: OpenSearch

OpenSearch ist ein Standard, der von Amazon definiert wurde um individuelle Suchmaschinen in das Browser-Suchfeld einzufügen. Implementiert man also OpenSearch beispielsweise im eigenen Blog, können die Leser direkt über das Browser-Suchfeld das Blog durchsuchen. Hier zeige ich, wie man OpenSearch in die eigene Website integriert.

OpenSearch wird vom Microsoft Internet Explorer ab Version 7 und von Mozilla Firefox ab Version 2 unterstützt.

Die Datei „opensearch.xml“

Diese XML-Datei beschreibt dem Browser, wie die eigene Suche heißt, wo das passende Icon zu finden ist und wie die Parameter für einen Suchvorgang lauten.

Hier ein Beispiel für meine Website

<?xml version="1.0" encoding="UTF-8"?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/">
  <ShortName>Labuschin Webdesign</ShortName>
  <Description>Labuschin Webdesign Search</Description>
  <Url type="text/html" method="get" template="http://labuschin.com/search?q={searchTerms}&sourceid=opensearch"/>
  <Image width="16" height="16" type="image/x-icon">http://labuschin.com/favicon.ico</Image>
  <InputEncoding>UTF-8</InputEncoding>
  <moz:SearchForm>http://labuschin.com</moz:SearchForm>
  <moz:UpdateUrl>http://labuschin.com/opensearch.xml</moz:UpdateUrl>
  <moz:IconUpdateUrl>http://labuschin.com/favicon.ico</moz:IconUpdateUrl>
  <moz:UpdateInterval>7</moz:UpdateInterval>
</OpenSearchDescription>

Man kann diesen Code als Vorlage nehmen und ihn entsprechend für die eigene Seite anpassen. Ich empfehle, die Datei im Root-Verzeichnis der Domain abzulegen.

Den Besucher darauf aufmerksam machen

Es gibt zwei verschiedene Wege, die Suche der eigenen Website dem Browser-Suchfeld anzubieten. Beide Methoden lassen sich gleichzeitig einsetzen.

1. Das Link-Element „search“

Die erste Maßnahme ist ein Link-Element, welches man sehr gut auf jeder Unterseite im Head-Element hinzufügen kann.

<link rel="search" type="application/opensearchdescription+xml" href="http://labuschin.com/opensearch.xml" title="Labuschin Webdesign"/>

Das Link-Element sorgt schon beim Aufruf der Seite dafür, dass der Browser die Suche als solche erkennt - auch ohne Suchfeld auf der aktuellen Seite. Im Firefox macht sich das so bemerkbar:

2. Der Link zum Hinzufügen

Man kann dazu noch einen Link im Inhalt der Seite hinzufügen, der dem Browser des Besuchers auf Klick die Suche hinzufügt. Für das Ausführen des Links ist Javascript erforderlich.

<a href="javascript:if(typeof(window.external)=='object'){try{window.external.AddSearchProvider('http://labuschin.com/opensearch.xml');}catch(e){alert('Dein%20Browser%20unterstützt%20diese%20Funktion%20leider%20nicht.%20Die%20Funktion%20wird%20von%20IE7+%20und%20FF2+%20unterstützt.');}};void(0);">
  „Labuschin Webdesign“ als Suche installieren
</a>

Wichtig hierbei sind zwei Dinge:

Die URL hinter „AddSearchProvider“ muss vollständig sein und funktioniert nicht allein mit absoluten oder relativen Pfaden.
Der String im Alert-Befehl darf keine Leerzeichen enthalten. Ersatz: %20

Der Text-Link eignet sich meiner Meinung nach auf einer Suchergebnisseite. Dort könnte man dem Besucher die Suche in etwa so anbieten: „Suchst du öfter bei Labuschin Webdesign? Installiere die Suche in deinem Browser-Suchfeld!“

Fazit

Wie ihr seht, ist dieses Feature relativ einfach zu implementieren und kann vielleicht dazu führen, dass mehr Besucher die Suche der eignenen Webiste/des eigenen Blogs nutzen. Schaden kann es jedenfalls nicht.

veröffentlicht am 21.02.2010 um 18:29 von Martin Labuschin in XML, Suchmaschinen