OpenService-Formatangabe für Schnellinfos - Version 0.8

Neu für Windows Internet Explorer 8

Schnellinfos sind ein Kontextdienst für Zugriff auf und Abruf von Dienstinformationen auf jeder beliebigen Webseite. Eine Schnellinfo wird mit dem OpenService-Format beschrieben. In ähnlicher Weise, wie die OpenSearch-Beschreibung einen Suchanbieter beschreibt, kann das OpenService-Format verwendet werden, um einen beliebigen Dienstanbieter zu beschreiben.

  • Beschreibung – Die Dienstschnittstelle, die die Funktionalität eines Dienstanbieters angibt.
  • Datei - Die genaue Beschreibung eines Dienstanbieters aufgrund der Vorlage für den bereitgestellten Diensttyp.

In diesem Dokument werden die Mindesteigenschaften behandelt, die benötigt werden, um die Veröffentlichung und den Verbrauch einer Schnellinfo zu aktivieren.

OpenService-Format

Das OpenService-Format beschreibt den Kernsatz von Eigenschaften für einen Dienst.

Beispiel:

Dies ist ein Beispiel für das Beschreiben einer Zuordnungsschnellinfo mit dem OpenService-Format.

<?xml version="1.0" encoding="UTF-8"?>
<openServiceDescription
    xmlns="http://www.microsoft.com/schemas/openservicedescription/1.0">
    <homepageUrl>http://maps.live.com</homepageUrl>
    <display>    
        <name>Map with Windows Live</name>
        <icon>http://www.live.com/favicon.ico</icon>
    </display>
    <activity category="Map">
        <activityAction context="selection" >
            <preview action=" http://maps.live.com/geotager.aspx">
                <parameter name="b" value="{selection}" /> 
                <parameter name="clean" value="true" /> 
                <parameter name="w" value="320" /> 
                <parameter name="h" value="240" /> 
            </preview>
            <execute action=" http://maps.live.com/default.aspx">
                <parameter name="where1" value="{selection}" type="text" /> 
            </execute>
        </activityAction>
    </activity>
</openServiceDescription>

Das "OpenServiceDescription"-Element

Der Stammknoten des OpenService-Dokuments.

Übergeordnetes Element: Ohne

Anforderungen: Das Element muss genau einmal als Stammknoten des Dokuments angezeigt werden.

Namespace – Dieser Namespace definiert alle Elemente in dieser Spezifikation http://www.microsoft.com/schemas/openservicedescription/1.0

Das "homepageURL"-Element

enthält die URL der Homepage des Dienstanbieters.

Übergeordnetes Element: openServiceDescription

Anforderungen: Dieses Element darf nur einmal vorkommen.

Das "Display"-Element

enthält die Anzeigeeigenschaften, die dem Benutzer angezeigt werden.

Übergeordnetes Element: openServiceDescription

Anforderungen: Dieses Element darf nur einmal vorkommen.

Das Element "Name"

enthält den Namen des Diensts. Es sollte eigenständig sein und den Dienst kurz beschreiben.

Es wird empfohlen, das Verb voranzustellen - gefolgt von dem Namen des Diensts .

Übergeordnetes Element: display

Anforderungen:

  • Dieses Element darf nur einmal vorkommen.
  • Der Wert darf höchstens 50 Nur-Text-Zeichen enthalten.
Beispiele:
<name>Map with Windows Live</name>
						
<name>Define with Encarta</name>

Das "Symbol"-Element

enthält eine URL, die die Position des Symbols identifiziert, das in Verbindung mit dem Dienst verwendet werden kann.

Übergeordnetes Element: Anzeige

Anforderungen: Es kann null oder eine Instanz dieses Elements geben.

Beispiel:
<icon>http://www.live.com/favicon.ico</icon>

Das Element "Beschreibung"

enthält eine kurze Beschreibung des Diensts.

Übergeordnetes Element: Anzeige

Anforderungen:

  • Es kann null oder eine Instanz dieses Elements geben.
  • Der Wert darf höchstens 250 Nur-Text-Zeichen enthalten.

Schnellinfobeschreibung

In diesem Abschnitt wird die Schnellinfobeschreibung behandelt.

Das "Activity"-Element

enthält die spezifischen Informationen für den Schnellinfodienst.

Übergeordnetes Element: openServiceDescription

Anforderungen: Dieses Element muss genau einmal vorkommen.

Das 'category'-Attribut

enthält den Typ der Schnellinfo. Dies wird in Verbindung mit der Domäne des "homepageUrl"-Elements als Identifikation einer Schnellinfo verwendet.

Anforderungen: Der Wert muss Nur-Text sein.

Es wird empfohlen, eine Kategorie wiederzuverwenden, die von anderen ähnlichen Anbietern verwendet wird. Alle Zuordnungsanbieter sollten z. B. die Kategorie "Zuordnung" verwenden.

Beispiel:
<activity category="map">

Das "ActivityAction"-Element

enthält die Informationen zum bestimmten Kontext.

Übergeordnetes Element: Aktivität

Anforderungen: Dieses Element muss mindestens einmal vorkommen.

Das "Kontext"-Attribut

enthält, worauf die Schnellinfo wirken sollte: die Benutzerauswahl, das aktuelle Dokument oder die ausgewählte URL.

Anforderungen:

  • Dieses Attribut kommt möglicherweise einmal vor.
  • Der Wert muss entweder "Auswahl", "Dokument" oder "Link" sein.
  • Der Standardwert ist "Auswahl".
Beispiel:
<activityAction context="selection">

Das Vorschau-Element

enthält die Informationen zum Anzeigen einer Webseite in der Vorschau. Der zurückgegebene Inhalt muss als HTML vorliegen und in ein Fenster mit 320 Breite x 240 Höhe passen.

Übergeordnetes Element: activityAction

Anforderungen: Das Element kann einmal vorkommen.

Das "action"-Attribut

enthält die URL-Vorlage, mit der die Webseite zur Vorschau der Schnellinfo veranlasst wird. Der Abschnitt Schnellinfo-URL-Vorlage enthält weitere Details.

Anforderungen: Dieses Attribut muss einmal vorkommen.

Das Attribut "method"

enthält den Typ der HTTP-Übergabe zum Anzeigen der Webseite in der Vorschau.

Anforderungen:

  • Dieses Attribut kommt möglicherweise einmal vor.
  • Der Wert muss entweder "abrufen" oder "bereitstellen" sein.
  • Der Standardwert ist "abrufen".
Das Attribut "Verschlüsselungstyp"

enthält den Inhaltstyp zur Datenübermittlung an den Server, wie von der HTML-Formularübertragung definiert.

Anforderungen:

  • Dieses Attribut kommt möglicherweise einmal vor.
  • Der Wert muss eine unterstützte Formularinhaltstypen sein URL
  • Der Standardwert ist "application/x-www-form-urlencoded"
Das 'accept-charset'-Attribut

enthält die Zeichencodierung, die für die Datenübermittlung an den Server verwendet werden soll, wie von der HTML-Formularübertragung definiert.

Anforderungen:

  • Dieses Attribut kommt möglicherweise einmal vor.
  • Der Wert muss ein unterstützter Zeichensatz sein.
  • Der Standardwert ist "utf-8".

Das Element "Ausführen"

enthält die Informationen zum Ausführen einer Schnellinfo.

Übergeordnetes Element: activityAction

Anforderungen: Dieses Element muss einmal vorkommen.

Das Element "Ausführen" verwendet den gleichen Attributsatz wie das Vorschauelement.

Das "Parameter"-Element

enthält den Parameternamen und die dazugehörigen Werte für die Aktions-URL. Der Parameterwert kann auf eine Schnellinfovariable verweisen. Der Abschnitt Schnellinfo-URL-Vorlage enthält weitere Details.

Übergeordnetes Element: Vorschau - ausführen

Anforderungen: Es kann null oder eine Instanz dieses Elements geben.

Das Attribut "Name"

enthält den Namen des zu verwendenden Parameters.

Anforderungen: Dieses Attribut muss einmal vorkommen.

Das "Value"-Attribut

enthält den Wert des zu verwendenden Parameters. Der Wert kann auf eine Schnellinfovariable verweisen.

Anforderungen: Dieses Attribut muss einmal vorkommen.

Das Typattribut

beinhaltet, wie die Schnellinfovariable {selection} transformiert wird.

Anforderungen:

  • Es kann null oder eine Instanz dieses Attributs geben.
  • Der Wert muss entweder "text" oder "html" sein.
  • Der Standardwert ist "text".
Beispiel:
<parameter name="body" value="{selection}" type="html" />
Sicherheitshinweis Sicherheitswarnung  Wenn Sie eine Schnellinfo erstellen, die einen {selection}-Parameter des Typs "html" verwendet, dann muss der Dienst explizit eingerichtet werden, um eine beliebige HTML-Eingabe ordnungsgemäß zu bereinigen und zu behandeln. Webdienste, die willkürliche Eingaben ohne Filterung oder Codierung ermöglichen, sind für HTML-/Skripteinschleusungsangriffe anfällig. Weitere Informationen finden Sie im Abschnitt "Selection Types" des Entwicklerhandbuchs OpenService Accelerators Developer Guide.

Schnellinfo-URL-Vorlage

Die Schnellinfo-URL-Vorlage stellt an den Dienstanbieter zu übergebenden Inhalt dar. Es gibt zwei Möglichkeiten, Parameter in einer URL-Vorlage zu definieren: inline- und formularbasierte Parameter

Beispiele

Dies ist ein Beispiel für eine Schnellinfo-URL-Vorlage mit Inlineparameter.

<execute action="http://encarta.msn.com/encnet/refpages/search.aspx?q={selection}" />

Dies ist ein Beispiel für eine Schnellinfo-URL-Vorlage mit formularbasiertem Parameter.

<execute action="http://encarta.msn.com/encnet/refpages/search.aspx">
    <parameter name="q" value="{selection}" type="html" />
</execute>

Variablen

Variablen sind Eigenschaften innerhalb der Webseite. Auf Variablen wird mit geschweiften Klammern verwiesen {}.

Die {selection}-Variablestellt die Benutzerauswahl innerhalb der Webseite dar.
Die {documentUrl}-Variablestellt die URL der Webseite dar, wo die Schnellinfo aufgerufen wird.
Die {documentTitle}-Variablestellt den Titel der Webseite dar, wo die Schnellinfo aufgerufen wird.
Die {documentDomain}-Variablestellt die Domäne der höchsten Ebene der "documentUrl"-Variablen dar.
Die {documentHost}-Variablestellt die vollqualifizierte Domäne der "documentUrl"-Variablen dar.
Die {link}-Variablestellt die URL der vom Benutzer ausgewählten URL dar.
Die {linkText}-Variablestellt den Text der vom Benutzer ausgewählten URL dar.
Die {linkRel}-Variablestellt die Beziehung der vom Benutzer ausgewählten URL dar.
Die {linkType}-Variablestellt den MIME-Typ der vom Benutzer ausgewählten URL dar.
Die {linkDomain}-Variablestellt die Domäne der höchsten Ebene der vom Benutzer ausgewählten URL dar.
Die {linkHost}-Variablestellt die vollqualifizierte Domäne der vom Benutzer ausgewählten URL dar.

Optionale Variablen

Alle Variablen werden nach Bedarf behandelt, außer es handelt sich um den Modifizierer "?". Eine optionale Variable, die nicht aufgelöst werden kann, wird als leere Zeichenfolge für eine parametrisierte Inline-URL behandelt. In einer formularbasierten parametrisierten URL wird das ganze Parameterelement ignoriert.

Beispiel für eine optionale Variable in einer parametrisierten Inline-URL:

<execute action="http://encarta.msn.com/encnet/refpages/search.aspx?q={selection?}" />

Escapezeichen

Um { and } wörtlich anzugeben, verwenden Sie zur Darstellung einen umgekehrten Schrägstrich \. Ein umgekehrter Schrägstrich kann verwendet werden, um ein beliebiges Zeichen darzustellen.

\{{selection}\}

Erweiterbarkeit

Das OpenService-Format und die Schnellinfobeschreibung können durch die Verwendung der W3C XML Namespace-Spezifikations URL -Konvention erweitert werden. Der XML-Namespace muss sich vom OpenService-Namespace unterscheiden.

Lizenzinformationen

Die Lizenzierung der Urheberrechte von Microsoft an dieser Spezifikation unterliegen der Creative Commons Attribution-Share Alike License (Version 3.0). Eine Kopie dieser Lizenz wird angezeigt unter http://creativecommons.org/licenses/by-sa/3.0 URL. Es gibt eine separate Patentzusage, Microsoft Open Specification Promise genannt, die Interessenten zur Verfügung steht, die Software implementieren wollen, die dieser Spezifikation entspricht. Diese Patentzusage ist unter folgendem Speicherort verfügbar: http://www.microsoft.com/interop/osp/default.mspx.

Überarbeitungen

Version 0.8 (Beta 2)

  • In OpenService-Schnellinfos umbenannte OpenService-Aktivitäten
  • Abschnitt 'Escapezeichen' hinzufügen
  • Kleinere Fehler beheben.

Version 0.8

  • Erste Version

Community-Beiträge

Anzeigen: