mirador

️ Proyek ini untuk Mirador 3, versi terbaru Mirador. Untuk Mirador 2, silakan lihat ProjectMirador/mirador2 atau dokumentasi lama di wiki Mirador 2. Harap dicatat bahwa fokus komunitas adalah pada Mirador 3, dan kemungkinan besar tidak akan menerima permintaan penarikan atau memberikan dukungan untuk Mirador 2.

Mirador

Untuk Pengguna Mirador

Anda dapat dengan cepat menggunakan dan mengonfigurasi Mirador dengan me-remix Glitch yang memulai mirador.

Kami merekomendasikan menginstal Mirador menggunakan manajer paket JavaScript seperti npm atau benang.

$ npm install mirador 

# or

$ yarn add mirador

Jika Anda tertarik untuk mengintegrasikan Mirador dengan plugin ke dalam proyek Anda, kami sarankan menggunakan webpack atau parsel untuk mengintegrasikan versi es dari paket tersebut. Contohnya ada di sini:

https://github.com/ProjectMirador/mirador-integration

Jika Anda hanya ingin menyematkan Mirador di halaman HTML tanpa penyesuaian lebih lanjut, sertakan build UMD Mirador:

 <script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>

Contoh lebih lanjut tentang penyematan Mirador dapat ditemukan di https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Menambahkan terjemahan ke Mirador

Untuk bantuan dalam menambahkan terjemahan, lihat src/locales/README.md

Menjalankan Mirador secara lokal untuk pengembangan

Pengembangan lokal Mirador memerlukan instalasi nodejs.

1. Jalankan npm install untuk menginstal dependensi.

Memulai proyek

$ npm start

Kemudian navigasikan ke http://127.0.0.1:4444/

Membuat Instansi Mirador

 var miradorInstance = Mirador . viewer ( {
  id : 'mirador' // id selector where Mirador should be instantiated
} ) ;

> miradorInstance
{ actions , store }

Contoh Tindakan

Tambahkan jendela:

 store . dispatch ( actions . addWindow ( ) ) ;

Untuk memfokuskan jendela yang dijalankan:

 store . dispatch ( actions . focusWindow ( 'window-1' ) )

Periksa keadaan saat ini

 store . getState ( ) 

Menjalankan tes

$ npm test # For headless CI=true npm test

atau untuk terus menonton file sumber

$ npm run test:watch

Linting proyek

$ npm run lint

Men-debug

Contoh lokal

Ekstensi browser berikut berguna untuk men-debug instance pengembangan lokal Mirador:

• Bereaksi DevTools
• Alat Pengembang Redux

Rangkaian tes

Untuk men-debug rangkaian pengujian, jalankan:

$ npm run test:debug

kemudian jalankan klien inspektur nodejs dan atur beberapa breakpoint. Lihat di sini untuk panduan melakukan debug dengan Chrome DevTools.