OpenSearch

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

OpenSearch wurde von Amazon.com, Inc. und seinem Tocherunternehmen A9.com, Inc., einem Spezialisten für kommerzielle Website-Suchen ins Leben gerufen. Heute werden diese Spezifikationen und Programmbibliotheken, die spezielle Suchanfragen, die auf das HTT-Protokoll aufsetzen, generieren bzw. verarbeiten von einer Community betreut.

Allgemeines/Formate — Suchmaschinen-Plugin

Allgemein stellt ein Suchmaschinen-Plugin die Beschreibung der Schnittstelle einer Suchmaschine bereit. Dabei kann eine Suchmaschine von Großanbietern wie google, yahoo oder bing gemeint sein. Genauso aber kann eine Suchmaschine auch eine web- oder projektinterne Suche wie beispielsweise http://forum.selfhtml.org/search bezeichnen. Im Sinne dieser Dokumentation sind Suchmaschinen also unbestimmte Programme, die eine Suche bereitstellen und deren Schnittstelle beschrieben wird.

Unabhängig vom Format ist die Idee hinter allen Plugins, dem Browser mittels einer Beschreibungsdatei bzw. einem Beschreibungsdokument die Schnittstelle zugänglich zu machen. Unter Zuhilfenahme der dortigen Angaben kann ein Browser daraufhin seine Anfragen so stellen, dass sie die Suchmaschine verarbeiten kann.

Das erste Format, was Beschreibungen dieser Art bereitstellte, war das von Apple konzipierte Sherlock-Format aus dem Jahre 1999 (Spezifikation). Später kam das OpenSearch-Format dazu, was sich mehr und mehr durchsetzt. Darüber hinaus entwarfen Browser-Entwickler eigene Dialekte, die sich jedoch teilweise nur für den entsprechenden Browser nutzen lassen.

Im Folgenden wird nur das OpenSearch-Format (Spezifikation) wegen seiner breiten Unterstützung in den einzelnen Browsern näher erläutert. Das Beschreibungsdokument ist hierbei ein XML-Dokument.

Referenz

OpenSearch.org: Spezifikation


AdultContent
Bedeutung gibt an, ob mögliche Suchresultate ihrem Inhalt nach für Minderjährige nicht geeignet sind.
Vorkommen höchstens 1
Inhalt boolean, default FALSE
Attribute keine
Attribution
Bedeutung Aufstellungen von Hinweisen, die mit Suche verbunden sind bzw. akzeptiert werden
Vorkommen höchstens 1
Inhalt maximal 256 Zeichen
Attribute keine
Contact
Bedeutung Mail-Adresse des Verantwortlichen
Vorkommen höchstens 1
Inhalt maximal 256 Zeichen
Attribute keine
Description
Bedeutung Beschreibungstext der Suchmaschine
Vorkommen genau 1 (Pflichtelement)
Inhalt für Menschen lesbar, maximal 1024 Zeichen
Attribute keine
Developer
Bedeutung Bezeichnung oder Name des Erstellers oder Entwicklers des Beschreibungsdokuments
Vorkommen höchstens 1
Inhalt für Menschen lesbar, maximal 64 Zeichen
Attribute keine
Image
Bedeutung verbindet das Plug-in mit einem kleinen Bild
Vorkommen beliebig oft
Inhalt URI
Attribute
  • height, die Höhe des Bildes in Pixeln
  • type, der Media-Typ des Bildes
  • width, die Breite des Bildes in Pixeln
InputEncoding
Bedeutung gibt akzeptierte Zeichensatzcodierungen an, der Browser wählt eine passende
Vorkommen beliebig oft
Inhalt Zeichenkodierung nach IANA, default UTF-8
Attribute keine
Language
Bedeutung Sprache, unter der eine Suchmaschine Ergebnisse auswählen kann
Vorkommen beliebig oft
Inhalt Sprachkürzel nach RFC 3066
Attribute keine
LongName
Bedeutung Titel der Suchmaschine
Vorkommen höchstens 1
Inhalt maximal 48 Zeichen
Attribute keine
OutputEncoding
Bedeutung Zeichensatzcodierungen der Resultatausgabe, Browser wählt eine passende
Vorkommen beliebig oft
Inhalt Zeichenkodierung nach IANA, default UTF-8
Attribute keine
OpenSearchDescription
Bedeutung Wurzelelement
Vorkommen genau 1, erstes Element
Inhalt alle anderen Elemente
Attribute
  • xmlns
Query
Bedeutung Suchanfrage, die der Browser nutzen kann
Vorkommen beliebig oft
Inhalt leeres Element
Attribute
  • count, enthält die Ergebnisanzahl in Ziffern, die der Browser pro Seite wünscht
  • inputEncoding, enthält die Zeichencodierung nach IANA, in der die Daten der Suchanfrage erwartet werden
  • language, enthält die Sprachangabe nach RFC 3066, in welcher der client Resultate wünscht
  • outputEncoding, enthält die Zeichencodierung nach IANA, in der die Daten der Antwort erwartet werden
  • role, Dieses Attribut muss für jedes Element Query angegeben sein. Es beschreibt, in welcher Relation der Browser die Angaben dieses Elements zu setzten hat. Folgende Werte kann das Attribut annehmen:
    • correction, stellt Angaben zu einer Anfrage dar, die als (Rechtschreib-)Korrektur gestellt werden kann
    • example, gibt Angaben zu einer Anfrage an, die zu Demonstrationszwecken der Suchmaschine dient
    • related, gibt Angaben zu einer Anfrage an, die ähnlich ist, aber zu anderen Suchergebnissen führt
    • request, gibt Angaben zu einer Anfrage an, die zu selben Suchergebnissen führt. Im allgemeinen wird dem Browser so seine gestellte Anfrage in einem Response-Dokument parametrisiert gespiegelt
    • subset, gibt Angaben zu einer Anfrage an, die eine Eingrenzung innerhalb der Suchergebnissen betrifft.
    • superset, gibt Angaben zu einer Anfrage an, die eine Erweiterung über die Suchergebnisse hinaus betrifft.
    • searchTerms, enthält die url-codierte Suchanfrage; also die Begriffe der Suchanfrage.
    • startIndex, enthält die Indexanfangsnummerierung als Ziffer, die für das erste Suchergebnis vom Browser erwartet wird. Als default wird der Wert vom indexOffset-Attribut des Url-Elements genutzt.
    • startPage, enthält die Seitenzahl als Ziffer der Suchergebnisse, die aufgeschlagen werden soll. Als default wird der Wert vom pageOffset-Attribut des Url-Elements genutzt.
    • title, enthält klartextformatiert eine maximal 256 Zeichen lange Beschreibung der Suchergebnisse.
    • totalResults, enthält die Ergebnisanzahl als Ziffer.
ShortName
Bedeutung kurzer Titel der Suchmaschine
Vorkommen genau 1
Inhalt maximal 16 Zeichen
Attribute keine
SyndicationRight
Bedeutung bestimmt, inwieweit die Suchergebnisse der Suchmaschine abgefragt, angezeigt und weitergegeben werden dürfen
Vorkommen höchstens 1
Inhalt Der mögliche Inhalt dieses Elements ist fest vorgegeben:
  • closed, es sollten keine Anfragen gestellt werden
  • limited, Anfragen können gestellt, Resultate auch darstellt, jedoch diese nicht an Dritte weitergeben werden
  • open, Anfragen können gestellt, Resultate auch darstellt und an Dritte weitergeben werden
  • private, Anfragen können gestellt, Resultate aber nicht darstellt oder an Dritte weitergeben werden
Attribute keine
Tags
Bedeutung Schlüsselworte (keywords) zum Kontext der Suchergebnisse
Vorkommen höchstens 1
Inhalt maximal 256 Zeichen, durch Leerzeichen getrennte Liste
Attribute keine
Url
Bedeutung Ressource in Form einer Schnittstelle mittels Templates
Vorkommen mindestens 1
Inhalt leeres Element
Attribute
  • indexOffset, die Indexzahl des ersten Suchergebnis. Default-Wert ist 1. Als Werte können nur positive Ziffern angegeben werden.
  • pageOffset, die Seitenzahl des ersten Suchergebnise. Default-Wert ist 1. Als Werte können nur positive Ziffern angegeben werden.
  • template, enthält den URL, der zur Suchmaschine führt und mit einer Templatesyntax vom Client verarbeitet werden muss. Dieses Attribut muss enthalten sein.
  • type, enthält den Media-Typen der Ressource, die die Suchmaschine als Antwort servieren wird. Dieses Attribut muss enthalten sein.
  • rel, die Werte dieses Attributs sind definiert. Es können, durch Leerzeichen von einander getrennt, mehrere der folgenden Werte angegeben werden:
    • collection, die angegebenen URLs stellen einen ganzen Satz verschiedener Ressourcen dar.
    • results, der angegebene URL nimmt Anfragen in der durch das template-Attribut bezeichneten Form entgegen. Dies ist der default-Wert.
    • self, bezeichnet den URL des Beschreibungsdokuments selbst. Wird dies angegeben, nutzt der Firefox die Angabe, um selbständig nach updates des Beschreibungsdokuments zu suchen.
    • suggestions, der angegebene URL nimmt Anfragen nach der Suggestions-Erweiterung spezifizierten Form entgegen.

Weblinks

Abgerufen von „http://wiki.selfhtml.org/index.php?title=OpenSearch&oldid=86031“