epub full text search

EPUB-Поиск

Поисковая система для цифровых публикаций на основе EPUB 3

Добро пожаловать! EPUB-Search делает ваши цифровые публикации доступными для поиска.

Каков вариант использования:

• Серверный микросервис для поиска браузерных «облачных» читателей в файлах EPUB.
• Для файлов EPUB, которые живут в Интернете
• Для поиска в вашем местном хранилище EPUB

Онлайн-демо

Демо

Включенные функции:

• Полнотекстовый поиск (получить все совпадения запроса для одного документа epub или для всей коллекции epub)
• Автозаполнение
• Полный JavaScript
• Хиты, включая ссылки на CFI
• Результаты ответа в формате JSON
• Предварительная индексация
• Индексирование на лету

Установка

Для использования CLI

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

Для использования в библиотеке

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

Запуск как служба

интерфейс командной строки

 $ 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 предоставляет два способа работы :

• Первый из них — индексирование на лету . Это означает, что электронная книга будет индексироваться в фоновом режиме при ее открытии. Предполагаемым для этого режима является книга в формате EPUB3, доступная удаленно. Сгенерированный поисковый индекс будет удален, если электронная книга будет закрыта.

• Второй — предварительное индексирование . Это означает, что все электронные книги на локальном компьютере могут быть проиндексированы, и сгенерированный поисковый индекс будет постоянно доступен во время всех сеансов чтения. Таким образом, можно использовать условия поиска во всех проиндексированных электронных книгах.

Индексирование на лету

Индексирование

 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

Установите фильтр по названию книги t="..." для поиска только внутри определенной электронной книги:

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

Или мы можем получить несколько предложений по автозаполнению:

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

Для использования в библиотеке

TODO

Формат данных попадания

TODO

Локальное тестирование

Установите все зависимые модули: npm install .

Запустите демонстрационную версию npm run start . На вашем локальном компьютере должен быть запущен экспресс-сервер.

Когда вы переходите по адресу http://localhost:8085/, вы можете увидеть демо?.

Примечание. Процесс предварительного индексирования запускается автоматически и занимает несколько секунд, прежде чем поиск перед индексированием станет доступен.

Технические детали

EPUB-Search использует поисковый индекс для индексации содержимого книги.

Содействие

Очень приветствую... :-)