Glossar-Topic

Um ein Glossar für Ihre Publikation zu erstellen, muss ein glossary-Element zu einem Topic hinzugefügt werden. Nach dem Hinzufügen wird von Paligo die für ein Glossar erforderliche Grundstruktur hinzugefügt. Einige Elemente sind optional und können gelöscht werden, wenn sie nicht benötigt werden. Die Verwendung von glossterm in Topics ermöglicht es Ihnen, die Formatierung von Begriffen in der Publikation zu ändern, und es werden Links zu den entsprechenden Definitionen auf der Glossarseite generiert.

Überlegen Sie, in welcher Form das Glossar in der veröffentlichten Ausgabe erscheinen soll:

Wenn Sie ein Glossar-Topic erstellt haben, das die Glossarbegriffe und -definitionen enthält, können Sie auf diese Begriffe in Ihren Topics verweisen. Wenn Sie beispielsweise eine Glossardefinition für „XML“ haben, dann können Sie darauf verweisen, wenn Sie in Ihrem Inhalt „XML“ erwähnen. In Ihrer veröffentlichten Ausgabe führt der Verweis den Leser zum Glossar (PDF) oder zeigt die Definition (HTML) an.

Beispiel eines Hover-Popovers mit angezeigter Glossardefinition in der HTML-Ausgabe.

Sie können verschiedene Arten von Glossarverweisen nutzen:

Siehe Glossarverweis

Wenn Sie möchten, dass ein Glossarbegriff auf einen anderen Glossarbegriff verweisen soll, können Sie einen „Siehe“-Verweis verwenden. Wenn Sie zum Beispiel einen Glossarbegriff für „Kühlmittel“ haben, können Sie einen „Siehe“-Verweis verwenden, um den Leser zu einem verwandten Begriff zu führen, wie z. B. „Kältetechnik“.

Tipp

Oder Sie verwenden einen „Siehe auch“-Verweis.

So verwenden Sie einen „Siehe“-Verweis:

1. Öffnen Sie Ihr Glossar-Topic oder Ein Glossar-Topic erstellen.

2. Klicken Sie in das Element glossary.

3. Drücken Sie Alt + Enter ⏎ (Windows) oder Command ⌘ + Enter ⏎ (Mac), um den Kontextmenü „Elemente“ anzuzeigen.

4. Geben Sie glossentry ein und wählen Sie es im Menü aus.

   Paligo fügt ein Element glossentry hinzu und enthält ein Element glossterm, acronym, glossdef und para (das Element para ist in glossdef).

5. Klicken Sie in den Bereich zwischen dem glossterm-Element und dem acronym-Element. Dadurch wird das glossentry-Element ausgewählt, welches Sie im Strukturmenü des Elements und im Abschnitt Elementattribute sehen können.

   Hiermit wird das Element glossentry ausgewählt, das Sie im Menü „Elementstruktur“ und im Panel „Elementattribute“ sehen können.

6. Fügen Sie über das Kontextmenü des Elements das glossee-Element hinzu:

7. Löschen Sie nun die Elemente acronym, glossdef und para zu dem Glossareintrag. Jetzt sollten nur noch die Elemente glossentry und glossee übrig sein.

   Anmerkung

   In einem glossentry darf entweder ein glossee-Element oder ein glossdef-Element enthalten sein, nicht jedoch beides.

8. Suchen Sie in Ihren Glossardefinitionen den Glossarbegriff, auf den Sie verweisen möchten. Wenn Sie beispielsweise einen Verweis à la „Siehe Kältetechnik“ erstellen möchten, suchen Sie nach der Glossardefinition für „Kältetechnik“.

   Wenn Sie beispielsweise einen Verweis à la „Siehe Kältetechnik“ erstellen möchten, suchen Sie nach der Glossardefinition für „Kältetechnik“.

9. Wählen Sie das glossentry-Element für den Begriff aus, auf den Sie verweisen möchten.

10. Kopieren Sie im Abschnitt Elementattribute das Attribut xml:id für das glossentry.

    Anmerkung

    Falls das glossentry keine xml:ID besitzt, wählen Sie im Strukturmenü des Elements das glossentry-Element und dann ID generieren. Paligo erstellt eine xml:id für das glossentry-Element.

11. Wählen Sie das Element glosseealso oder glosssee aus, das Sie vorher hinzugefügt haben.

12. Fügen Sie im Panel „Elementattribute“ das Attribut Otherterm hinzu und fügen Sie die kopierte xml:id als Wert ein.

    Das Attribut Otherterm verknüpft das glosseealso- oder glossee-Element mit dem anderen Glossarbegriff, auf den Sie verweisen. Die xml:id wird von Paligo benötigt, um den anderen Glossarbegriff identifizieren zu können.

13. Drücken Sie Speichern.

Wenn Sie Ihren Inhalt (einschließlich Glossar) veröffentlichen, erhalten Sie einen „Siehe“-Verweis auf den Glossarbegriff, den Sie in Schritt 4 ausgewählt haben.

Beispiel 1. „Siehe“-Verweis in einem Glossar

Stellen Sie sich in diesem Beispiel vor, Sie haben einen Glossarbegriff für „Profiling“ und benötigen statt einer Beschreibung einen Verweis, um „Siehe Filter“ anzuzeigen.

In Ihrem Glossar-Topic haben Sie bereits einen Glossareintrag „Filter“ mit folgender Struktur:

<glossentry xml:id="N5fa17485ec783">
      <glossterm xinfo:text="14442">Filters</glossterm>
      <glossdef>
        <para>Filters are also known as profiles or conditional text. You can use them to markup your topics so that when you publish, you can choose whether to include of exclude parts of your content.</para>
      </glossdef>
    </glossentry>

Im ersten Schritt erstellen Sie einen neuen Glossareintrag, fügen also ein neues glossentry-Element hinzu und benennen den Eintrag mit „Profiling“.

Löschen Sie die Elemente acronymn und glossdef, da kein Akronym erforderlich ist und weil ein Glossarbegriff nicht gleichzeitig eine Definition und einen „Siehe“-Verweis enthalten darf.

Fügen Sie das glossee-Element hinzu.

Jetzt wählen Sie das glossentry-Element für den Glossarbegriff aus, auf den Sie verweisen möchten, in diesem Fall „Filter“. Danach kopieren Sie den xml:id-Wert aus dem Abschnitt Elementattribute heraus.

Sie wählen das glossee-Element für den Glossareintrag „Profiling“ aus und fügen dann im Abschnitt Elementattribute das Attribut „Otherterm“ hinzu.

Kopieren Sie die xml:id des Glossareintrags „Filter“ in das value-Feld für das Otherterm-Attribut.

Sie speichern das Glossar und veröffentlichen es im Rahmen einer Publikation. In der Ausgabe wird im Eintrag für Profiling „Zu Filterung gehen“ angezeigt.

Der Glossarverweis „Siehe auch“

Wenn gewünscht, können Sie einigen Glossarbegriffen einen „Siehe auch“-Verweis sowie die Definition des Glossarbegriffs hinzufügen. Wenn Sie beispielsweise einen Glossarbegriff für „Kühlmittel“ haben, könnten dafür eine Definition und ein „Siehe auch“-Verweis auf einen anderen verwandten Begriff existieren, wie z. B. „siehe auch Kältetechnik“.

Tipp

Oder Sie verwenden einen „Siehe“-Verweis.

So verwenden Sie einen „Siehe auch“-Verweis:

1. Öffnen Sie Ihr Glossar-Topic oder Ein Glossar-Topic erstellen.

2. Klicken Sie in das Element glossary.

3. Drücken Sie Alt + Enter ⏎ (Windows) oder Command ⌘ + Enter ⏎ (Mac), um den Kontextmenü „Elemente“ anzuzeigen.

4. Geben Sie glossentry ein und wählen Sie es im Menü aus.

   Paligo fügt ein Element glossentry hinzu und enthält ein Element glossterm, acronym, glossdef und para (das Element para ist in glossdef).

5. Klicken Sie in den Bereich unterhalb von glossdef „Definition“. Das glosseealso-Element muss sich ebenfalls innerhalb von glossdef befinden, aber hinter dem para, das sich innerhalb von glossdef befindet.

   Das glosseealso-Element muss sich ebenfalls innerhalb von glossdef befinden, aber hinter dem para, das sich innerhalb von glossdef befindet.

6. Fügen Sie über das Kontextmenü des Elements das glosseealso-Element hinzu:

7. Suchen Sie in Ihren Glossardefinitionen den Glossarbegriff, auf den Sie verweisen möchten. Wenn Sie beispielsweise einen Verweis „Siehe auch Kältetechnik“ anlegen möchten, suchen Sie nach der Glossardefinition für „Kältetechnik“.

   Wenn Sie beispielsweise einen Verweis „Siehe auch Kältetechnik“ anlegen möchten, suchen Sie nach der Glossardefinition für „Kältetechnik“.

8. Wählen Sie das glossentry-Element für den Begriff aus, auf den Sie verweisen möchten.

9. Kopieren Sie im Abschnitt Elementattribute das Attribut xml:id für das glossentry.

   Anmerkung

   Falls das glossentry keine xml:ID besitzt, wählen Sie im Strukturmenü des Elements das glossentry-Element und dann ID generieren. Paligo erstellt eine xml:id für das glossentry-Element.

10. Wählen Sie das Element glosseealso oder glosssee aus, das Sie vorher hinzugefügt haben.

11. Fügen Sie im Panel „Elementattribute“ das Attribut Otherterm hinzu und fügen Sie die kopierte xml:id als Wert ein.

    Das Attribut Otherterm verknüpft das glosseealso- oder glossee-Element mit dem anderen Glossarbegriff, auf den Sie verweisen. Die xml:id wird von Paligo benötigt, um den anderen Glossarbegriff identifizieren zu können.

12. Drücken Sie Speichern.

Wenn Sie Ihren Inhalt (einschließlich Ihres Glossars) veröffentlichen, erhalten Sie einen „Siehe auch“-Verweis auf den Glossarbegriff, den Sie in Schritt 4 ausgewählt haben.

Beispiel 2. „Siehe auch“-Verweis in einem Glossar

Stellen Sie sich in diesem Beispiel vor, Sie möchten einen Glossarbegriff für „Profiling“ erstellen, der sowohl eine Definition bereitstellt als auch Ihren Lesern vorschlägt, sich den Begriff „Filter“ anschauen.

In Ihrem Glossar-Topic haben Sie bereits einen Glossareintrag „Filter“ mit folgender Struktur:

<glossentry xml:id="N5fa17485ec783">
      <glossterm xinfo:text="14442">Filters</glossterm>
      <glossdef>
        <para>Filters are also known as profiles or conditional text. You can use them to markup your topics so that when you publish, you can choose whether to include of exclude parts of your content.</para>
      </glossdef>
    </glossentry>

Im ersten Schritt erstellen Sie einen neuen Glossareintrag, fügen also ein neues glossentry-Element hinzu und benennen den Eintrag mit „Profiling“.

Sie löschen sein acronym-Element, da es in diesem Fall nicht benötigt wird.

Geben Sie eine Definition für „Profiling“ ein

und fügen Sie das Element glosseealso hinzu.

Jetzt wählen Sie das glossentry-Element für den Glossarbegriff aus, auf den Sie verweisen möchten, in diesem Fall „Filter“. Danach kopieren Sie den xml:id-Wert aus dem Abschnitt Elementattribute heraus.

Sie wählen das glosseealso-Element für den Glossareintrag „Profiling“ aus und fügen dann im Abschnitt Elementattribute das Attribut Otherterm hinzu.

Kopieren Sie die xml:id des Glossareintrags „Filter“ in das value-Feld für das Otherterm-Attribut.

Sie speichern das Glossar und veröffentlichen es im Rahmen einer Publikation. In der Ausgabe wird der Eintrag für Profiling die Definition dieses Begriffs anzeigen und auf „Siehe auch Filterung“ verweisen.

Wenn Sie ein Glossar erstellen, fügen Sie ein glossary-Element hinzu, das standardmäßig ein title-Element enthält. Mithilfe des Glossar-Titels können Sie das Glossar benennen. Je nachdem, wie Ihr Glossar aufgebaut ist, können Sie festlegen, dass es gar keinen Titel haben soll.

Eine der gängigsten Möglichkeiten, ein Glossar einzurichten, besteht darin, ein Topic mit dem Namen „Glossar“ zu erstellen und ihm ein glossary-Element hinzuzufügen. In diesem Szenario lautet der Titel des Topics „Glossar“, so dass eher kein Bedarf an einem Glossartitel besteht. Das ist kein Problem – wenn Sie z. B. den Glossartitel löschen, wird das Glossar weiterhin wie erwartet funktionieren. Im folgenden Bild ist „Glossar“ der Titel des Topics und das eigentliche Glossar ist nicht extra betitelt.

Es ist aber auch möglich, ein Glossar zu einem Topic hinzuzufügen, das nicht „Glossar“ heißt. Sie können beispielsweise ein Glossar zu einem Topic mit der Bezeichnung „Referenz“ hinzufügen. In einem solchen Szenario kann es sinnvoll sein, auch einen Glossartitel zu verwenden. Der Titel erleichtert das Auffinden Ihres Glossars, da es kein „Glossar“-Topic gibt. In der folgenden Abbildung wurde ein Glossar zu einem „Referenz“-Topic hinzugefügt und das Glossar trägt den Titel „Glossar“.

Wenn Sie einen Glossartitel verwenden, sollten Sie Folgendes berücksichtigen:

Einen Glossartitel hinzufügen

Wenn Sie ein glossary-Element hinzufügen, enthält es standardmäßig auch einen title. Innerhalb des title-Elements können Sie den Text für Ihren Titel eingeben.

Falls Sie den Glossartitel entfernt haben und später entscheiden, dass Sie doch einen Titel wünschen, können Sie entweder:

• einen Glossartitel manuell eingeben, indem Sie das title-Element hinzufügen, oder

• Paligo so einstellen, dass automatisch ein Glossartitel generiert wird.

  Um einen automatisch generierten Glossartitel zu verwenden, siehe Automatischer Glossartitel für PDF-Ausgaben und Glossartitel für HTML5-Ausgaben.

So fügen Sie einen Glossartitel manuell hinzu:

1. Öffnen Sie im Paligo Editor das Topic, das Ihr Glossar enthält.

2. Wählen Sie das glossary-Element aus.

3. Über das Kontextmenü des Elements können Sie das title-Element hinzufügen.

4. Geben Sie den Text für Ihren Glossartitel innerhalb des title-Elements ein.

5. Drücken Sie Speichern.

Glossartitel in PDF-Lesezeichen aufnehmen

PDFs können Lesezeichen enthalten, die wie ein Inhaltsverzeichnis in einer Seitenleiste fungieren, in der Ihre Topics nacheinander aufgelistet sind. Wenn Sie ein Glossar haben, möchten Sie wahrscheinlich, dass dort ein Link zum Glossar erscheinen soll.

Befindet sich Ihr Glossar in einem Topic mit der Bezeichnung „Glossar“, müssen Sie nichts weiter unternehmen. Das Topic „Glossar“ erscheint standardmäßig in den Lesezeichen.

Wenn sich Ihr Glossar jedoch in einem Topic mit einem ganz anderen Titel befindet, ist es nicht so offensichtlich, wie man zum Glossar gelangen kann. Nehmen wir zum Beispiel an, Sie haben Ihr Glossar zu einem Topic namens „Einzelnachweise“ hinzugefügt und den Titel des Glossars entfernt. In der veröffentlichten PDF steht in den Lesezeichen nur „Einzelnachweise“, was es Ihren Lesern erschweren könnte, das Glossar zu finden.

Um dies zu ändern, können Sie Paligo so einstellen, dass auch der Titel des Glossars in die Lesezeichen aufgenommen wird. Falls Ihr Glossar keinen Titel hat, können Sie einen hinzufügen oder Sie stellen Paligo so ein, dass dieser automatisch generiert wird.

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

   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 das Layout, das Sie aktualisieren möchten, oder Ein Layout erstellen aus.

   Tipp

   Sie können die URL des Layout-Editors kopieren und in eine neue Registerkarte in Ihrem Browser einfügen. Dies kann nützlich sein, wenn Sie häufig zwischen Ihren Paligo-Inhalten und den Layout-Einstellungen wechseln.

3. Wählen Sie Allgemein und dann Glossar, Index und Quellenverzeichnis.

4. Aktivieren Sie die Einstellung Glossartitel oder Auto-Titel in Lesezeichen, damit Paligo den Titel des glossary-Elements in die Lesezeichen aufnimmt.

   Anmerkung

   Diese Einstellung funktioniert nur, wenn Ihr Glossar einen Titel hat oder Sie Paligo so eingestellt haben, dass ein Titel automatisch generiert wird.

5. Drücken Sie Speichern.

Wenn Sie mit diesem Layout in PDF veröffentlichen, wird die Ausgabe den automatischen Glossartitel ein- bzw. ausschließen.

Wenn Sie mit diesem Layout in PDF veröffentlichen, nimmt Paligo den Glossartitel in die Lesezeichen auf. Er ist ein Unterabschnitt seines übergeordneten Topics.

Für die PDF-Ausgabe können Sie Glossarbegriffe, die in der veröffentlichten Ausgabe nicht verwendet werden, mit Paligo-Glossar herausfiltern. Dies ist hilfreich, wenn Sie dasselbe Glossar-Topic für verschiedene Publikationen wiederverwenden.

Wenn Sie Veröffentlichung als PDF, sucht Paligo nach den Verweisen in Ihrer Publikation. Das Glossar wird dann so gefiltert, dass es nur diejenigen Begriffe enthält, auf die in Ihrer Publikation tatsächlich verwiesen wird. Alle anderen Begriffe werden aus dem veröffentlichten Glossar ausgeschlossen.

So legen Sie fest, dass Ihr Glossar nur Begriffe enthält, die in einer Publikation erscheinen:

• Drücken Sie Speichern.

Bei der Veröffentlichung filtert Paligo alle nicht verwendeten Begriffe aus dem Glossar heraus.

Beispiel 3. Publikationsreihe für ein einzelnes Produkt

Angenommen, Sie möchten für ein einzelnes Produkt, z. B. einen Industrieventilator, mehrere Publikationen anbieten:

• Eine Benutzeranleitung für die Steuerelemente des Ventilators zur Verwendung im Werk.

• Eine Installationsanleitung für Elektriker, die den Ventilator im Werk montieren.

• Einen Firmware-Leitfaden, der von Ihren Servicetechnikern verwendet wird, die zu Ihnen ins Werk kommen, um Updates für den Ventilator vorzunehmen.

Anstatt für diese Publikationen separate Glossare zu erstellen, erstellen Sie ein Glossar, das in allen drei genutzt werden kann. Das Glossar enthält jedoch einige Begriffe, die in der Benutzeranleitung nicht auftauchen sollen, da es sich um Fachbegriffe handelt, die nicht für Kunden gedacht sind.

Wenn Sie das Glossar so einstellen, dass alle nicht aufgeführten glossterm-Begriffe herausgefiltert werden, enthält jede Publikation nur die Begriffe, die in der jeweiligen Publikation erscheinen. Anders gesagt, erhalten Sie eine Benutzeranleitung mit einem Glossar, das lediglich die in der Benutzeranleitung verwendeten Begriffe aufführt, die Installationsanleitung enthält nur die Begriffe, die in der Installationsanleitung erscheinen, usw.

Wenn Sie möchten, dass Ihr Glossar automatisch alphabetisch sortiert wird, gibt es zwei Möglichkeiten, die Glossareinträge alphabetisch zu sortieren: Glossareinträge im Editor sortieren und Automatische Sortierung von Glossareinträgen für die Veröffentlichung.

Glossar-Popovers sind Panels, die erscheinen, wenn Sie mit dem Mauszeiger über einen Begriff fahren, der mit dem Glossar verknüpft ist. Sie enthalten den Glossarbegriff nebst Definition aus dem passenden Begriff in Ihrem Glossar und sind nur in HTML5-Helpcenter-Ausgaben verfügbar.

Paligo erstellt automatisch Glossar-Popover für Sie. Wenn Sie möchten, können Sie sie jedoch deaktivieren, sodass Ihre Glossarverweise nur einen Link zum Glossar-Topic haben.

So steuern Sie für die HTML5-Ausgabe, ob Glossar-Popover verwendet werden sollen:

Wenn Sie dieses Layout für Ihre Veröffentlichung in HTML5 nutzen, enthält Ihre Ausgabe Glossar-Popovers, sofern Sie diese aktiviert haben. Das können Sie testen, indem Sie den Mauszeiger über den Text bewegen, der auf einen Begriff in Ihrem Glossar verweist. Wenn Popovers deaktiviert sind, erscheinen die Glossarverweise lediglich als Links.

Wie jedes andere Topic auch können Glossare in mehreren Sprachen erstellt werden. Sie fügen dem Topic die gewünschte(n) Sprache(n) hinzu, sodass es dann die Inhalte für die Quellsprache und die Übersetzungen für jede weitere Sprache enthalten wird (siehe Arbeiten in der Übersetzungsansicht).

Für ein mehrsprachiges Glossar benötigen Sie:

Die meisten Arten von Glossarverweisen funktionieren in allen Sprachen (siehe Glossarverweise) – bis auf eine Ausnahme. Wenn ein Begriff in Ihrem Text auf einen Glossareintrag verweisen soll, der Text jedoch nicht mit dem Glossarbegriff übereinstimmt, müssen Sie einen xml:id-Verweis verwenden. Weitere Informationen finden Sie unter Die Unterschiede von Topic-Begriff und Glossarbegriff.

Bei der Übersetzung Ihrer Inhalte kommt es darauf an, dass ausschließlich der Text übersetzt wird. Elementnamen, Attributnamen oder Attributwerte dürfen nicht übersetzt werden.