epub full text search

Búsqueda EPUB

Buscador de publicaciones digitales basado en EPUB 3

¡Bienvenido! EPUB-Search hace que se puedan realizar búsquedas en sus publicaciones digitales.

¿Cuál es el caso de uso?

• Microservicio del lado del servidor para buscar lectores de “nube” basados ​​en navegador dentro de EPUB
• Para EPUB que vive en línea
• Para buscar dentro de su stock EPUB local

Demostración en línea

Manifestación

Características incluidas:

• Búsqueda de texto completo (obtenga todas las coincidencias de consulta para un documento epub o para una colección epub completa)
• Autocompletar
• JavaScript completo
• Éxitos que incluyen referencias a cfi
• Resultados de respuesta en formato JSON
• Preindexación
• Indexación sobre la marcha

Instalación

Para uso CLI

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

Para uso de la biblioteca

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

Ejecutando como servicio

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

Iniciar servicio

 $ [sudo] epub-search start

Modus operandi

La búsqueda EPUB proporciona dos modus operandi :

• El primero es la indexación sobre la marcha . Esto significa que el libro electrónico se indexará en segundo plano cuando se abra. El supuesto para este modo es el libro EPUB3 que está disponible de forma remota. El índice de búsqueda generado se eliminará si se cierra el libro electrónico.

• El segundo es la preindexación . Esto significa que todos los libros electrónicos en la máquina local se pueden indexar y el índice de búsqueda generado estará disponible de manera persistente durante todas las sesiones de lectura. Por lo que es posible buscar términos dentro de todos los libros electrónicos indexados.

Indexación sobre la marcha

Indexación

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

Buscar

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

Eliminar índice

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

Preindexación

Indexación

Empecemos a indexar algunos EPUB:

 $ epub-search writeToIndex -p  <path>

Buscar

Buscar término:

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

Sugerencias para autocompletar

 $ http://localhost:8085/matcher?beginsWith= comienzo-del-texto-a-coincidir

Ejemplos:

Indexación sobre la marcha

HACER

Preindexación

Primero, instale epub-search globalmente:

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

Iniciar servicio:

 $ [sudo] epub-search start

Agregue libros electrónicos de muestra al índice:

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

Ahora deberíamos obtener algunos resultados para el término epub :

_{Para solicitudes puedes usar $ curl -XGET "http://localhost:8085/search?q=math" o el navegador ...}

Busque en toda la colección de libros electrónicos:

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

Configure el filtro para el título del libro t="..." para buscar solo dentro de un libro electrónico específico:

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

O podemos obtener algunas sugerencias para un autocompletado:

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

Para uso de la biblioteca

HACER

Formato de datos de golpe

HACER

Pruebas locales

Instale todos los módulos dependientes: npm install .

Inicie la demostración npm run start . Debería ejecutar un servidor express en su máquina local.

Cuando navegas a http://localhost:8085/ puedes ver la demostración.

Nota: El proceso de preindexación se inicia automáticamente y tarda unos segundos hasta que la búsqueda de preindexación esté disponible.

Detalles técnicos

EPUB-Search utiliza el índice de búsqueda para indexar el contenido de los libros.

Contribuyendo

Muy bienvenido... :-)