Topics

8 min read

Überschriften und Untertitel

Standardmäßig werden die Überschriften nicht nummeriert. Wenn Ihre Dokumentation nummerierte Überschriften benötigt, können Sie Paligo so einstellen, dass es Nummern enthält, siehe Nummerierte Überschriften.

Sie können auch Zwischenüberschriften in Ihren Topics verwenden. Diese helfen, Seiten mit vielen Informationen aufzulockern, so dass sie leichter zu lesen sind. Es gibt mehrere Möglichkeiten, Zwischenüberschriften und Unterabschnitte zu erstellen, wie in Unterabschnitte beschrieben.

Beispiel für eine Hilfeseite mit Zwischenüberschriften (Unterabschnitten).

In Paligo hat jedes Topic einen:

  1. Ressourcentitel ist der Name des Topics im Content Manager.

    Das Ändern des Ressourcentitels oder des Textes im Element title kann sich auf die URL des Topics in HTML-Ausgaben auswirken. Dies hängt davon ab, wie Ihr Layout für die Veröffentlichung eingerichtet ist, siehe Dateinamen von Topics.

  2. Das Element section repräsentiert das gesamte Topic. Sie sehen es, wenn Sie das Topic im Editor öffnen.

  3. Das Element title steht unmittelbar nach dem Element section und ist für die Hauptüberschrift des Topics vorgesehen. Standardmäßig ist es so eingestellt, dass es mit dem Titel der Ressource übereinstimmt, aber Sie können beide ändern. Sie müssen nicht zusammenpassen.

    Einige andere Elemente haben auch titles, wie Tabellen und Beispiele. Diese title sind standardmäßig enthalten, Sie können sie jedoch auf Wunsch entfernen.

Unterabschnitte

Um das Textverständnis zu erleichtern, können Sie Ihre Inhalte mithilfe von Unterabschnitten in kleinere Informationseinheiten unterteilen, siehe Unterabschnitte erstellen.

Die Vorteile von Unterabschnitten:

  • Die Leser können den Haupttitel und die Untertitel schnell erfassen und wissen gleich, worum es auf der Seite geht.

  • Zudem kann der Verfasser sich in Unterabschnitten ganz auf die darin benötigten Informationen konzentrieren statt auf das gesamte Topic.

  • Kleinere Abschnitte sind optisch ansprechender. Eine längere Textpassage kann abschreckend wirken.

Dieses Beispiel zeigt die Seite „Topic-Vorlagen“, die einen Unterabschnitt namens „Eine Topic-Vorlage erstellen“ enthält.

Informationen zum Einrichten und Verwalten der verschiedenen Unterabschnittstypen finden Sie unter:

Überschriften und URLs ändern

Wenn Sie den Titeltext eines Topics ändern möchten, sollten Sie zunächst überlegen, wie sich dies auf Ihre veröffentlichte Ausgabe auswirkt.

  • Bei PDFs hat eine Änderung einer Überschrift keinen Einfluss auf die Ausgabe, sodass Sie bei Bedarf Änderungen vornehmen können.

  • Für HTML generiert Paligo aus dem Titel die URL (Adresse) der Webseite für jedes Topic. Wenn Sie also den Titel ändern, ändert sich auch die URL, wenn Sie veröffentlichen.

Paligo erkennt automatisch Titeländerungen und aktualisiert Ihre Inhalte, um die neue URL zu verwenden. Paligo kann jedoch keine Links ändern, die von externen Systemen kommen. Wenn Ihre Website beispielsweise auf eine Seite in der Hilfe verweist und sich die URL der Seite geändert hat, funktioniert der Link nicht mehr. Um dieses Problem zu vermeiden, können Sie:

Vorhandene URLs für HTML-Seiten beibehalten.

Eine Möglichkeit, den Titel eines Topics zu ändern, ohne seine URL zu beeinflussen, ist die Verwendung des Attributs xinfo:outname. Dieses Attribut steht für das Element „Abschnitt“ zur Verfügung.

Wenn Sie einen xinfo:outname-Wert festlegen, wird dieser Wert für die URL der HTML-Seite für dieses Topic verwendet. Die xinfo:outname hat Vorrang vor allen anderen URL-Einstellungen und wird daher auch dann verwendet, wenn Sie das HTML-Layout so einstellen, dass statt Titeln Topic-Namen verwendet werden.

So behalten Sie die bestehende URL einer HTML-Seite bei:

  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. Ändern Sie den Text im Element title.

  3. Wählen Sie das section-Element im Menü „Elementstruktur“ aus.

  4. Wählen Sie Zu Element wechseln aus.

  5. Fügen Sie das Attribut xinfo:outname im Panel „Elementattribute“ hinzu.

  6. Navigieren Sie in Ihrer vorhandenen Hilfeausgabe zur Seite mit der URL, die Sie behalten möchten, und kopieren Sie den Seitenteil der URL.

    Zum Beispiel, wenn die Seite die URL hat: https://acmehelp/docs/en/6083-introduction.html

    Kopieren Sie 6083-introduction, da dies der Seitenteil der URL ist. Fügen Sie die Dateierweiterung .html nicht hinzu, Sie benötigen nur den Seitennamen.

  7. Fügen Sie den Seitenteil der URL in das Wertefeld für das Attribut xinfo:outname ein.

  8. Drücken Sie Speichern.

Wenn Sie in HTML veröffentlichen, verwendet Paligo den Wert xinfo:outname für den Seitenteil der URL. Es wird nicht der Titel oder der Topic-Name verwendet, der xinfo:outname hat Vorrang.

Beispiel 27. Verwendung von xinfo:outname zur Beibehaltung der bestehenden URL

Nehmen wir zum Beispiel an, Sie haben ein Topic mit dem Titel „Einführung“. Bei der ersten Veröffentlichung stellte Paligo die URL auf: https://acmehelp/docs/en/introduction.html

Ihr Kundensupport-Team hat dann bei der Beantwortung von Kundenanfragen Links zu dieser Seite verwendet.

Einige Zeit später müssen Sie den Seitentitel auf „Einführung in ACME 100“ aktualisieren, wollen aber nicht die Links zerstören, die der Kundensupport verschickt hat.

Sie ändern den Titeltext des Topics in „Einführung in ACME 100“ und fügen dann das Attribut xinfo:outname in den Abschnitt des Topics ein. Sie setzen den Wert des Attributs auf: introduction.

Sie veröffentlichen den Inhalt in HTML. Paligo verwendet den Wert xinfo:outname (introduction), um den Seitenteil der URL anstelle des neuen Titeltextes zu erstellen. In der Ausgabe hat die Seite also diese URL:

https://acmehelp/docs/en/introduction.html

Wenn Sie den xinfo:outname nicht gesetzt hätten, würde die Seite die neue URL haben, die auf der Änderung des Titeltextes basiert, und sie wäre gewesen:

https://acmehelp/docs/en/introduction-to-acme-100.html

Topic-Namen statt Titel für die URLs von HTML-Seiten

Sie können Paligo so einstellen, dass anstelle von Titeln für die Dateinamen und URLs für HTML-Seiten Topic-Namen verwendet werden. Die Topic-Namen werden dann anstelle des Textes Titel für den Seitenteil der URLs verwendet.

Wenn ein Topic beispielsweise „IoT Controls“ heißt und den Titel „Controls for IoT System“ hat, sieht die URL für die Seite in der HTML-Ausgabe wie folgt aus: https://acmehelp/docs/en/iot-controls.HTML

Anmerkung

Beachten Sie, dass der Seitenteil der URL den Namen des Topics („IoT Controls“) und nicht den Titeltext („Controls for IoT System“) verwendet.

So stellen Sie Paligo so ein, dass Topic-Namen anstelle von Titeltext für URLs verwendet werden:

  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 auf der Seitenleiste Allgemein aus.

  4. Kontrollieren Sie, ob Topic-Namen für URLs in Ressourcenname statt Titel für den HTML-Ausgabedateinamen verwenden verwendet werden:

    • Setzen Sie die Option auf Aktiviert, um Topic-Namen zu verwenden.

    • Stellen Sie sie auf Deaktiviert ein, um den Text im Topic-Element title zu verwenden. Standard

  5. Drücken Sie Speichern.

Wenn Sie die Einstellung Ressourcenname anstelle des Titels für den Dateinamen der HTML-Ausgabe verwenden aktiviert haben, verwendet Paligo die Topic-Namen für die Dateinamen und URLs. Das bedeutet, dass Sie nun Ihren Topic-Text Titel ändern können, ohne die URLs für die Seiten zu beeinflussen.

Nummerierte Überschriften

Standardmäßig verwendet Paligo nur Textüberschriften, aber Sie können stattdessen nummerierte Überschriften verwenden. Nummerierte Überschriften haben als Präfix Zahlen.

Um nummerierte Überschriften zu aktivieren oder zu deaktivieren, bearbeiten Sie das Layout, das Sie für die Veröffentlichung verwenden.

  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. Suchen Sie die Einstellungen für die Abschnittsnummerierung.

    Bei PDF-Layouts befinden sich die Einstellungen für die Abschnittsnummerierung unter Abschnittstitel > Alle Abschnitte.

    Für HTML-Layouts stehen die Einstellungen für die Abschnittsnummerierung in Toc und Chunking.

  4. Über die Abschnittsnummerierung steuern Sie, ob Ihre Überschriften Zahlen verwenden. Wählen Sie Aktiviert für nummerierte Überschriften, Deaktiviert für reine Textüberschriften.

  5. Verwenden Sie die maximale Tiefe der Abschnittsnummerierung, um zu steuern, welche Überschriftenebenen nummeriert werden. Die Standardeinstellung ist 3, was bedeutet die drei obersten Überschriftenebenen werden nummeriert, während ab Ebene 4 nur noch Text angezeigt wird.

  6. Drücken Sie Speichern.

Sie können wählen, ob Ihre Überschriften ein Zahlenpräfix verwenden.

Verwenden von Titelabkürzungen

Das Element titleabbrev ist nützlich, wenn die Titel lang sind, Sie jedoch kürzere Titel im Inhaltsverzeichnis (PDF), auf der Inhaltsleiste (HTML5) und für Querverweise bevorzugen.

Wenn Sie Inhalte mit dem Element titleabbrev veröffentlichen, verwenden das Inhaltsverzeichnis (PDF), die TOC-Seitenleiste (HTML5) und die Querverweise den Text titleabbrev als Titel. Aber das Haupt-Topic verwendet jedoch weiter den title des Topics.

Anmerkung

Paligo-Topics verwenden weiterhin den vollständigen Titel, den sie erhalten haben (im Element „title“). Die kürzere titleabbrev wird automatisch im Inhaltsverzeichnis und optional in den Breadcrumb-Links und im Inhaltsverzeichnis verwendet.

So fügen Sie einen alternativen Titel zu einem Topic hinzu:

  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. Positionieren Sie den Cursor zwischen dem Element title und dem ersten Element para.

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

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

  5. Positionieren Sie den Cursor innerhalb des Elements titleabbrev.

  6. Geben Sie den Text für den alternativen Titel ein.

  7. Drücken Sie Speichern.

  8. Wählen Sie Layout und dann das Layout aus, das Sie für die Veröffentlichung verwenden.

    Paligo öffnet das Layout im Layout-Editor.

  9. Stellen Sie Paligo so ein, dass bei Querverweisen titleabbrev oder title verwendet wird.

    1. Navigieren Sie in Ihrem Layout zu der Einstellung titleabbrev in Querverweisen verwenden.

      • Bei PDF-Layouts befindet sich die Einstellung in der Kategorie Querverweise.

      • Bei HTML-Layouts befindet sich die Einstellung in der Kategorie Allgemein.

      • Bei HTML5-Layouts befindet sich die Einstellung in der Kategorie Querverweise.

    2. Stellen Sie titleabbrev in Querverweisen verwenden auf:

      • Aktivieren, um titleabbrev anstelle von title in Querverweisen und im TOC zu verwenden

      • Deaktivieren, um title anstelle von titleabbrev in Querverweisen und im TOC zu verwenden

      • Standard – um den Wert für diese Einstellung aus dem Basislayout zu übernehmen. Das Basislayout kann ein von Paligo bereitgestelltes integriertes Layout oder ein anderes kundenspezifisches Layout ein. Weitere Informationen finden Sie unter Layoutbeziehungen – Basis, Neu, Duplizieren.

  10. Dieser Schritt gilt nur für HTML5-Layouts. Verwenden Sie das Layout, um das Breadcrumb so einzustellen, dass der Text title oder titleabbrev verwendet wird:

    1. Wählen Sie die Kategorie Allgemein aus.

    2. Stellen Sie titleabbrev in Breadcrumb-Titeln verwenden auf:

      • Aktivieren, um den Text titleabbrev anstelle des Textes title zu verwenden

      • Deaktivieren, um den Text title anstelle des Textes titleabbrev zu verwenden

      • Standard – um den Wert für diese Einstellung aus dem Basislayout zu übernehmen. Das Basislayout kann ein von Paligo bereitgestelltes integriertes Layout oder ein anderes kundenspezifisches Layout ein. Weitere Informationen finden Sie unter Layoutbeziehungen – Basis, Neu, Duplizieren.

  11. Drücken Sie Speichern.

Wenn Sie Ihre Layouts veröffentlichen, verwendet Paligo den Titel oder den abgekürzten Titel, je nachdem, was Sie im Layout ausgewählt haben.