Programmable Search Engine mit Konfigurationsdateien erstellen

Auf dieser Seite werden die grundlegenden Konzepte hinter Konfigurationsdateien der Programmable Search Engine vorgestellt.

  1. Übersicht
  2. Was bietet eine programmierbare Suchmaschine?
  3. Zusammenspiel der Komponenten
  4. Suchmaschine erstellen
  5. Programmable Search Engine-Dateien bearbeiten
  6. Das richtige Format auswählen

Überblick

Wenn das Steuerfeld nicht die nötigen Anpassungsmöglichkeiten bietet, sollten Sie das XML-Format für die programmierbare Suche in Betracht ziehen, das Ihnen mehr Kontrolle, Flexibilität und Zugriff auf leistungsfähigere Funktionen bietet.

Wenn Sie die Konfigurationsdateien der Programmable Search Engine verwenden möchten, müssen Sie zuerst über das Steuerfeld der Programmable Search Engine eine einfache Suchmaschine erstellen. Sobald Sie Ihre Suchmaschine erstellt haben, können Sie Ihre Annotationen und Kontext-XML-Dateien im Steuerfeld über die Seite Übersicht herunterladen.

XML-Grundlagen

Extensible Markup Language (XML) ist eine universelle Auszeichnungssprache. Es handelt sich um Text mit Tags, die Sie lesen können. Das XML-Format „Programmable Search“ enthält beispielsweise die Tags <Context> </Context> und <LookAndFeel> </LookAndFeel>.

Wie bei jeder XML-Datei müssen die Spezifikationen der Programmable Search Engine der XML-Syntax (<element attribute="value">content</element>) entsprechen und korrekt formatiert sein. Für XML gelten folgende Regeln:

  • Für XML muss Ihren Tags auf oberster Ebene eine XML-Deklaration (<?xml version="1.0"?>) vorangestellt werden. In der Konfigurationsdatei der Programmable Search Engine ist dies jedoch nicht erforderlich.
  • Alle Elemente müssen ein öffnendes Tag (<tag>) und ein schließendes Tag (</tag>) haben.
  • Alle Tags müssen ordnungsgemäß verschachtelt sein. Du darfst keinen XML-Code haben, der wie folgt aussieht: <sandwich><filling> peanut butter</sandwich></filling>. Sie sollte stattdessen so aussehen: <sandwich><filling> peanut butter</filling></sandwich>.
  • Bei XML wird zwischen Groß- und Kleinschreibung unterschieden. Folgen Sie daher in den Anweisungen genau der Großschreibung und Rechtschreibung der Tags.
  • Alle Attributwerte müssen in doppelte Anführungszeichen (<element attribute="value">) gesetzt werden.
  • Alle Attribute müssen im öffnenden Tag (<element attribute="value">) und nicht im schließenden Tag ( </element>) definiert werden.

Mithilfe von Kommentar-Tags (<!-- your comment here -->) können Sie selbst Notizen erstellen. Die Programmable Search Engine parst diese Textzeile dann nicht als XML-Code. Neben dem Verfassen von Erinnerungen oder Beschreibungen kannst du auch Kommentare verwenden, um XML-Code vorübergehend außer Betrieb zu nehmen (z. B. weil du mit bestimmten Effekten experimentieren oder Probleme beheben möchtest). Diese Kommentare bleiben jedoch nicht in den Dateien erhalten, die Sie vom Steuerfeld herunterladen. Wenn Sie die Kommentare behalten möchten, sollten Sie eine Kopie Ihrer kommentierten XML-Dateien behalten, auch nachdem Sie sie in das Steuerfeld hochgeladen haben.

Sie können einen einfachen Texteditor verwenden, um XML-Dateien zu erstellen und zu bearbeiten. Speichern Sie einfach die Textdatei mit der Dateiendung .xml (z. B. cse_badminton.xml).

Nach oben

Was bietet eine Programmable Search Engine?

Eine Programmable Search Engine besteht aus zwei Hauptkomponenten, die jeweils über eine XML-Datei gesteuert werden:

  • Kontext: Die Kontext-XML-Datei beschreibt die grundlegenden Funktionen einer Suchmaschine. Hier werden die globalen Einstellungen der Suchmaschine festgelegt, z. B. ob die Bildersuche oder bevorzugte Suchergebnisse aktiviert sind. Jede Suchmaschine hat ihre eigene Kontextdatei. Weitere Informationen zur Kontext-XML-Datei Weitere Informationen zur Auswahl des am besten geeigneten Dateiformats für Ihre Suchmaschine finden Sie unter Das richtige Format für Ihre Suchmaschine auswählen.
  • Annotationen: Die Annotations-XML-Datei enthält eine Liste der Webseiten oder Websites, die von Ihrer Suchmaschine abgedeckt werden sollen, sowie alle Präferenzen, die Sie bezüglich der Rangfolge dieser Websites in Ihren Suchergebnissen haben. Jede Website und die zugehörigen Informationen werden als Anmerkungen bezeichnet. Weitere Informationen zur XML-Datei für Anmerkungen

Wir raten davon ab, eine dieser Dateien komplett neu zu erstellen. Laden Sie sie stattdessen von der Seite Übersicht des Steuerfelds herunter.

Neben diesen Hauptkomponenten kann eine Suchmaschine auch über die folgenden Hilfsdateien verfügen:

  • Angebote: Die XML-Datei für bevorzugte Suchergebnisse enthält eine Reihe benutzerdefinierter Ergebnisse, die durch vordefinierte Suchbegriffe ausgelöst werden. Gibt ein Nutzer eine Suchanfrage ein, die genau mit einem Ihrer Suchbegriffe übereinstimmt, wird Ihr bevorzugtes Suchergebnis oben auf der Seite angezeigt. Mithilfe von Angeboten können Sie direkt auf die Suchanfragen Ihrer Nutzer antworten, sie zu wichtigen Informationen weiterleiten oder auf Webseiten verweisen, die sich nicht oben auf der Suchergebnisseite befinden, aber dennoch besonders relevant sind. Im Steuerfeld werden Werbeaktionen auf dem Tab Werbeaktionen definiert. Weitere Informationen zu Angeboten
  • Synonyme: Die XML-Datei für Synonyme erweitert die Suchanfragen Ihrer Nutzer um Varianten des Suchbegriffs. Wenn ein Nutzer beispielsweise nach „Simian“ sucht, sucht die Suchmaschine auch nach „Affe“ und „Affe“. Synonyme werden im Steuerfeld auf dem Tab Synonyme definiert. Weitere Informationen zu Synonymen

Zusammenwirken der Komponenten

Die Kontext-XML-Datei gibt die zu verwendende Annotationsdatei nicht an und die Annotations-XML-Datei verweist nicht auf die Kontextdatei. Die Programmable Search Engine verwendet Labels, um Kontext und Annotationen zu verknüpfen. Die Kontext-XML-Datei enthält Labels, die die Suchmaschine identifizieren, und jede in der Anmerkungs-XML-Datei aufgeführte Anmerkung ist mit einem oder mehreren Labels versehen, die die Suchmaschine(s) identifizieren, zu der sie gehört.Wenn Sie den Namen des Labels in der Kontextdatei ändern, müssen Sie alle Anmerkungen ändern, die mit diesem Label gekennzeichnet wurden.

Obwohl Sie mehrere Anmerkungsdateien hochladen können, führt die Programmable Search Engine beim Herunterladen über das Steuerfeld alle Anmerkungsdateien in einer einzigen Anmerkungsdatei zusammen. Mithilfe der Anmerkungsdateien können Sie eine Website flexibel für verschiedene Suchmaschinen anpassen. Eine Suchmaschine könnte beispielsweise ihre Suche auf einige Websites beschränken, eine andere könnte diese Websites löschen und eine andere könnte diese Websites aufwerten.

context.xml

Hier sehen Sie ein Beispiel für eine context.xml-Datei mit Labels, die die Suchmaschine angeben, auf die sie angewendet wird:

<BackgroundLabels>
  <Label name="_include_" mode="FILTER"/>
  <Label name="_exclude_" mode="ELIMINATE"/>
<BackgroundLabels>

annotations.xml

Hier ein Beispiel für eine Anmerkungsdatei, aus der hervorgeht, wie jede Website (Anmerkung) mit einem Label verknüpft ist:

<Annotation about="code.google.com/*" score="1">
  <Label name="_include_"/>
</Annotation>

Nach oben

Erweiterte programmierbare Suchmaschinen erstellen

Zum Erstellen erweiterter Suchmaschinen sind folgende Schritte erforderlich:

  1. Legen Sie das Format fest, das Ihren Anforderungen entspricht.
  2. Legen Sie die Spezifikationen für Ihre Suchmaschine fest.
  3. Programmable Search Engine mitteilen, welche Websites durchsucht werden sollen
  4. Legen Sie die Rangfolge der Suchergebnisse für die Programmable Search Engine fest.

Programmable Search Engine-Dateien bearbeiten

Wenn Sie an einer XML-Datei arbeiten möchten, laden Sie die XML-Spezifikation auf der Seite Übersicht im Steuerfeld herunter. Starten Sie eine Datei nicht bei null. Gehen Sie dazu so vor:

  1. Laden Sie die Kontext- oder Anmerkungsdatei von der Seite Übersicht im Steuerfeld herunter. Klicken Sie im Bereich Suchfunktionen auf die Schaltfläche Herunterladen.
  2. Verwenden Sie einen Texteditor, der Zeilenende im UNIX-Stil verarbeiten kann (WordPad, Emacs und TextMate funktionieren, NotePad nicht). Es spielt keine Rolle, wie Sie die Datei benennen, solange Sie sie mit der Dateiendung .xml speichern (z. B. cx_global.xml).
  3. Erstellen Sie eine Sicherungskopie der heruntergeladenen Datei für den Fall, dass Ihre bearbeitete Version nicht wie erwartet funktioniert und Sie die vorherige Version wiederherstellen müssen.

    Wenn Sie keine Kopie erstellen und die bearbeitete Version nicht ordnungsgemäß funktioniert, müssen Sie das Debugging Ihrer Datei korrigieren oder Ihre Suchmaschine neu erstellen. Nicht unterhaltsam.

  4. Bearbeiten Sie die XML-Datei und speichern Sie sie. Stellen Sie sicher, dass der Texteditor die Datei als Unicode-Textdokument und nicht in einem anderen Dateiformat speichert.
  5. Laden Sie die Datei auf der Seite Übersicht im Abschnitt Suchfunktionen hoch.

Das richtige Format auswählen

Bevor Sie mit dem Erstellen der Programmable Search Engine beginnen, sollten Sie herausfinden, welches Format Ihren Anforderungen am besten entspricht. Sie sollten kein Format auswählen, das leistungsfähiger und komplexer als nötig ist, und auch kein Format, das Ihnen schnell zunimmt.

Wählen Sie anhand der folgenden Tabelle das geeignete Format aus.

So erstellen Sie Verwenden Because Beschränkungen Weitere Informationen
Eine oder mehrere Suchmaschinen mit wenigen Websites Steuerfeld Sie können Ihre Programmable Search Engine schnell erstellen, indem Sie Textfelder ausfüllen, anstatt Dateien mit einem Texteditor zu erstellen und sie hochzuladen. Über das Steuerfeld können Sie sich mit der Programmable Search Engine vertraut machen und Suchmaschinen mit wenigen Websites erstellen. Einstieg
Komplexe Suchmaschinen, die viele Websites nutzen, und Feeds verwenden Kontextdatei und Anmerkungsdateien

Mit den Programmable Search Engine-Dateien haben Sie mehr Kontrolle über Ihre Suchmaschinen und erleichtern die Definition und Verwaltung von Websites erheblich.

Auch wenn Sie Ihre Suchmaschine mithilfe von Kontext- und Anmerkungsdateien erstellen möchten, ist es dennoch ratsam, sich mit dem Steuerfeld vertraut zu machen.

 Je mehr Sie Ihre Suchmaschine anpassen, desto komplexer wird sie. Sie müssen sich mit den programmierbaren Suchelementen und -attributen vertraut machen, die nicht schwer zu verstehen sind, aber einen gewissen zeitlichen Aufwand erfordern.

Sie müssen den Rest des Entwicklerhandbuchs lesen, dieser ist leider nicht das spannendste Lesematerial.

 Kontext: Spezifikationen der Suchmaschine definieren und Annotationen: Websites auswählen

Nach oben