mirador

️ Dieses Projekt ist für Mirador 3, die neueste Version von Mirador. Informationen zu Mirador 2 finden Sie in der ProjectMirador/mirador2- oder Legacy-Dokumentation im Mirador 2-Wiki. Bitte beachten Sie, dass der Fokus der Community auf Mirador 3 liegt und es unwahrscheinlich ist, dass sie Pull-Requests akzeptiert oder Support für Mirador 2 leistet.

Mirador

Für Mirador-Benutzer

Sie können Mirador schnell verwenden und konfigurieren, indem Sie den Mirador-Start-Glitch neu mischen.

Wir empfehlen, Mirador mit einem JavaScript-Paketmanager wie npm oder Yarn zu installieren.

$ npm install mirador 

# or

$ yarn add mirador

Wenn Sie daran interessiert sind, Mirador mit Plugins in Ihr Projekt zu integrieren, empfehlen wir die Verwendung von Webpack oder Parcel zur Integration der es-Version der Pakete. Beispiele finden Sie hier:

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

Wenn Sie Mirador ohne weitere Anpassung einfach in eine HTML-Seite einbetten möchten, schließen Sie den Mirador UMD-Build ein:

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

Weitere Beispiele für die Einbettung von Mirador finden Sie unter https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Übersetzungen zu Mirador hinzufügen

Hilfe zum Hinzufügen einer Übersetzung finden Sie unter src/locales/README.md

Lokaler Betrieb von Mirador für die Entwicklung

Die lokale Entwicklung von Mirador erfordert die Installation von NodeJS.

1. Führen Sie npm install aus, um die Abhängigkeiten zu installieren.

Starten des Projekts

$ npm start

Navigieren Sie dann zu http://127.0.0.1:4444/

Instanziierung von Mirador

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

> miradorInstance
{ actions , store }

Beispielaktion

Fügen Sie ein Fenster hinzu:

 store . dispatch ( actions . addWindow ( ) ) ;

Um ein Fenster zu fokussieren, führen Sie Folgendes aus:

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

Überprüfen Sie den aktuellen Status

 store . getState ( ) 

Ausführen der Tests

$ npm test # For headless CI=true npm test

oder um die Quelldateien kontinuierlich anzusehen

$ npm run test:watch

Linting das Projekt

$ npm run lint

Debuggen

Lokale Instanz

Die folgenden Browsererweiterungen sind zum Debuggen einer lokalen Entwicklungsinstanz von Mirador nützlich:

• DevTools reagieren
• Redux DevTools

Testsuite

Führen Sie Folgendes aus, um die Testsuite zu debuggen:

$ npm run test:debug

Starten Sie dann einen NodeJS-Inspektor-Client und legen Sie einige Haltepunkte fest. Hier finden Sie eine Anleitung zum Debuggen mit Chrome DevTools.