LookingGlass

Lookglass

Suchen, filtern und durchsuchen Sie alle Dokumente. Lookingglas umfasst Volltextsuche, Kategoriefilter und Datumsabfragen durch eine schöne Suchschnittstelle mit einem Elasticsearch -Backend. Lookingglass unterstützt auch anpassbare Themen und flexible Seiten für Dokumentenansicht zum Surfen und Einbetten einer Vielzahl von Dokumenttypen.

Das Aussehen erfordert DocManager, damit es mit Elasticsearch interagieren kann. Das Aussehen kann in Kombination mit Harvester zum Krabbeln, Parsen und Laden von Dokumenten verwendet werden und sie automatisch in ein durchsuchbares Archiv verwandeln. Es funktioniert jedoch auch gut als eigenständiges Archivierungswerkzeug.

Installation

Abhängigkeiten

• Docmanager und alle seine Abhängigkeiten
• Ruby 2.4.1
• Schienen 5
• (optional) Harvester
• libmagic-dev

Setup -Anweisungen

1. Installieren Sie die Abhängigkeiten

• Download ElasticSearch (https://www.elastic.co/downloads/elasticsarch)
• Download RVM (https://rvm.io/rvm/install)
• Installieren Sie Ruby: Führen Sie rvm install 2.4.1 und rvm use 2.4.1
• Schienen installieren: gem install rails
• Befolgen Sie die Installationsanweisungen für Docmanager

2. Schauen Sie sich an

• Clone Repo: git clone --recursive [email protected]:TransparencyToolkit/LookingGlass.git
• Gehen Sie in das Lookingglass -Verzeichnis: cd LookingGlass
• bundle install
• Generieren Sie einfache Formulardaten: rails generate simple_form:install --bootstrap
• Vorkompiliervermögen: rake assets:precompile

3. Run Lookglass

• Starten Sie Docmanager: Befolgen Sie die Anweisungen im Docmanager Repo
• Projekt konfigurieren: Bearbeiten Sie die Datei in config/initializers/project_config so, dass der Wert project_index der Name des Index in der Docmanager -Projektkonfiguration ist
• Starten Sie mit Lookingglass: rails server -p 3001 führen
• Verwenden Sie Lookingglas: Gehen Sie in Ihrem Browser zu http://0.0.0.0:3001

Merkmale

Lookingglass ist ein Frontend für durchsuchbare Dokumentarchive. Zuvor beinhaltete es auch das Backend, das mit Elasticsearch interagierte, aber dies wurde inzwischen in Docmanager aufgeteilt. Die Schlüsselmerkmale werden unten beschrieben.

Anzeige von Dokumentsätzen

Lookingglas zeigt Dokumentensätze aus mehreren Datenquellen an. Es zeigt eine Liste von Dokumenten auf der Hauptseite an. Die für jedes Dokument auf der Indexseite angezeigten Felder und die Reihenfolge, in der die Dokumente angezeigt werden (sortiert nach Datum oder einem anderen numerischen Feld), sind in den Datenquellenkonfigurationsdateien von Docmanager angepasst.

Jeder einzelne Dokumentsatz wird dann auf seiner eigenen Seite zum einfachen Lesen angezeigt. Die Dokumentseite enthält eine Seitenleiste mit dem kategorialen Feld des Dokuments und einen anpassbaren Satz von Registerkarten, mit denen der Dokumenttext angezeigt wird, das Dokument selbst (das aus der Ferne, lokal oder in der Dokumentenwolke gespeichert ist), Dokumente herunterladen oder Links laden.

Suchen

Lookingglass ermöglicht den vollständigen Text von Dokumentsätzen mithilfe des Elasticsearch -Backends. Es kann verwendet werden, um Dokumente in den meisten Sprachen zu durchsuchen. Lookingglas unterstützt die Suche nach allen Feldern oder einzelnen Feldern sowie eine Vielzahl von Nicht-Text-Feldern wie Daten. Die Ergebnisse werden nach Relevanz sortiert, wobei Text, der der hervorgehobenen Abfrage entspricht, entspricht.

Kategoriale Filter

Viele Dokumentsätze verfügen über kategoriale Felder, die in den Originaldaten in allen Dokumenten üblich sind oder die mit einem Tool wie Katalysator extrahiert werden können. Zum Beispiel sind Länder, die in einem Dokument, Dateiformat, Hashtags und themenspezifischen Schlüsselwörtern erwähnt werden, gemeinsame Arten von Kategorien. Lookingglass ermöglicht die Filterdokumentssätze nach einer oder mehreren Kategorien, indem Sie auf Links in der Seitenleiste klicken, um beispielsweise alle Dokumente zu einem bestimmten Land zu erhalten.

In der Kategorie -Seitenleiste wird auch die Anzahl der Dokumente für jeden Wert in jeder Kategorie angezeigt, die mit der aktuellen Abfrage entspricht. Dies ist großartig, um einen Überblick über den Inhalt im Dokumentsatz zu erhalten.

Dokumentansichtsvorlagen

Sowohl auf den Suchergebnissen/Dokumentenindex als auch auf einzelnen Dokumentseiten ist die Art und Weise, wie das Dokument angezeigt wird, sehr anpassbar. Es ist möglich, neue Vorlagen hinzuzufügen, um verschiedene Arten von Datenquellen anzuzeigen, die Sie möchten, und bei Bedarf mehrere Dokumente zusammenfassen (z. B. in E -Mail -Datensätzen).

Diese Ansichtsvorlagen sind in App/Ansichten/Dokumenten/Show/Registerkarten/Panes (für die Seite "Dokumentansicht) und App/Ansichten/Dokumente/Index/Ergebnisse/result_templates (für die Index-/Ergebnisansicht) definiert. Die Felder, die als Thread-ID- und Ansichtsvorlagen verwendet werden sollen, werden in den DOCMANAGE-Datenquellen-Konfigurationsdateien pro Quellen angegeben.

Versionsverfolgung

Looking -Gglass kann verwendet werden, um zu verfolgen, welche Dokumente sich im Laufe der Zeit ändern und wie. Dokumente, die geändert werden, werden in Kategorien in der Seitenleiste angegeben, und auf der Seite "Dokumentansicht" enthält ein Tool, mit dem Benutzer den genauen Unterschied zwischen zwei Dokumenten im Laufe der Zeit anzeigen können.

Die Felder, die zur Überprüfung verwendet werden, ob sich ein Dokument geändert hat, werden in den DocManager-Datenquellen-Konfigurationsdateien pro Surce angegeben.

Benutzerdefinierte Themen

Lookingglass unterstützt die kundenspezifische Themen. Das Farbschema, die Schriftarten, das Logo, der Text und die Links sind alle vollständig anpassbar.

Einige dieser Einstellungen wie das verwendete Thema, der Projekttitel und das Logo sind in der DOCMANAGE -Projektkonfigurationsdatei definiert. Die Farben und Schriftarten können dann durch Erstellen eines Themas eingestellt werden.