LookingGlass

Lookingglass

Pesquise, filtre e navegue em qualquer conjunto de documentos. O LookingGlass inclui pesquisa completa de texto, filtros de categoria e consultas de data durante uma boa interface de pesquisa com um back -end do Elasticsearch . O LookingGlass também suporta temas personalizáveis ​​e páginas de exibição de documentos flexíveis para navegar e incorporar uma variedade de tipos de documentos.

LookingGlass requer DocManager para que possa interagir com o Elasticsearch. LookingGlass pode ser usado em combinação com o Harvester para rastrear, analisar e carregar documentos e transformá -los automaticamente em um arquivo pesquisável. No entanto, também funciona bem como uma ferramenta de arquivamento independente.

Instalação

Dependências

• DocManager e todas as suas dependências
• Ruby 2.4.1
• Rails 5
• (Opcionalmente) Harvester
• libmagic-dev

Instruções de configuração

1. Instalar as dependências

• Baixe o elasticsearch (https://www.elastic.co/downloads/elasticsearch)
• Faça o download do RVM (https://rvm.io/rvm/install)
• Instale Ruby: Execute rvm install 2.4.1 e rvm use 2.4.1
• Instalar trilhos: gem install rails
• Siga as instruções de instalação para DocManager

2. Obtenha o Lookingglass

• Repo Clone: git clone --recursive [email protected]:TransparencyToolkit/LookingGlass.git
• Vá para o diretório Lookingglass: cd LookingGlass
• Instale os Rubygems LookingGlass Usos: bundle install
• Gere dados simples de formulário: rails generate simple_form:install --bootstrap
• Ativos pré -compilantes: rake assets:precompile

3. Execute o LookingGlass

• Start DocManager: Siga as instruções no repo DocManager
• Projeto Configurar: Edite o arquivo em config/initializers/project_config para que o valor do Project_Index seja o nome do índice no DocManager Project Config LookingGlass deve usar
• Start LookingGlass: Execute rails server -p 3001
• Use LookingGlass: vá para http://0.0.0.0:3001 em seu navegador

Características

LookingGlass é um front -end para arquivos de documentos pesquisáveis. Anteriormente, também incluía o back -end que interagiu com o Elasticsearch, mas isso foi dividido no DocManager. Os principais recursos são descritos abaixo.

Exibição de conjuntos de documentos

LookingGlass mostra conjuntos de documentos de várias fontes de dados. Ele exibe uma lista de documentos na página principal. Os campos exibidos para cada documento na página de índice e o pedido em que os documentos são exibidos (classificados por data ou outro campo numérico) são personalizáveis ​​nos arquivos de configuração da fonte de dados do DocManager.

Cada conjunto de documentos individuais é exibido em sua própria página para facilitar a leitura. A página do documento inclui uma barra lateral com o campo categórico do documento e um conjunto personalizável de guias que podem exibir o texto do documento, incorporar o próprio documento (que é armazenado remotamente, localmente ou na nuvem de documentos), oferece downloads de documentos ou links de carga.

Procurar

LookingGlass permite texto completo dos conjuntos de documentos usando o back -end do Elasticsearch. Pode ser usado para pesquisar documentos na maioria dos idiomas. O LookingGlass suporta pesquisar todos os campos ou campos individuais e uma variedade de campos não textos, como datas. Os resultados são classificados pela relevância com o texto que corresponde à consulta destacada.

Filtros categóricos

Muitos conjuntos de documentos possuem campos categóricos comuns entre documentos, nos dados originais ou que podem ser extraídos com uma ferramenta como o Catalyst. Por exemplo, os países mencionados em um documento, formato de arquivo, hashtags e palavras-chave específicas de tópicos são tipos comuns de categorias. LookingGlass permite filtrar conjuntos de documentos de uma ou mais categorias clicando em links na barra lateral para obter, digamos, todos os documentos que são sobre um país em particular.

A barra lateral da categoria também exibe o número de documentos para cada valor em cada categoria que corresponde à consulta atual. Isso é ótimo para obter uma visão geral do conteúdo no conjunto de documentos.

Modelos de visualização de documentos

Nos resultados da pesquisa/índice de documentos e páginas de documentos individuais, a maneira como o documento é exibido é altamente personalizável. É possível adicionar novos modelos para exibir diferentes tipos de fontes de dados, como você deseja e até reunir vários documentos quando necessário (nos conjuntos de dados de email, por exemplo).

Esses modelos de visualização são definidos no aplicativo/views/docs/show/tabs/pains (para a página de exibição do documento) e app/views/docs/index/Results/Result_templates (para a exibição de índice/resultado). Os campos a serem usados ​​como um ID do thread e modelos de exibição para usados ​​são especificados por fonte nos arquivos de configuração da fonte de dados DocManager.

Rastreamento de versão

LookingGlass pode ser usado para rastrear quais documentos mudam com o tempo e como. Os documentos alterados são especificados nas categorias na barra lateral e a página de exibição do documento possui uma ferramenta que permite aos usuários visualizar a diferença exata entre dois documentos ao longo do tempo.

Os campos usados ​​para verificar se um documento foi alterado é especificado por fonte nos arquivos de configuração da fonte de dados DocManager.

Temas personalizados

LookingGlass suporta temas personalizados. O esquema de cores, fontes, logotipo, texto e links são todos totalmente personalizáveis.

Algumas dessas configurações, como o tema usado, o título do projeto e o logotipo são definidos no arquivo DocManager Project Config. As cores e fontes podem ser definidas criando um tema.