OpenSearch-Beschreibungsformat
Das OpenSearch-Beschreibungsformat kann verwendet werden, um die Web-Schnittstelle einer Suchmaschine zu beschreiben. Dies ermöglicht es einer Website, eine Suchmaschine für sich selbst zu beschreiben, sodass ein Browser oder eine andere Client-Anwendung diese Suchmaschine nutzen kann. OpenSearch wird von (mindestens) Firefox, Edge, Safari und Chrome unterstützt. (Siehe Referenzmaterial für Links zu Dokumentationen anderer Browser.)
Firefox unterstützt auch zusätzliche Funktionen, die nicht im OpenSearch-Standard enthalten sind, wie Suchvorschläge und das <SearchForm>
-Element. Dieser Artikel konzentriert sich darauf, OpenSearch-kompatible Suchplugins zu erstellen, die diese zusätzlichen Firefox-Funktionen unterstützen.
OpenSearch-Beschreibungsdateien können wie in Autodiscovery von Such-Plugins beschrieben beworben werden.
Warnung:
OpenSearch-Plugins können nicht mehr auf addons.mozilla.org (AMO) hochgeladen werden. Die Suchmaschinenfunktion muss die WebExtension-API mit chrome settings in der manifest.json
-Datei verwenden.
OpenSearch-Beschreibungsdatei
Die XML-Datei, die eine Suchmaschine beschreibt, folgt der untenstehenden grundlegenden Vorlage. Abschnitte in [eckigen Klammern] sollten für das spezifische Plugin, das Sie schreiben, angepasst werden.
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
xmlns:moz="http://www.mozilla.org/2006/browser/search/">
<ShortName>[SNK]</ShortName>
<Description>[Search engine full name and summary]</Description>
<InputEncoding>[UTF-8]</InputEncoding>
<Image width="16" height="16" type="image/x-icon">[https://example.com/favicon.ico]</Image>
<Url type="text/html" template="[searchURL]"/>
<Url type="application/x-suggestions+json" template="[suggestionURL]"/>
<moz:SearchForm>[https://example.com/search]</moz:SearchForm>
</OpenSearchDescription>
- ShortName
-
Ein kurzer Name für die Suchmaschine. Es muss 16 oder weniger Zeichen reinen Textes ohne HTML oder andere Markup enthalten.
- Description
-
Eine kurze Beschreibung der Suchmaschine. Sie muss 1024 oder weniger Zeichen reinen Textes ohne HTML oder andere Markup enthalten.
- InputEncoding
-
Die Zeichenkodierung, die beim Übermitteln von Eingaben an die Suchmaschine verwendet wird.
- Image
-
URL eines Symbols für die Suchmaschine. Wenn möglich, ein 16×16 Bild vom Typ
image/x-icon
(wie z.B./favicon.ico
) und ein 64×64 Bild vom Typimage/jpeg
oderimage/png
einschließen.Die URL kann auch das
data:
URL-Schema verwenden. (Sie können einedata:
-URL aus einer Icon-Datei bei Thedata:
URL kitchen generieren.)xml<Image height="16" width="16" type="image/x-icon">https://example.com/favicon.ico</Image> <!-- or --> <Image height="16" width="16">data:image/x-icon;base64,AAABAAEAEBAAA…DAAA=</Image>
Firefox cached das Icon als base64
data:
URL (Suchplugins werden im Profil-Verzeichnissearchplugins/
gespeichert).http:
undhttps:
URLs werden indata:
URLs konvertiert, wenn dies geschieht.Hinweis: Für Icons, die remote geladen werden (d.h. von
https://
URLs im Gegensatz zudata:
URLs), wird Firefox Icons ablehnen, die größer als 10 Kilobyte sind. - Url
-
Beschreibt die URL oder URLs, die für die Suche verwendet werden. Das
template
-Attribut gibt die Basis-URL für die Suchanfrage an.Firefox unterstützt drei URL-Typen:
type="text/html"
gibt die URL für die eigentliche Suchanfrage an.type="application/x-suggestions+json"
gibt die URL zum Abrufen von Suchvorschlägen an. Ab Firefox 63 wirdtype="application/json"
als Alias dafür akzeptiert.type="application/x-moz-keywordsearch"
gibt die URL an, die verwendet wird, wenn eine Schlüsselwortsuche in der Adressleiste eingegeben wird. Dies wird nur in Firefox unterstützt.
Für diese URL-Typen können Sie
{searchTerms}
verwenden, um die im Suchfeld oder in der Adressleiste eingegebenen Suchbegriffe zu ersetzen. Andere unterstützte dynamische Suchparameter sind in OpenSearch 1.1 Parameter beschrieben.Für Suchvorschläge wird die
application/x-suggestions+json
URL-Vorlage verwendet, um eine Vorschlagsliste im JSON Format abzurufen.
Autodiscovery von Such-Plugins
Websites mit Such-Plugins können diese bewerben, sodass Firefox-Benutzer die Plugins einfach installieren können.
Um Autodiscovery zu unterstützen, fügen Sie ein <link>
-Element für jedes Plugin in den <head>
Ihrer Webseite ein:
<link
rel="search"
type="application/opensearchdescription+xml"
title="[searchTitle]"
href="[pluginURL]" />
Ersetzen Sie die Elemente in [eckigen Klammern] wie unten erläutert:
- searchTitle
-
Der Name der Suche, die durchgeführt werden soll, wie "Search MDC" oder "Yahoo! Search". Dies muss mit dem
<ShortName>
Ihrer Plugin-Datei übereinstimmen. - pluginURL
-
Die URL zum XML-Suchplugin, damit der Browser es herunterladen kann.
Wenn Ihre Seite mehrere Such-Plugins anbietet, können Sie Autodiscovery für alle unterstützen. Zum Beispiel:
<link
rel="search"
type="application/opensearchdescription+xml"
title="MySite: By Author"
href="http://example.com/mysiteauthor.xml" />
<link
rel="search"
type="application/opensearchdescription+xml"
title="MySite: By Title"
href="http://example.com/mysitetitle.xml" />
Auf diese Weise kann Ihre Website Plugins anbieten, um nach Autor oder Titel zu suchen.
Hinweis: In Firefox zeigt eine Änderung des Symbols im Suchfeld an, dass ein bereitgestelltes Suchplugin vorhanden ist. (Siehe Bild, das grüne Pluszeichen.) Wenn also kein Suchfeld in der Benutzeroberfläche des Nutzers angezeigt wird, erhalten sie keine Anzeige. Im Allgemeinen variiert das Verhalten je nach Browser.
Unterstützung automatischer Updates für OpenSearch-Plugins
OpenSearch-Plugins können automatisch aktualisiert werden. Um dies zu unterstützen, fügen Sie ein zusätzliches Url
-Element mit type="application/opensearchdescription+xml"
und rel="self"
hinzu. Das template
-Attribut sollte die URL des OpenSearch-Dokuments sein, auf das automatisch aktualisiert werden soll.
Zum Beispiel:
<Url type="application/opensearchdescription+xml"
rel="self"
template="https://example.com/mysearchdescription.xml" />
Hinweis: Zurzeit unterstützt addons.mozilla.org (AMO) keine automatische Aktualisierung von OpenSearch-Plugins. Wenn Sie Ihr Suchplugin auf AMO einreichen möchten, entfernen Sie die automatische Aktualisierungsfunktion vor der Einreichung.
Tipps zur Fehlerbehebung
Wenn ein Fehler in Ihrer Search Plugin XML-Datei vorliegt, könnten Sie beim Hinzufügen eines erkannten Plugins auf Fehler stoßen. Wenn die Fehlermeldung nicht hilfreich ist, könnten die folgenden Tipps Ihnen helfen, das Problem zu finden.
- Ihr Server sollte OpenSearch-Plugins mit
Content-Type: application/opensearchdescription+xml
bereitstellen. - Stellen Sie sicher, dass Ihre Search Plugin XML-Datei gut formatiert ist. Sie können dies überprüfen, indem Sie die Datei direkt in Firefox laden. Et-Zeichen (&) in der
template
-URL müssen als&
maskiert werden, und Tags müssen entweder mit einem Schrägstrich oder einem passenden End-Tag geschlossen werden. - Das
xmlns
-Attribut ist wichtig — ohne es könnten Sie die Fehlermeldung "Firefox konnte das Suchplugin nicht herunterladen" erhalten. - Sie müssen eine
text/html
URL einfügen — Such-Plugins, die nur Atom oder RSS URL-Typen enthalten (was gültig, aber von Firefox nicht unterstützt ist), erzeugen ebenfalls den Fehler "konnte das Suchplugin nicht herunterladen". - Remotely abgerufene Favicons dürfen nicht größer als 10KB sein (siehe Firefox Fehler 361923).
Zusätzlich bietet der Suchplugin-Dienst einen Protokollierungsmechanismus, der für Plugin-Entwickler nützlich sein kann. Verwenden Sie about:config
, um die Voreinstellung browser.search.log
auf true
zu setzen. Dann erscheinen Protokollierungsinformationen in der Browser-Konsole von Firefox (Werkzeuge ➤ Browser-Werkzeuge ➤ Browser-Konsole), wenn Such-Plugins hinzugefügt werden.
Referenzmaterial
- OpenSearch Dokumentation
- Safari 8.0 Release Notes: Quick Website Search
- Microsoft Edge Dev Guide: Suchanbietersuchein
- The Chromium Projects: Tab to Search
- imdb.com hat eine funktionierende
osd.xml
- Ready2Search - erstellen Sie OpenSearch-Plugins. Angepasste Suche über Ready2Search