Querverweise und Links

3 min read

IDs für Querverweise

Paligo-Inhalte werden in einer Datenbank gespeichert, wobei jedes Element eine eigene eindeutige ID haben kann. Bestimmte Arten von Inhalten wie Absätze, Bilder oder Variablen haben einen speziellen Typ von ID namens xinfo, der stets von Paligo generiert wird. Andere Elemente können eine optionale ID namens xml:ID haben, die entweder automatisch von Paligo oder manuell von Ihnen generiert werden kann.

Querverweise in Paligo entnehmen das Ziel des Querverweises aus der ID. Für manche Typen von Querverweisen erstellt Paligo die ID automatisch, vor allem für Komponenten, die einen Titel haben können. Dieser wird als xml:id-Attribut hinzugefügt. Dennoch müssen Sie möglicherweise ein xml:id-Attribut manuell hinzufügen, um Querverweise auf andere Inhaltstypen zu erstellen. Dies gilt sowohl für Querverweise zwischen Topics als auch für Querverweise auf Inhalte innerhalb ein und desselben Topics, z. B. zu einem Unterabschnitt.

In der Regel sind Querverweise auf folgende Elemente zu empfehlen:

  • Abschnitt

  • Unterabschnitt – ein Abschnitt innerhalb eines anderen Abschnitts

  • Eine Struktur, die einen Titel haben kann, z. B. eine Tabelle.

Anmerkung

Wenn Sie auf einen anderen Inhaltstyp verweisen möchten, ist dies nur möglich, wenn der betreffende Inhalt eine xml:id hat. Möglicherweise müssen Sie zunächst IDs für Querverweise manuell generieren, bevor Sie eine Verknüpfung herstellen können.

Paligo lässt sich auch so einstellen, dass xml:ids automatisch generiert werden, siehe IDs für Querverweise automatisch generieren .

IDs für Querverweise manuell generieren

Sie können nur Querverweise zu Elementen hinzufügen, die eine xml:id haben. Wenn das Element, auf das Sie verweisen möchten, keine xml:id hat, können Sie diese manuell generieren. Paligo hat eine Funktion im Editor, die eine passende ID generiert. Es ist nicht ratsam, eigene ID-Werte zu erstellen, da IDs eindeutig sein sollten.

Tipp

Sie können Paligo so einstellen, dass die xml:ids automatisch generiert werden, siehe IDs für Querverweise automatisch generieren.

So generieren Sie eine eindeutige xml:id für ein Element:

  1. Wählen Sie das Topic oder die Komponente im Content Manager aus, um es/sie im Editor zu öffnen.

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

  2. Wählen Sie das Zielelement in Menü „Elementstruktur“ und wählen Sie dann ID generieren.

    Wenn Sie beispielsweise einen Link zu einem Verfahren erstellen möchten, wählen Sie das procedure-Element aus.

    Paligo erzeugt eine xml:id für das Element im Panel „Elementattribute“

  3. Drücken Sie Speichern.

Anmerkung

Jetzt sollten Sie einen Querverweis zum Element hinzufügen können, siehe:

IDs für Querverweise automatisch generieren

Beim Speichern eines Topics kann Paligo automatisch generierte IDs an neue Elemente vergeben. Diese Funktion ist sehr nützlich, denn IDs werden für Querverweise benötigt. Dadurch ersparen Sie sich Mühe und Zeit für ein manuelles Hinzufügen von xml:ids.

Mithilfe der Editoreinstellungen können Sie steuern, welche Elementtypen automatisch generierte IDs erhalten sollen. Die von Ihnen gewählten Einstellungen gelten für alle Topics und sämtliche Benutzer Ihrer Paligo-Instanz. In der Regel ist für die meisten Benutzer die automatische Generierung von xml:ids für die folgenden Elemente ausreichend (bei Bedarf können Sie weitere Elemente zur Liste hinzufügen):

  1. Wählen Sie das Topic oder die Komponente im Content Manager aus, um es/sie im Editor zu öffnen.

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

  2. Wählen Sie das cog-Symbol im Symbolleiste aus.

  3. Wählen Sie die Registerkarte Globale Einstellungen im Editor-Einstellungen.

  4. Fügen Sie im Feld Autogenerierte ID die Namen der Elemente hinzu, die automatisch generierte xml:ids erhalten sollen.

    In der Regel ist für die meisten Benutzer die automatische Generierung von xml:ids für die folgenden Elemente ausreichend (bei Bedarf können Sie weitere Elemente zur Liste hinzufügen):

    section figure table example equation procedure bridgehead sidebar note warning caution tip important

    Verwenden Sie Leerzeichen, um die einzelnen Elementnamen voneinander zu trennen, und achten Sie darauf, Elementnamen in Kleinbuchstaben zu schreiben.

    Anmerkung

    Wir empfehlen, keine der Standardelemente zu entfernen und nur bei Bedarf welche hinzuzufügen. In vielen Fällen reicht die Verlinkung auf ein section-Element aus, um den Leser zu den relevanten Informationen zu führen.

    Achtung

    Wenn Sie die Standardeinstellungen ändern, bei denen Elementen automatisch eine ID zugewiesen wird, empfehlen wir Ihnen, nur die größeren Blockelementstrukturen einzubeziehen.

    Elemente wie para und title sollten nicht eingeschlossen werden, da dies Probleme mit duplizierten IDs verursachen kann, wenn Sie Textfragmente wiederverwenden.

  5. Wählen SieEinstellungen speichern aus.

Wenn Sie oder andere Benutzer ein neues Element zu einem Topic hinzufügen, prüft Paligo, ob es im Feld Automatisch generierte ID aufgeführt ist. Wenn es aufgelistet ist, gibt Paligo diesem Element eine xml:id. Es werden jedoch nur neue Elemente mit einer xml:id versehen, keine Elemente, die zuvor im Topic vorhanden waren.

Tipp

Es ist auch möglich, xml:ids über Menü „Elementstruktur“ manuell zu generieren, siehe IDs für Querverweise manuell generieren