zoterobib

Zotero Bib

Ringkasan

Repo ini berisi kode untuk Zotero Bib, termasuk komponen React, klien terjemahan, stylesheet, dan situs web titik masuk.

Prasyarat

1. Node JS dengan npm
2. Alat baris perintah dasar termasuk rsync
3. Server terjemahan yang ada
4. Server bib yang ada
5. Repo gaya yang ada

Versi Pembangunan Lokal

Mendapatkan Perpustakaan

1. git clone --recursive [email protected]:zotero/zoterobib.git

2. cd zoterobib

3. npm install

4. npm start

Ini akan menyajikan demo di http://127.0.0.1:8001.

Anda mungkin perlu memberikan opsi konfigurasi (lihat di bawah) agar penyimpanan dan terjemahan dapat berfungsi.

Secara default, server pengembangan memproksi permintaan server terjemahan ke localhost:1969 . Jika server Anda berlokasi di tempat lain, Anda perlu memberikan urlnya, misalnya langkah terakhir di atas akan terlihat seperti ini:

1. TRANSLATE_URL=http://localhost:1234 npm start

Ini akan mem-proxy permintaan dari browser ke server terjemahan yang ditentukan.

Menggunakan dalam Produksi

Untuk mendapatkan file siap produksi gunakan perintah npm berikut:

npm run build

Konfigurasi

Dimungkinkan untuk menyediakan parameter konfigurasi untuk build (baik dalam pengembangan dan produksi) menggunakan file konfigurasi dan/atau variabel lingkungan.

Cara termudah adalah dengan menyalin config/default.json ke config/local.json dan menempatkan variabel di sana (file ini diabaikan oleh git dan tidak boleh dikomit). Alternatifnya, variabel lingkungan yang tercantum di config/custom-environment-variables.json dapat digunakan. Untuk detail lebih lanjut cara menyediakan konfigurasi, lihat paket config npm.

Opsi konfigurasi

Opsi konfigurasi berikut diterima:

storeURL Menentukan url untuk api bib-server tempat bibliografi disimpan.

styleURL Menentukan url untuk situs web style-repo . Jika dibiarkan kosong maka akan digunakan default yaitu https://www.zotero.org/styles-files/styles.json

TranslatePrefix Menentukan awalan tambahan ke mana permintaan server terjemahan harus dikirim. Berguna jika translateURL dibiarkan kosong sehingga memungkinkan untuk mengarahkan permintaan ke titik akhir tertentu di mana pun zotero-bib dihosting.

TranslateURL Menentukan URL untuk server terjemahan . Secara default, localhost diasumsikan sebagai permintaan proxy ke server terjemahan.

apiAuthorityPart Menentukan bagian otoritas URL untuk permintaan Zotero API. Defaultnya adalah api.zotero.org .

Konfigurasi server pengembangan

Menjalankan npm start memeriksa variabel lingkungan berikut:

TRANSLATE_URL Tempat untuk memproksi permintaan terjemahan, defaultnya adalah http://localhost:1969. Secara default ZoteroBib akan mengirimkan permintaan terjemahan ke window.location.origin dan server dev harus dikonfigurasi untuk mem-proxy permintaan ini ke server terjemahan.

PORT Di port mana server dev harus mendengarkan, defaultnya adalah 8001.

NO_HYDRATE Saat mengakses bibliografi jarak jauh, ZoteroBib dapat menghidrasi dari HTML yang telah dirender sebelumnya untuk menghindari spinner saat memuat. Untuk tujuan pengembangan, bibliografi berkode keras disimpan di hydrate.hbs dan digunakan untuk melayani permintaan apa pun yang menyertakan ID bibliografi jarak jauh. Untuk menonaktifkan perilaku ini, setel NO_HYDRATE ke 1 , yang akan melayani index.hbs , artinya bibliografi selalu ditampilkan di sisi klien dengan spinner.