regain manual

**Dies ist eine alte Version des Dokuments!** ----

= Web-Oberfläche = Die beiden **regain**-[[Vergleich_der_regain-Varianten|Versionen]] nutzen [http://de.wikipedia.org/wiki/JSP JSP] (JavaServer Pages), [http://de.wikipedia.org/wiki/XML XML] ( [[TagLib-Tags|TagLibrary]]) und [http://de.wikipedia.org/wiki/Css CSS] für die im Browser angezeigte/gerenderte Benutzeroberfläche. Die Auslieferung dieser dynamischen Seiten an den Browser erledigt der [[Server]]. Diese weitgehende Trennung von Benutzeroberfläche/Darstellungsschicht und eigentlichem Programmcode gibt dem Anwender viel Spielraum zum Gestalten (skinning) der regain-Suchmaschine. Die relevanten Dateien der Web-Oberfläche sind: ;CSS-Datei: ''regain.css'' ;[[Suchmaske]]: ''search.jsp '' ;[[Erweiterte Suche]]: ''advancedsearch.jsp'' ;Startseite: ''index.jsp'' bzw. ''..web/searchinput.jsp'' ;[[Crawler]]-Statusanzeige: ''status.jsp'' ;[[Crawler]]-Konfiguration: ''config.jsp'' nur bei der Desktop-Suche Die Dateien liegen bei der [[Desktop:Installation|Desktop-Suche]] im Unterverzeichnis ''web'', bei der [[Server:Installation|Server-Suche]] in ''runtime/search/webapps/regain.war'' ------------------------------ = Suchmaske = Die **Suchmaske** ist ein zentraler Teil der [[Web-Oberfläche]], die Suchanfragen entgegennimmt, sie ausführt und die Ergebnisse seitenweise anzeigt. Bevor man mit der Suchmaske etwas suchen kann, muss erst mit Hilfe des [[Crawler]]s ein [[Suchindex]] erstellt werden! Technisch gesehen ist die Suchmaske eine Reihe von JSP-Seiten, die eine TagLibrary für die dynamischen Teile nutzen. Wenn Sie regain [[Server-Suche | auf einem Webserver einsetzen]] wollen, dann brauchen Sie daher eine Servlet-Engine wie [http://jakarta.apache.org/tomcat Tomcat] oder [http://jetty.mortbay.org/jetty Jetty], um die Suchmaske auszuführen. Die [[Desktop-Suche]] nutzt eine eigens entwickelte, sehr schlanke JSP-Engine, die auf [http://simpleweb.sourceforge.net Simple] aufbaut. Diese kann jedoch nur [[TagLib-Tags]] verarbeiten, keinen in JSPs eingebundenen Java-Code. Dafür hat sie auch eine Größe von nur rund 200kB und nicht von über 10MB, wie bei "echten" Servlet-Engines, was für eine Desktop-Suche einfach zu viel wäre. Die Suchanfrage ist ein URL-String mit folgenden Parametern, die via &-zeichen verkettet werden: * **index** - der Index oder eine Aufzählung von Indexen, wo gesucht wird * **query** - die eigentliche Suchanfrage * **field.*** - Das Prefix "field." bezieht weitere [[Suchindex#Standardfelder|Suchfelder]] * des [[Suchindex]] ein, :z.B. entspricht die URL ''...?query=test&field.extension=pdf&field.title=otto'' :der Anfrage ''test extension:"pdf" title:"otto"''. * **maxresults** - Anzahl Suchergebnisse pro Seite (Voreinstellung ist 10). * **fromresult** - Nummer des ersten Suchergebnisses (beginnend bei 0). ------------------------------- = Server = Mit der [[Web-Oberfläche|Benutzeroberfläche]] / [[Suchmaske]] von **regain** können Sie den [[Suchindex]] abfragen sowie teilweise den [[Crawler]] konfigurieren. Sie wird als interaktive, dynamische HTML-Seiten realisiert. Der **Server** liefert diese [[Web-Oberfläche]] auf entsprechende http-Anfrage zur Anzeige in einem Webbrowser aus. In der [[Desktop-Suche]] wird dazu [http://simpleweb.sourceforge.net Simple] als integrierter Server verwendet, http-Port ist localhost:8020 (s.a. [[DesktopConfiguration.xml]]). Die [[Server:Installation|Server-Suche]] erfordert eine Servlet-Engine wie [http://jakarta.apache.org/tomcat Tomcat] oder [http://jetty.mortbay.org/jetty Jetty], die z.B auf http-Port ''<server>:8020'' antwortet.