Created sumas xml (markdown) authored by Dominik Hebeler's avatar Dominik Hebeler
Die Suche würde ab jetzt funktionieren, allerdings können ohne Suchmaschinen auch keine Ergebnisse gefunden werden. Ich verdeutliche nachfolgend, wie der Zugang zu einer Suchmaschinen-API definiert werden kann:
In der Datei `~/MetaGer/config/sumas.xml` wird jede Suchmaschine durch ein XML Element `<suma />` dargestellt. Der Aufbau ist demnach wie folgt:
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;sumas&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;suma /&gt;
&lt;/sumas&gt;
Jedes einzelne `<suma />` Element benötigt dabei folgende Attribute:
<table>
<tr>
<th>name</th>
<th>value</th>
<th>optional?</th>
</tr>
<tr>
<td>name</td>
<td>eindeutiger name der Suchmaschine</td>
<td>nein</td>
</tr>
<tr>
<td>host</td>
<td>hostname (www.example.com)</td>
<td>nein</td>
</tr>
<tr>
<td>skript</td>
<td>Pfad zum Skript ("/example.php")</td>
<td>nein</td>
</tr>
<tr>
<td>formData</td>
<td>URL-Parameter, die übergeben werden sollen. (`query=&lt;&lt;QUERY&gt;&gt;`; `&lt;&lt;QUERY&gt;&gt;` wird dabei später durch die Sucheingabe ersetzt</td>
<td>nein</td>
</tr>
<tr>
<td>package</td>
<td>Klassenname der Parser-Datei. (example)</td>
<td>nein</td>
</tr>
<tr>
<td>displayName</td>
<td>Welcher Name soll auf der Settings-Seite angezeigt werden?</td>
<td>nein</td>
</tr>
<tr>
<td>homepage</td>
<td>Unter welchem Link ist diese Suchmaschine für die Öffentlichkeit erreichbar. ( https://example.com; wird dem Benutzer unter "/settings" angezeigt) </td>
<td>nein</td>
</tr>
<tr>
<td>port</td>
<td>Port auf dem die API zuhört (80)</td>
<td>ja</td>
</tr>
<tr>
<td>inputEncoding</td>
<td>Encoding in dem die URL-Parameter übertragen werden (Latin1)</td>
<td>ja</td>
</tr>
<tr>
<td>userSelectable</td>
<td>Soll der Benutzer diese Suchmaschine unter "/settings" auswählen können? [0|1] ( Default: 1)</td>
<td>ja</td>
</tr>
<tr>
<td>type</td>
<td>Gehört diese Suchmaschine zu einem Fokus? [web|bilder|nachrichten|produktsuche]</td>
<td>ja</td>
</tr>
<tr>
<td>engineBoost</td>
<td>Wie hochwertig sind die Ergebnisse dieser Suchmaschine? ( Float 0&lt;Wert )</td>
<td>ja</td>
</tr>
<tr>
<td>additionalHeaders</td>
<td>Zusätzliche HTTP-Header, die an die Suchmaschine übergeben werden. "$#!#$" wird in "\r\n" umgewandelt.</td>
<td>ja</td>
</tr>
<tr>
<td>disabled</td>
<td>Ist diese Suchmaschine deaktiviert? [0|1] (Default: 0)</td>
<td>ja</td>
</tr>
</table>
\ No newline at end of file