Einbettung Veröffentlichte Umgebungen

EaaSI users may embed published Environments from their node into other web pages using the Emulation-as-a-Service JavaScript client library developed the OpenSLX team.

This method is currently brittle and pending improvements to the back-end EaaS server codebase may break existing embed links if/when the host server is updated. Support for this method is limited, employ at your own risk.

Bemerkung

Damit der eaas-client-Code funktioniert, wird die Zielumgebung must zunächst über OAI-PMH veröffentlicht. (Mit anderen Worten haben Sie im Host/Source-Knoten einen Netzwerkstatus von „Public“ und „Gestorben lokal“. Bitte konsultieren Sie Verlags- und Sparmittel für Anleitungen und Änderungen der Wahl, eine Umgebung von Ihrem EaaSI-Knoten zu veröffentlichen.

Warnung

Issues with the methods described on this page may occur if there is a version mismatch between the eaas-client library used and the eaas-server on the EaaSI deployment hosting the target Environment. Future EaaSI deployments will co-locate and expose the relevant eaas-client JavaScript component on the same deployment to prevent mismatch rather than fetching the JS from source repo on GitLab.

Benutzerdefinierte EaaS JavaScript Elemente in HTML

Um eine veröffentlichte Umgebung in beliebigen HTML einzubetten, muss zunächst das eaas-client JavaScript-Modul importiert werden:

<script type="module" src="https://emulation-as-a-service.gitlab.io/eaas-client/webcomponent.js"></script>

Bemerkung

The webcomponent.js can also be sourced from https://purl.archive.org/eaas/eaas.js for a stable link using the Internet Archive’s PURL (Persistent URL) service.

Sie können dann ein Element ```````````````Umgebung>` auf Ihrer Webseite enthalten, um die Umgebung zu wählen und zu gestalten, die Sie verbinden würden, z.B.:

<eaas-environment id="example-env"
    eaas-service="https://<your.eaasi.domain>/emil/"
    environment-id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    autoplay
    style="border: black solid 10px;">
    <strong>Please wait</strong> while the environment is being started ...
</eaas-environment>

Wo:

  • id` ist ein beliebiger Name/String, um das Element in Styling/CSS zu identifizieren

  • eaas-service`` identifiziert den Ort und den notwendigen API Endpunkt für das Getching der Umwelt; ersetzen Sie „<your.eaasi.domain>“ mit dem Quellknoten

  • environment-id ist die UUID, die eine Umweltressource identifiziert; ersetzen Sie durch die UUID Ihrer gewünschten Umgebung

  • autoplay` ist ein optionales Boolean-Attribut, das beginnt, die Umgebung zu laden und auszuführen, sobald der Browser des Besuchers die Seite lädt (entferne dieses Attribut, um Autoplay zu deaktivieren)

  • style=`` kann optional verwendet werden, um das Element zu stilisieren

  • ``<strong> Bitte warte</strong>, während die Umgebung gestartet wird …` ist optional, willkürlicher Text, der dem Benutzer angezeigt wird, während die Umgebung lädt und durch die laufende Umgebung ersetzt wird. Dies kann so bearbeitet werden, dass beliebige Texte, Bilder, andere HTML wie gewünscht enthalten.

Bitte beachten Sie, dass die UUID für eine gegebene Umgebung entweder mit der EaaSI API oder durch einen Blick auf die URL-Bar bei der Navigation auf eine bestimmte Seite der Umgebung gefunden werden kann:

../_images/environment_UUID.png

Bibliothek zum direkten Gebrauch in JavaScript importieren

Mit dem eaas-client Projektarchiv, das in Ihr Projekt kloniert ist, verwenden Sie:

import { Client } from "./eaas-client.js";