epub full text search

EPUB-Suche

Suchmaschine für digitale Veröffentlichungen basierend auf EPUB 3

Willkommen! EPUB-Search macht Ihre digitalen Publikationen durchsuchbar.

Was ist der Anwendungsfall:

• Serverseitiger Mikroservice zur Suche nach browserbasierten „Cloud“-Readern in EPUBs
• Für EPUBs, die online leben
• Zur Suche in Ihrem lokalen EPUB-Bestand

Online-Demo

Demo

Enthaltene Funktionen:

• Volltextsuche (alle Abfrageübereinstimmungen für ein Epub-Dokument oder für eine ganze Epub-Sammlung abrufen)
• Automatische Vervollständigung
• Vollständiges Javascript
• Treffer inklusive CFI-Referenzen
• Antwortergebnisse im JSON-Format
• Vorindizierung
• Indizierung im laufenden Betrieb

Installation

Für CLI-Verwendung

 [sudo] npm install epub-full-text-search -g

Zur Bibliotheksnutzung

 $ npm install epub-full-text-search --save

Ausführung als Dienst

CLI

 $ epub-search 

Welcome to Epub search service

Usage: epub-search [action] [options]

Actions:
        start           Start the service
        stop            Stop the service
        logs            Show logs
        writeToIndex    Epub-book(s) which should be written to index.(Hint: the epub content have to be unzipped)

Options:
        -p      Path to epub folder which contains epub-book(s).

Dienst starten

 $ [sudo] epub-search start

Modus operandi

Die EPUB-Suche bietet zwei Vorgehensweisen :

• Die erste Möglichkeit ist die On-the-Fly-Indizierung . Das bedeutet, dass das E-Book beim Öffnen im Hintergrund indiziert wird. Voraussetzung für diesen Modus ist das fernverfügbare EPUB3-Buch. Der generierte Suchindex wird gelöscht, wenn das E-Book geschlossen wird.

• Die zweite Möglichkeit ist die Vorindizierung . Dies bedeutet, dass alle E-Books auf dem lokalen Computer indiziert werden können und der generierte Suchindex während aller Lesesitzungen dauerhaft verfügbar ist. So ist es möglich, die Suchbegriffe in allen indizierten E-Books zu finden.

Indizieren im laufenden Betrieb

Indizierung

 http://localhost:8085/addToIndex?url=${epub}/&uuid=${uuid}

Suchen

 http://localhost:8085/search?q=${term}&uuid=${uuid}

Index löschen

 http://localhost:8085/deleteFromIndex?&uuid=${uuid}

Vorindizierung

Indizierung

Beginnen wir mit der Indizierung einiger EPUBs:

 $ epub-search writeToIndex -p  <path>

Suchen

Suche nach Begriff:

 http://localhost:8085/search?q= ${term} &t= ${EPUB-title} ;

Vorschläge zur automatischen Vervollständigung

 $ http://localhost:8085/matcher?beginsWith= begin-of-the-text-to-match

Beispiele:

Indizierung im laufenden Betrieb

TODO

Vorindizierung

Bitte installieren Sie zunächst epub-search global:

 [sudo] npm install epub-full-text-search -g

Dienst starten:

 $ [sudo] epub-search start

Beispiel-Epubs zum Index hinzufügen:

 epub-search writeToIndex -p {prefix}/node_modules/epub-full-text-search/node_modules/epub3-samples

Jetzt sollten wir einige Treffer für den Begriff epub erhalten:

_{Für Anfragen können Sie $ curl -XGET "http://localhost:8085/search?q=math" oder den Browser verwenden ...}

Suche in der gesamten E-Book-Sammlung:

 http://localhost:8085/search?q=math

Legen Sie den Filter für den Buchtitel t="..." fest, um nur innerhalb eines bestimmten E-Books zu suchen:

 http://localhost:8085/search?q=epub&t=Accessible+EPUB+3

Oder wir holen uns Vorschläge für eine Autovervollständigung:

 http://localhost:8085/matcher?beginsWith=epu

Zur Bibliotheksnutzung

TODO

Klicken Sie auf das Datenformat

TODO

Lokale Tests

Installieren Sie alle abhängigen Module: npm install .

Starten Sie die Demo npm run start . Es sollte einen Express-Server auf Ihrem lokalen Computer ausführen.

Wenn Sie zu http://localhost:8085/ navigieren, können Sie die Demo sehen?.

Hinweis: Der Vorindizierungsprozess startet automatisch und es dauert einige Sekunden, bis die Vorindizierungssuche verfügbar ist.

Technische Details

Die EPUB-Suche nutzt den Suchindex zur Indizierung von Buchinhalten.

Mitwirken

Herzlich willkommen... :-)