epub full text search

EPUB検索

EPUB 3 に基づく電子出版物用の検索エンジン

いらっしゃいませ！ EPUB-Search を使用すると、デジタル出版物を検索できるようになります。

使用例は何ですか:

• EPUB 内のブラウザベースの「クラウド」リーダーを検索するサーバー側マイクロサービス
• オンラインで公開されている EPUB の場合
• ローカルの EPUB ストック内を検索するには

オンラインデモ

デモ

含まれる機能:

• 全文検索 (1 つの epub ドキュメントまたは epub コレクション全体のすべてのクエリ一致を取得)
• オートコンプリート
• 完全なJavaScript
• CFI リファレンスを含むヒット曲
• JSON形式の応答結果
• 事前インデックス作成
• オンザフライでのインデックス作成

インストール

CLI で使用する場合

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

図書館利用の場合

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

サービスとして実行する

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).

サービス開始

 $ [sudo] epub-search start

手口

EPUB 検索には 2 つの方法があります。

• 1 つ目は、オンザフライでのインデックス作成です。これは、電子ブックを開いたときにバックグラウンドでインデックスが作成されることを意味します。このモードは、リモートで利用できる EPUB3 ブックを前提としています。生成された検索インデックスは、電子ブックを閉じると削除されます。

• 2 つ目は、 Pre-Indexingです。これは、ローカル マシン上のすべての電子ブックにインデックスを付けることができ、生成された検索インデックスはすべての読書セッション中に永続的に利用できることを意味します。したがって、インデックス付けされたすべての電子ブック内で用語を検索することができます。

オンザフライでのインデックス作成

インデックス作成

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

検索

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

インデックスの削除

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

事前インデックス作成

インデックス作成

いくつかの EPUB のインデックスを作成してみましょう。

 $ epub-search writeToIndex -p  <path>

検索

用語を検索:

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

オートコンプリートの提案

$ http://localhost:8085/matcher?beginsWith=一致するテキストの始まり

例:

オンザフライでのインデックス作成

TODO

事前インデックス作成

まず、epub-search をグローバルにインストールしてください。

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

サービスを開始します:

 $ [sudo] epub-search start

サンプル epub をインデックスに追加します。

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

これで、 epubという用語がいくつかヒットするはずです。

_{リクエストには$curl -XGET "http://localhost:8085/search?q=math"またはブラウザを使用できます。}

電子ブック コレクション全体を検索します。

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

特定の電子書籍内のみを検索するように、book-title t="..."のフィルターを設定します。

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

または、オートコンプリートに関するいくつかの提案を得ることができます。

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

図書館利用の場合

TODO

ヒットデータフォーマット

TODO

ローカルテスト

すべての依存モジュールをインストールします: npm install 。

デモnpm run start起動します。ローカル マシン上で Express サーバーを実行する必要があります。

http://localhost:8085/ に移動すると、デモが表示されます。

注: 事前インデックス作成プロセスは自動的に開始され、事前インデックス作成検索が使用可能になるまでに数秒かかります。

技術的な詳細

EPUB-Search は、検索インデックスを使用して書籍コンテンツのインデックスを作成します。

貢献する

大歓迎です...:-)