Referenz:OpenSearch

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

AdultContent[Bearbeiten]

Bedeutung Mit diesem Element kann angegeben worden, ob mögliche Suchresultate ihrem Inhalt nach für Minderjährige nicht geeignet sind.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen.
Inhalt Dieses Element beinhaltet einen boolean-Wert. Werte wie "false", "FALSE", "0", "no" oder "NO" werden als FALSE, alle anderen Werte werden als TRUE angesehen. Der default-Wert ist FALSE.
Attribute Dieses Element hat keine Attribute.

Attribution[Bearbeiten]

Bedeutung Dieses Element beinhaltet Aufstellungen von Hinweisen, die mit Suche verbunden sind/akzeptiert werden.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen.
Inhalt Der Elementeinhalt ist auf 256 Zeichen oder weniger begrenzt.
Attribute Dieses Element hat keine Attribute.

Contact[Bearbeiten]

Bedeutung Dieses Element bezeichnet die Mail-Adresse des Verantwortlichen, unter der dieser erreicht werden kann.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen.
Inhalt Der Elementeinhalt ist auf 256 Zeichen oder weniger begrenzt.
Attribute Dieses Element hat keine Attribute.

Description[Bearbeiten]

Bedeutung Das Element stellt einen Beschreibungstext der Suchmaschine bereit.
Vorkommen Die Angabe dieses Elements ist Pflicht. Es muss im Dokument exakt einmal vorkommen.
Inhalt Er soll für Menschen lesbar und darf maximal 1024 Zeichen lang sein.
Attribute Dieses Element hat keine Attribute.

Developer[Bearbeiten]

Bedeutung Dieses Element enthält eine Bezeichnung oder einen Namen des Erstellers oder Entwicklers des Beschreibungsdokuments.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen.
Inhalt Der Elementeinhalt ist auf 64 Zeichen oder weniger begrenzt und soll für Menschen lesbar sein.
Attribute Dieses Element hat keine Attribute.

Image[Bearbeiten]

Bedeutung Dieses Element ermöglicht es ähnlich einem Web-Dokument mit dem Plug-in ein kleines Bild zu verbinden.
Vorkommen Das Element kann im Dokument kein-, einmal oder mehrmals vorkommen.
Inhalt Der Inhalt ist als URI anzugeben.
Attribute
  • height, die Höhe des Bildes in Pixeln
  • type, der Media-Typ des Bildes
  • width, die Breite des Bildes in Pixeln

InputEncoding[Bearbeiten]

Bedeutung Mit diesem Element können von der Suchmaschine akzeptierte Zeichensatzcodierungen angegeben werden, unter denen der Browser bei Anfragen eine passende auswählt.
Vorkommen Das Element kann im Dokument kein-, einmal oder mehrmals vorkommen.
Inhalt Er stellt eine Zeichenkodierung nach IANA dar. Der default-Wert ist UTF-8.
Attribute Dieses Element hat keine Attribute.

Language[Bearbeiten]

Bedeutung Dieses Element enthält eine Sprache, unter der eine Suchmaschine Ergebnisse auswählen kann.
Vorkommen Das Element kann im Dokument kein-, einmal oder mehrmals vorkommen.
Inhalt Er stellt ein Sprachkürzel nach RFC 3066 dar.
Attribute Dieses Element hat keine Attribute.

LongName[Bearbeiten]

Bedeutung Dieses Element beinhaltet den Titel der Suchmaschine.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen
Inhalt Der Elementeinhalt ist auf 48 Zeichen oder weniger begrenzt.
Attribute Dieses Element hat keine Attribute.

OutputEncoding[Bearbeiten]

Bedeutung Mit diesem Element können von der Suchmaschine Zeichensatzcodierungen der Resultatausgabe angegeben werden, unter denen der Browser bei Anfragen eine passende auswählt.
Vorkommen Das Element kann im Dokument kein-, einmal oder mehrmals vorkommen.
Inhalt Er stellt eine Zeichenkodierung nach IANA dar. Der default-Wert ist utf-8.
Attribute Dieses Element hat keine Attribute.

OpenSearchDescription[Bearbeiten]

Bedeutung Dies ist das Wurzelelement.
Vorkommen Es ist als erstes Element zu deklarien und muss genau einmal vorkommen.
Inhalt Das Element beinhaltet alle anderen Elemente.
Attribute a9.com/-/spec/opensearch/1.1/ deklarieren.

Query[Bearbeiten]

Bedeutung Dieses Element definiert eine Suchanfrage, die der Browser nutzen kann.
Vorkommen Das Element kann im Dokument kein-, einmal oder mehrmals vorkommen.
Inhalt Das Element ist leer.
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[Bearbeiten]

Bedeutung Dieses Element beinhaltet einen kurzen Titel der Suchmaschine.
Vorkommen Dieses Element muss genau einmal enthalten sein.
Inhalt Der Elementeinhalt ist auf 16 Zeichen oder weniger begrenzt.
Attribute Dieses Element hat keine Attribute.

SyndicationRight[Bearbeiten]

Bedeutung Bestimmt, inwieweit die Suchergebnisse der Suchmaschine abgefragt, angezeigt und weitergegeben werden dürfen.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen.
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 Dieses Element hat keine Attribute.

Tags[Bearbeiten]

Bedeutung Dieses Element gibt Schlüsselworte (keywords) zum Kontext der Suchergebnisse an.
Vorkommen Das Element kann im Dokument kein- oder einmal vorkommen.
Inhalt Der Elementeinhalt ist auf 16 Zeichen oder weniger begrenzt. Er besteht aus einer durch Leerzeichen getrennten Liste aus Wörtern.
Attribute Dieses Element hat keine Attribute.

Url[Bearbeiten]

Bedeutung Dieses Element beschreibt die Ressource in Form einer Schnittstelle mittels Templates.
Vorkommen Das Element muss im Dokument mindestens einmal vorkommen.
Inhalt Das Element ist leer.
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.