Skip to main content

Zoomin-Integration

Zoomin ist eine Software, die ein einzelnes Portal für Ihre gesamte Dokumentation bereitstellt, einschließlich PDFs, Word-Dokumenten, Artikeln in Wissensdatenbanken und Inhalten, die Sie in Paligo erstellen.

Um Ihre Paligo-Inhalte in Zoomin zu verwenden, benötigen Sie ein Zoomin-Konto. Anschließend müssen Sie in Paligo Folgendes einrichten:

  • Die Zoomin-Integrationseinstellungen, siehe Verbinden von Paligo mit Zoomin

  • Ein Zoomin-Layout

  • Eine Publikation und Topics in Paligo. Diese enthalten die Inhalte, die Sie zu Zoomin „pushen“ werden.

    Bei einer Veröffentlichung zu Zoomin gibt es keine besonderen Anforderungen für Ihre Publikation und Ihre Topics.

Sie können dann aus Paligo zu Ihrer Zoomin-Software veröffentlichen. Der Inhalt, den Sie veröffentlichen, ist eine HTML5-Ausgabe, die so angepasst ist, dass sie Metadaten und andere Details enthält, die für Zoomin erforderlich sind.

Verbinden von Paligo mit Zoomin

Sie können Inhalte direkt aus Paligo zu Ihrer Zoomin-Instanz veröffentlichen. Hierzu müssen Sie jedoch zunächst Paligo und Zoomin für die Verbindung einrichten.

  1. Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.

  2. Melden Sie sich bei Paligo über ein Benutzerkonto mit Administratorberechtigungen an.

  3. Wählen Sie den Avatar in der oberen rechten Ecke aus. User avatar. It shows the user's image and their name. Next to the name is a downward pointing arrow, which when selected, reveals a menu.

  4. Wählen Sie im Menü Einstellungen aus. Cog icon.

  5. Wählen Sie die Registerkarte Integrationen. Jigsaw piece icon.

    Paligo settings. The Integrations tab is highlighted.

  6. Wählen Sie im Feld Zoomin Hinzufügen aus (bzw. Ändern, wenn bereits eine Integration eingerichtet wurde).

    Paligo zeigt die Integrationseinstellungen an.

    Zoomin integration settings. There is an account name field, a Choose environment option, an upload URL preview, a set as default option and an SSH key field with generate key and copy key buttons.

  7. Geben Sie den Namen des Kontos ein.

    Dieser muss mit dem Namen des Repositorys in Zoomin übereinstimmen.

  8. Wählen Sie die Option Umgebung auswählen, um eine der Umgebungen auszuwählen. Sie können bis zu fünf Umgebungen auswählen.

    zoomin-change-environment.png

  9. Geben Sie Folgendes ein:

    • Einen Umgebungsnamen.

      Dies kann ein beliebiger Name sein. Er wird verwendet, um die Umgebung in Paligo zu identifizieren. Wir empfehlen Ihnen, Ihren Umgebungen Namen zu geben, mit denen Benutzer Ihre Umgebungen leicht unterscheiden können. Wenn Sie aus Paligo veröffentlichen, müssen Sie die Umgebung auswählen, zu der Sie veröffentlichen möchten. Diese werden nach Namen aufgelistet.

    • Eine Upload-URL.

      Der Upload-Pfad ist die URL des Speicherorts (in Zoomin), der die von Paligo veröffentlichten Inhalte erhält.

      Paligo fügt eine Standardstruktur für den URL-Pfad hinzu. Sie sollten ihn mit der spezifischen Adresse für Ihre Zoomin-Umgebung überschreiben.

  10. Wenn die ausgewählte Umgebung die Standard-Zoomin-Umgebung für Veröffentlichungen sein soll, aktivieren Sie das Kontrollkästchen Als Standard festlegen. Lassen Sie es leer, wenn Sie eine andere Umgebung als Standard festlegen möchten. Bei der Veröffentlichung können Sie eine andere Umgebung auswählen, wenn erforderlich.

  11. Wählen Sie Schlüssel erzeugen aus.

    Paligo erzeugt einen SSH-Key. Der Schlüssel wird im Feld „SSH-Schlüssel“ über der Schaltfläche angezeigt. SSH steht für „Secure Shell“ und dient zur Verschlüsselung der Verbindung zwischen Paligo und Zoomin.

  12. Drücken Sie Speichern.

  13. Wählen Sie Schlüssel kopieren aus, um den SSH-Schlüssel zu kopieren. Senden Sie den SHH-Schlüssel anschließend an Zoomin. Lassen sie ihn zu Ihrer Zoomin-Instanz hinzufügen. Nach dem Hinzufügen kehren Sie zu den Einstellungen in Paligo zurück.

  14. Wählen Sie die Schaltfläche Ändern für die Integration aus.

  15. Wählen Sie Testeinstellungen aus, um einen Verbindungstest durchzuführen.

    Test_Reset_Settings_Integrations_small.jpg

  16. Lautet Ihre Einstellung:

    • Richtig, zeigt Paligo eine grüne Erfolgsmeldung an.

    • Falsch, zeigt Paligo eine rote Fehlermeldung an.

      Überprüfen Sie jede Verbindungseinstellung sorgfältig, um sicherzustellen, dass Sie keine Fehler gemacht haben, und versuchen Sie es erneut.

      Wenn der Verbindungstest weiterhin fehlschlägt, wenden Sie sich an den Paligo-Support, um Unterstützung zu erhalten.

Tipp

Wenn der Verbindungstest erfolgreich war, können Sie In Zoomin veröffentlichen.

Wenn der Verbindungstest fehlschlägt, überprüfen Sie, ob Sie den Kontonamen und die Umgebungsdetails korrekt eingegeben haben und den SSH-Schlüssel an Zoomin gesendet haben. Überprüfen Sie Ihre Angaben sorgfältig auf Tippfehler, z. B. falsche Leerzeichen oder Zeichen.

Zoomin-Layouts

Um Paligo-Inhalte in Zoomin zu veröffentlichen, müssen Sie ein Zoomin-Layout verwenden. Das Layout verfügt über Einstellungen, die angewendet werden, wenn Paligo Ihren XML-Inhalt in HTML konvertiert, z. B. für die Anzahl der Ebenen im Inhaltsverzeichnis und für die Aufnahme von Taxonomien in die Ausgabe.

In Ihrer Paligo-Instanz ist ein Standard-Layout für Zoomin festgelegt. Sie können dieses Layout für die Veröffentlichung verwenden oder eigene Zoomin-Layouts mit anderen Einstellungen erstellen. Bei der Erstellung eines Zoomin-Layouts können Sie auswählen, ob die Standardwerte für Einstellungen aus diesen Layouts übernommen werden sollen:

  • Das in Paligo bereitgestellte Standard-Zoomin-Layout

  • Eines der benutzerdefinierten Zoomin-Layouts, die Sie (oder andere Benutzer) in Paligo erstellt haben.

Das Zoomin-Layout basiert lose auf dem klassischen Multipage-HTML-Layout und enthält daher einige entsprechende Einstellungen. Die meisten Einstellungen funktionieren in beiden Layouts auf die gleiche Weise, wobei einige möglicherweise nicht für Zoomin gelten. Die Hauptunterschiede sind:

  • Das Zoomin-Layout fügt der Ausgabe einige Metadaten hinzu. Zoomin benötigt die Metadaten.

  • Ihre Zoomin-Ausgabe enthält die Datei taxonomies.xml. Zoomin kann anschließend alle Taxonomien verwenden, die in Paligo vorhanden sind.

Informationen zum Erstellen eines eigenen Zoomin-Layouts finden Sie unter Erstellen eines Zoomin-Layouts.

Um ein vorhandenes Zoomin-Layout zu bearbeiten, befolgen Sie die Schritte in Ein Layout bearbeiten. Informationen zu den verfügbaren Einstellungen finden Sie unter [en] HTML5 Layout Editor Options. Beachten Sie jedoch, dass einige Einstellungen möglicherweise nicht relevant sind, wenn Sie in Zoomin veröffentlichen.

Anmerkung

In früheren Versionen von Paligo handelte es sich bei dem Basislayout für Zoomin tatsächlich um ein HTML5-Layout. Wenn Sie dieses verwendet haben, wird es auch weiterhin funktionieren. Sie finden es jetzt in der HTML5-Layoutkategorie unter der Bezeichnung Zoomin (Legacy).

Erstellen eines Zoomin-Layouts

Um Inhalte in Zoomin zu veröffentlichen, müssen Sie ein Zoomin-Layout verwenden. Sie können das integrierte Zoomin-Layout verwenden oder ein eigenes erstellen. Wenn Ihre Paligo-Instanz bereits mehrere Zoomin-Layouts enthält, können Sie alternativ eines dieser Layouts bearbeiten und verwenden.

So erstellen Sie ein Zoomin-Layout:

  1. Wählen Sie im oberen Menü Layout aus.

    Paligo editor. The Layout option in the header menu is highlighted.

    Paligo zeigt eine Liste von Layouts an. Die Liste ist leer, wenn keine benutzerdefinierten Layouts in Ihrer Paligo-Instanz vorhanden sind.

  2. Wählen Sie Neues Layout erstellen in der unteren linken Ecke. New_Layout.jpg

  3. Geben Sie Ihrem Layout im Feld Layout-Titel einen Namen.

    Create new layout dialog. It has a Layout Title field for naming the Layout. It also has an Output Format drop-down menu, where you can choose what type of content this Layout will produce.

  4. Wählen Sie ein Ausgabeformat aus.

    Das Ausgabeformat stellt das Basislayout für Ihr neues Layout dar. Darin ist Folgendes festgelegt:

    • Art der Inhalte, die Sie über die Vorlage veröffentlichen können.

    • Quelle der Standardwerte. Wenn Sie im neuen Layout einen Wert auf Standard einstellen, wird der Wert aus dem Basislayout übernommen. Weitere Informationen finden Sie unter Layoutbeziehungen – Basis, Neu, Duplizieren.

    Anmerkung

    Sie können wählen, ob ein integriertes Layout oder eines Ihrer zuvor erstellten benutzerdefinierten Layouts als Basislayout dient.

  5. Klicken Sie auf OK.

    Paligo erstellt Ihr neues Layout.

  6. Wählen Sie das neue Layout in der Liste aus, um es im Layout-Editor zu öffnen.

    Tipp

    Sie können die URL aus dem neuen Dialogfeld kopieren und in eine Browser-Registerkarte einfügen. Dies ist manchmal einfacher, besonders, wenn Sie häufig zwischen Ihren Inhalten und den Layout-Einstellungen wechseln.

  7. Wählen Sie die Veröffentlichungseinstellungen im Layout-Editor aus. Paligo wendet diese Einstellungen an, wenn Ihre XML-Inhalte in das Ausgabeformat konvertiert werden.

    Zoomin-Layouts verfügen über dieselben Einstellungen wie ein HTML5-Helpcenter. Beachten Sie jedoch, dass einige der Einstellungen möglicherweise nicht relevant sind, wenn Sie in Zoomin veröffentlichen.

  8. Drücken Sie Speichern.

In Zoomin veröffentlichen

Bevor Sie in Zoomin veröffentlichen können, müssen Sie:

So veröffentlichen Sie Ihre Paligo-Inhalte zu Zoomin:

  1. Wählen Sie das gepunktete Menü (...) für das Topic oder die Publikation im Content Manager aus.

    selectpublish.png

  2. Wählen Sie Veröffentlichen aus. Publish_button_small.png

    publish-document-jan23.png

    Paligo zeigt das Dialogfeld Dokument veröffentlichen an.

  3. Wählen Sie auf der Registerkarte Einstellungen die Option HTML5 aus.

  4. Wählen Sie das Zoomin-Layout aus, das Ihre Publikation verwenden soll.

    Publish document dialog. The HTML5 option is selected and Zoomin is the chosen layout. There are settings to select the environment and upload path as well as languages, profiling attributes, variables, and other parameters.

  5. Wählen Sie die Zoomin-Umgebung aus, die die veröffentlichten Inhalte von Paligo erhalten soll.

    Die Liste Umgebung auswählen enthält die Namen jeder Zoomin-Umgebung, die zu Ihren Paligo-zu-Zoomin-Integrationseinstellungen hinzugefügt wurde.

    Wenn Sie eine Umgebung auswählen, wird das Feld Vorschau des Zoomin-Upload-Pfads aktualisiert, um den Speicherort anzuzeigen, an dem die veröffentlichten Inhalte empfangen werden. Die URL für den Speicherort wird auch in den Paligo-to-Zoomin-Integrationseinstellungen definiert.

    Zoomin publishing settings. Select environment field shows "dev" and the Zoomin upload path preview field shows "paligo-be-dev-zoominsoftware.io"

  6. Wählen Sie die zu veröffentlichenden Sprachversionen aus.

    Languages section of Publish document dialog. There are options for each language. English UK and Swedish are selected.

    Anmerkung

    Wenn keine Übersetzungen verfügbar sind, wird nur die Ausgangssprache angezeigt. Bei mehreren genehmigten Übersetzungen in verschiedene Sprachen können Sie auswählen, welche Sie mit aufnehmen möchten. Paligo veröffentlicht jede Sprachversion als separate Ausgabe.

    Bei der PDF-Ausgabe können Sie sie als eine einzige, mehrsprachige Publikation veröffentlichen; aktivieren Sie hierzu das Kontrollkästchen Ausgewählte Sprachen kombinieren.

  7. [en] If your content is set up to use Filterung/Profiling, use the Profiling attributes section to apply them. [Optional]. If you do not use filtering, ignore this setting.

    [en] Select Edit and then choose the value for each filter that you want Paligo to use. For example, for Audience, choose Expert to include content that is marked as for expert users.

    Wenn Sie keinen Filter anwenden möchten, lassen Sie das Feld leer.

    Profiling attributes dialog. Outputformat is set to include HTML.

    Wählen Sie OK aus, um das/die gewählte(n) Profiling-Attribut(e) hinzuzufügen.

    Profiling attributes section of Publish document dialog. Shows Outputformat: HTML selected.

  9. Verwenden Sie den Abschnitt Ausgabe hochladen, um eine Zip-Datei des Inhalts in ein Repository hochzuladen, siehe Integrationen.

  10. Im Abschnitt Ausgabedateiname können Sie den Dateinamen verwalten.

    Standardmäßig verwendet Paligo die in den Systemeinstellungen festgelegte Dateinamensyntax.

    Output filename section. There is a Template field that contains the values ID, Title, and Format. In the top-right corner is a preview of the filename that Paligo will generate if the current settings are used.

    Um die im Dateinamen enthaltenen Angaben zu ändern, geben Sie Ihr gewünschtes Format in den Publikationseinstellungen ein. Die Standardeinstellung lautet: ID-Title-Format.

    Sie können folgende Angaben in den Namen aufnehmen:

    • ID - Die ID des Dokuments.

    • Titel - Der Titel der Publikation oder des Topics, das Sie veröffentlichen.

    • Format - Der Name des Ausgabeformats, zum Beispiel PDF oder HTML5.

    • Bearbeitungsdatum - Das Datum, an dem die Publikation oder das Topic zuletzt bearbeitet wurde.

    • Label der Verzweigung – Der Text aus dem Label der Verzweigung für die Publikation oder das Topic. Dies gilt nur, wenn Ihre Inhalte verzweigt wurden und die Verzweigung über ein Label verfügt. Details hierzu finden Sie unter Beschriftungen für Zweige hinzufügen oder bearbeiten.

    • Eindeutiger Wert - Eine von Paligo generierte zufällige Zeichenfolge, die dem Dateinamen hinzugefügt wird, um ihn einzigartig zu machen. Dadurch kann verhindert werden, dass die Datei durch spätere Veröffentlichungen desselben Dokuments überschrieben wird.

    Tipp

    Wenn Sie @ in das Feld eingeben, zeigt Paligo eine Liste der verfügbaren Werte an, aus denen Sie wählen können. Um einen Wert zu entfernen, klicken Sie ihn an und verwenden Sie die Löschtaste oder Rücktaste, um alle Zeichen zu entfernen.

    Anmerkung

    Der in der oberen rechten Ecke angezeigte Dateiname ist eine Vorschau auf den Dateinamen, den Paligo bei der Veröffentlichung verwendet.

  11. Legen Sie die optionalen Parameter fest (lassen Sie das Kontrollkästchen deaktiviert, wenn Sie diese Funktionen nicht wünschen):

    • Speichern Sie die Ausgabe in Paligo - Aktivieren Sie das Kontrollkästchen, um die Zip-Datei in der Ressourcenübersicht zu speichern. Deaktivieren Sie das Kontrollkästchen, wenn Paligo nur die veröffentlichte Ausgabedatei in Ihrem Browser herunterladen soll.

    • E-Mail an mich - Aktivieren Sie dieses Kontrollkästchen, wenn Paligo Ihnen eine E-Mail schicken soll, wenn die Publikation bereit ist. Dies ist bei sehr großen Publikationen von Vorteil, deren Verarbeitung und Veröffentlichung länger dauern können.

    • Debug-Build erstellen - Aktivieren Sie dieses Kontrollkästchen, wenn Paligo eine Protokolldatei und einen Link-Bericht einfügen soll. Wenn Ihre Inhalte ein Problem verursachen, kann der Paligo Support Sie bitten, diese Funktion zu aktivieren, damit er die Protokolldateien zur Ermittlung der Ursache nutzen kann.

  12. Wählen Sie Dokument veröffentlichen aus.

    Paligo beginnt mit der Verarbeitung Ihrer Inhalte und wendet Ihre Layout- und Publikationseinstellungen an. Die benötigte Zeit ist von dem Umfang der Inhalte abhängig, die Sie veröffentlichen (je mehr Inhalte, desto länger dauert der Vorgang).

    Publish_Progress_Bar_small.jpg

    Ein Fortschrittsbalken zeigt Ihnen an, wie viel der Verarbeitung Paligo bereits abgeschlossen hat und wie viel noch zu tun ist. Wenn die Verarbeitung abgeschlossen ist, wird eine Benachrichtigung angezeigt.

    Die veröffentlichte Ausgabe erscheint wie folgt:

    • Eine Zip-Datei mit der veröffentlichten Ausgabe erscheint im Ordner Downloads auf Ihrem Computer.

      Wenn Sie die Einstellungen Ihres Browsers geändert haben, um heruntergeladene Dateien an einem anderen Ort zu speichern, befindet sich die Zip-Datei stattdessen dort.

      Wenn Sie eine Publishing-Integration verwenden, wird die Zip-Datei auch an den entsprechenden Dienst gesendet.

    • Ein Link im Panel Aktivitätsfeed zum Herunterladen der veröffentlichten Inhalte.

    Anmerkung

    Um die Inhalte online zur Verfügung zu stellen, entpacken Sie zunächst die Datei. Sie können die Datei dann lokal verwenden oder einen FTP-Client wie Filezilla verwenden, um den entpackten Inhalt auf einen Webserver hochzuladen.

    Tipp

    Sie können Ihre Publikationseinstellungen speichern und wiederverwenden, um einen reibungsloseren Publikationsprozess zu erreichen, siehe Publikationseinstellungen. Alle gespeicherten Einstellungen können auch für [en] Batch Publishing verwendet werden.

    Publish document dialog has a Save Settings option and a Saved Settings tab. The option saves the currently shown settings and these can then be selected in a single action on the tab.