LookingGlass

Lookglass

Cari, filter, dan telusuri set dokumen apa pun. LookingGlass termasuk pencarian teks lengkap, filter kategori, dan permintaan tanggal semua melalui antarmuka pencarian yang bagus dengan backend Elasticsearch . Lookingglass juga mendukung tema yang dapat disesuaikan dan halaman tampilan dokumen yang fleksibel untuk menjelajah dan menanamkan berbagai jenis dokumen.

Lookingglass membutuhkan DocManager sehingga dapat berinteraksi dengan Elasticsearch. Lookingglass dapat digunakan dalam kombinasi dengan Harvester untuk merangkak, parsing, dan memuat dokumen dan secara otomatis mengubahnya menjadi arsip yang dapat dicari. Namun, ini juga berfungsi dengan baik sebagai alat pengarsipan mandiri.

Instalasi

Dependensi

• DocManager dan semua dependensinya
• Ruby 2.4.1
• Rails 5
• (Secara opsional) Harvester
• libmagic-dev

Petunjuk Pengaturan

1. Instal dependensi

• Unduh Elasticsearch (https://www.elastic.co/downloads/elasticsearch)
• Unduh RVM (https://rvm.io/rvm/install)
• Instal Ruby: Jalankan rvm install 2.4.1 dan rvm use 2.4.1
• Pasang rel: gem install rails
• Ikuti instruksi instalasi untuk DocManager

2. Dapatkan Lookingglass

• Clone Repo: git clone --recursive [email protected]:TransparencyToolkit/LookingGlass.git
• Masuk ke direktori lookglass: cd LookingGlass
• Instal Rubygems Lookingglass Penggunaan: bundle install
• Hasilkan Data Bentuk Sederhana: rails generate simple_form:install --bootstrap
• Aset Prakompile: rake assets:precompile

3. Jalankan lookglass

• Mulai DocManager: Ikuti instruksi pada repo DocManager
• Konfigurasi Proyek: Edit file di config/initializers/project_config sehingga nilai Project_index adalah nama indeks di DocManager Project Config Lookingglass harus digunakan
• Mulai Lookingglass: Jalankan rails server -p 3001
• Gunakan LookingGlass: Pergi ke http://0.0.0.0:3001 di browser Anda

Fitur

Lookingglass adalah frontend untuk arsip dokumen yang dapat dicari. Sebelumnya, itu juga termasuk backend yang berinteraksi dengan Elasticsearch, tetapi sejak itu telah dibagi menjadi DocManager. Fitur utama dijelaskan di bawah ini.

Tampilan set dokumen

LookingGlass menunjukkan set dokumen dari beberapa sumber data. Ini menampilkan daftar dokumen di halaman utama. Bidang yang ditampilkan untuk setiap dokumen pada halaman indeks dan pesanan dokumen ditampilkan (diurutkan berdasarkan tanggal atau bidang numerik lain) dapat disesuaikan dalam file konfigurasi sumber data DocManager.

Setiap set dokumen individu kemudian ditampilkan di halamannya sendiri untuk membaca dengan mudah. Halaman dokumen mencakup bilah samping dengan bidang kategori dokumen dan set tab yang dapat disesuaikan yang dapat menampilkan teks dokumen, menanamkan dokumen itu sendiri (yang disimpan dari jarak jauh, lokal, atau pada cloud dokumen), menawarkan unduhan dokumen, atau memuat tautan.

Mencari

Lookingglass memungkinkan teks lengkap set dokumen menggunakan backend Elasticsearch. Ini dapat digunakan untuk mencari dokumen di sebagian besar bahasa. Lookingglass mendukung mencari semua bidang atau bidang individu, dan berbagai bidang non-teks seperti tanggal. Hasil diurutkan berdasarkan relevansi dengan teks yang cocok dengan kueri yang disorot.

Filter kategorikal

Banyak set dokumen memiliki bidang kategori yang umum di seluruh dokumen, baik dalam data asli atau yang dapat diekstraksi dengan alat seperti katalis. Misalnya, negara-negara yang disebutkan dalam dokumen, format file, tagar, dan kata kunci khusus topik adalah jenis kategori yang umum. Lookingglass memungkinkan set dokumen penyaringan oleh satu atau lebih kategori dengan mengklik tautan di bilah sisi untuk mendapatkan, katakanlah, semua dokumen yang ada tentang negara tertentu.

Sidebar kategori juga menampilkan jumlah dokumen untuk setiap nilai di setiap kategori yang cocok dengan kueri saat ini. Ini bagus untuk mendapatkan ikhtisar konten dalam set dokumen.

Templat Tampilan Dokumen

Baik pada hasil pencarian/indeks dokumen dan halaman dokumen individual, cara dokumen ditampilkan sangat dapat disesuaikan. Dimungkinkan untuk menambahkan templat baru untuk menampilkan berbagai jenis sumber data yang Anda inginkan dan bahkan menyatukan banyak dokumen saat diperlukan (dalam kumpulan data email, misalnya).

Template tampilan ini didefinisikan dalam aplikasi/tampilan/dokumen/show/tab/panel (untuk halaman tampilan dokumen) dan aplikasi/tampilan/dokumen/indeks/hasil/hasil_template (untuk tampilan indeks/hasil). Bidang yang akan digunakan sebagai ID utas dan templat tampilan yang digunakan untuk ditentukan per-sumber dalam file konfigurasi sumber data DocManager.

Pelacakan Versi

Lookingglass dapat digunakan untuk melacak dokumen mana yang berubah seiring waktu dan bagaimana. Dokumen yang diubah ditentukan dalam kategori pada bilah sisi dan halaman tampilan dokumen memiliki alat yang memungkinkan pengguna untuk melihat perbedaan yang tepat antara dua dokumen dari waktu ke waktu.

Bidang yang digunakan untuk memeriksa apakah dokumen telah diubah ditentukan per-sumber dalam file konfigurasi sumber data DocManager.

Tema khusus

Lookingglass mendukung tema khusus. Skema warna, font, logo, teks, dan tautan semuanya sepenuhnya dapat disesuaikan.

Beberapa pengaturan ini, seperti tema yang digunakan, judul proyek, dan logo didefinisikan dalam file konfigurasi proyek DocManager. Warna dan font kemudian dapat diatur dengan membuat tema.