Unterabschnitte

8 min read

Unterabschnitte erstellen

Verwenden Sie Unterabschnitte, um lange Textpassagen in verwandte Informationen aufzuteilen. So können Ihre Zielgruppen Ihre Inhalte leichter lesen und verarbeiten. Sie ermöglicht es ihnen auch, die Informationen auf einer Seite schnell zu beurteilen, indem sie sich die Überschriften (Unterüberschriften) des Unterabschnitts ansehen. Es gibt mehrere Möglichkeiten, Unterabschnitte in Paligo zu erstellen, jede mit ihren eigenen Vor- und Nachteilen.

Wenn Sie wissen, dass Sie Ihre Hauptabschnitte und Unterabschnitte separat wiederverwenden müssen, können Sie jeden Abschnitt als separates Topic erstellen. Verwenden Sie die Publikationsstruktur, um zu steuern, wo die Unterabschnitte erscheinen. Details hierzu finden Sie unter:

Nachteilig ist jedoch, dass Sie beim Bearbeiten immer nur einen Abschnitt gleichzeitig sehen können. (In der Ausgabe sehen Ihre Leser den Inhalt als Hauptabschnitt mit einem Unterabschnitt auf derselben Seite, sofern der Platz es zulässt.) Wenn Sie während der Bearbeitung den Hauptabschnitt und den Unterabschnitt im selben Topic sehen möchten, gehen Sie wie folgt vor:

Anmerkung

Bei diesen beiden Methoden werden die Unterabschnitte innerhalb des „Haupt“-Topics angezeigt. Das bringt aber auch mit sich, dass bei einer Wiederverwendung des „Haupt“-Topics auch die darin enthaltenen Abschnitte wiederverwendet werden.

Mit der Publikationsstruktur Unterabschnitte erstellen

Sie können die Publikationsstruktur für die Erstellung von Unterabschnitten verwenden. Paligo erstellt in der veröffentlichten Ausgabe automatisch dieselbe Struktur.

  1. Legen Sie alle Ihre Abschnitte und Unterabschnitte als separate Topics an. Wenn Sie beispielsweise ein Einführungs-Topic haben und möchten, dass es einen Unterabschnitt „Verweise“ enthält, erstellen Sie für Einführung und für Verweise je ein Topic.

  2. Öffnen Sie die Publikationsstruktur.

  3. Ziehen Sie Ihre Topics in die Struktur. Sie können Unterabschnitte erstellen, indem Sie die Topics links und rechts unter andere Topics ziehen.

  4. Folgendes gilt ausschließlich für HTML-Ausgaben: Wählen Sie Layouts und bearbeiten Sie das Layout, das Sie für die Veröffentlichung verwenden möchten. Verwenden Sie in den Einstellungen Inhaltsverzeichnis und Chunking die Chunk-Abschnittstiefe, um zu steuern, ob Topics zu Unterabschnitten werden. Die Standardeinstellung lautet 3, was bedeutet, dass alle Topics auf Ebene 4 und darunter in der Publikationsstruktur zu Unterabschnitten der Topics von Ebene 3 werden.

    Anmerkung

    Wenn ein Topic auf xinfo:chunk=yes eingestellt ist, befindet es sich stets auf einer eigenen Seite, selbst wenn es sich auf einer niedrigeren Ebene befindet als die Chunk-Abschnittstiefe (siehe Unterabschnitte mit Chunking steuern).

  5. Veröffentlichen Sie Ihre Inhalte.

Bei PDF-Ausgaben werden die Unterabschnitte auf der gleichen Seite wie der Hauptabschnitt angezeigt, wenn ausreichend Platz vorhanden ist. Sie werden automatisch als Unterabschnitte mit niedrigeren Überschriftenebenen festgelegt.

Bei HTML-Ausgaben zeigt Paligo jedes Topic auf einer eigenen Seite an, bis die Chunk-Abschnittstiefe erreicht ist. Topics auf einer niedrigeren Ebene werden dann zu Unterabschnitten, es sei denn, sie wurden speziell als separate Chunks festgelegt (siehe Unterabschnitte mit Chunking steuern).

Beispiel 51. Unterabschnitt in einer PDF-Ausgabe

In diesem Beispiel beleuchten wir drei Topics. Um das Ganze einfach zu halten, haben wir sie „Überschrift 1“, „Überschrift 2“ und „Überschrift 3“ genannt.

In der Publikationsstruktur wird „Überschrift 1“ als Topic der obersten Ebene festgelegt, und „Überschrift 2“ und „Überschrift 3“ werden als Unterabschnitte unter „Überschrift 1“ verschachtelt.

Wir veröffentlichen im PDF-Format.

Paligo erkennt die Topic-Hierarchie in der Publikation und erstellt sie in der PDF-Ausgabe neu. Die Topics „Überschrift 2“ und „Überschrift 3“ erscheinen als Unterabschnitte des Topics „Überschrift 1“.

Unterabschnitte mit Chunking steuern

Mit der Chunking-Funktion von Paligo legen Sie fest, ob ein Topic als Unterabschnitt oder als separate Webseite in der HTML-/HTML5-Ausgabe erscheinen soll. Der Begriff „Chunk“ bedeutet, dass ein Topic für sich allein stehen muss. Die Einstellungen für xinfo:chunk in einem Topic wirken sich wie folgt aus:

  • Ja – das Topic darf kein Unterabschnitt innerhalb eines anderen Topics sein und erscheint bei Veröffentlichung stets auf einer separaten Seite. Es darf kein Unterabschnitt auf einer anderen Seite sein.

  • Nein – das Topic darf ein Unterabschnitt innerhalb eines anderen Topics sein.

Anmerkung

Weitere Informationen zu Chunking-Einstellungen finden Sie unter Chunking.

So stellen Sie den Chunking-Wert ein:

  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 section-Element im Menü „Elementstruktur“ aus.

  3. Wählen Sie Zu Element wechseln aus.

  4. Fügen Sie das Attribut xinfo:chunk im Panel „Elementattribute“ hinzu und setzen Sie dessen Wert auf:

    • Ja, um zu verhindern, dass das Topic als Unterabschnitt fungiert.

    • Nein, damit das Topic auch ein Unterabschnitt sein kann.

  5. Drücken Sie Speichern.

Wichtig

Der Wert xinfo:chunk hat Vorrang vor der Einstellung Chunk-Abschnittstiefe im Layout-Editor. Wenn Sie die Chunk-Abschnittstiefe beispielsweise auf 3 festlegen, bedeutet dies normalerweise, dass alle Topics auf Ebene 4 oder darunter zu Unterabschnitten des „übergeordneten“ Topics der Ebene 3 werden. Wurde für Ihr Topic der Ebene 4 jedoch xinfo:chunk = yes festgelegt, wird dieses Topic nicht als Unterabschnitt seines „übergeordneten“ Topics der Ebene 3 aufgenommen. Stattdessen wird es ein separates Topic sein.

Warnung

Ein Topic sollte niemals auf xinfo:chunk=”yes” gesetzt werden, wenn es unterhalb der TOC-Abschnittstiefe liegt, die in Ihren TOC- und Chunking-Layouteinstellungen eingestellt ist (siehe auch die HTML5-Helpcenter-Styling-Seite für weitere Informationen). Wenn ein Topic aufgegliedert ist und zu einem separaten Topic wird, benötigt es einen TOC-Eintrag in dieser Tiefe. Wenn sich Ihr Chunking-Topic also auf Ebene 4 befindet und die TOC-Abschnittstiefe auf Standardwert 3 eingestellt ist, verschwindet das Topic und es kann nicht aufgerufen werden.

Es gibt zwei Möglichkeiten, Chunking zu verwenden (diese sind auch miteinander kombinierbar):

  • Legen Sie im Layout-Editor unter „Inhaltsverzeichnis und Chunking“ die Standardebene fest, ab der Topics abgeschnitten werden sollen.

  • Fügen Sie das Attribut xinfo:chunk zum Element section in einem Topic über den Panel „Elementattribute“ hinzu.

Beispiel 52. Chunk-Abschnittstiefe und xinfo:chunk gemeinsam verwenden

Angenommen, Ihre englischsprachige Publikation heißt „Mars Travel Manual“ und ist in Topics strukturiert, die sich auf verschiedenen Ebenen befinden.

Sie veröffentlichen in HTML5 und haben die Chunk-Abschnittstiefe für Ihr Layout auf 2 festgelegt.

In der veröffentlichten Ausgabe erscheinen die Topics der ersten und zweiten Ebene auf getrennten Seiten. Die Seiten der dritten Ebene oder tiefer sind Unterabschnitte.

Beispielsweise werden das Topic „The Mission Control Center“ sowie dessen untergeordnete Topics in der Ausgabe wie folgt dargestellt:

  1. „The Mission Control Center“ ist ein Topic der obersten Ebene. Es ist höher als die Chunk-Abschnittstiefe von 2, daher hat es in der Ausgabe seine eigene Seite.

  2. „Command Center“ ist ein Topic der zweiten Ebene. Es befindet sich auf derselben Ebene (2) wie die eingestellte Chunk-Abschnittstiefe und wird in der Ausgabe ebenfalls auf einer eigenen Seite dargestellt.

  3. „Controls System“ und „Control Room“ sind Topics der dritten Ebene. Ihr Wert liegt unter der Einstellung für die Chunk-Abschnittstiefe von 2, sodass sie keine eigene Seite erhalten. Vielmehr sind sie Unterabschnitte des Topics „Command Center“, da dies der ihnen unmittelbar übergeordnete Abschnitt („Parent“) in der Publikationsstruktur ist.

Anmerkung

Die grüne Strichellinie im Bild steht für die eingestellte Chunk-Abschnittstiefe von 2.

Doch wenn Sie stattdessen möchten, dass „Controls System“ ein Unterabschnitt von „Command Center“ sein und „Control Room“ eine eigene Seite haben soll? Dann würden Sie zum Topic „Control Room“ folgendes Attribut hinzufügen:

xinfo:chunk = yes

Paligo platziert daraufhin das Topic „Controls System“ in der veröffentlichten Ausgabe auf einer eigenen Seite, da xinfo:chunk Vorrang vor den Chunk-Abschnittstiefe-Einstellungen hat. Im Ergebnis werden in der Ausgabe

  • die Topics „The Mission Control Center“ und „Command Center“ jeweils auf eigenen Seiten dargestellt, da ihre Ebene höher ist als die Chunk-Abschnittstiefe.

  • „Control Room“ steht auf einer separaten Seite, da hierfür xinfo:chunk=yes festgelegt wurde. Die Einstellung Chunk-Abschnittstiefe gilt nicht für dieses Topic.

  • „Controls System“ ist ein Unterabschnitt von „Command Center“, da er keine Einstellung xinfo:chunk=yes besitzt und daher die Chunk-Abschnittstiefe Anwendung findet.

Komponenten zum Erstellen von Unterabschnitten verwenden

Wenn Sie während der Bearbeitung die Unterabschnitte Ihrer Topics sehen möchten, bietet es sich an, Komponenten für Unterabschnitte zu verwenden. Mit dieser Technik erstellen Sie Ihren Haupt- und Unterabschnitt als separate Topics und importieren dann die Unterabschnitte in das Haupt-Topic. Anschließend werden das Haupt-Topic und die Unterabschnitte alle innerhalb desselben Topics angezeigt. Dadurch lässt sich die Abfolge Ihrer Inhalte leichter überprüfen und sicherstellen, dass Sie alle Themen wie geplant abgedeckt haben.

Um zu erfahren, wie Komponenten für Unterabschnitte verwendet werden, sehen Sie sich das Video an oder lesen Sie die nachstehenden Anweisungen.

  1. Legen Sie alle Ihre Abschnitte und Unterabschnitte als separate Topics an. Wenn Sie beispielsweise ein Einführungs-Topic haben und möchten, dass es einen Unterabschnitt „Verweise“ enthält, erstellen Sie für Einführung und für Verweise je ein Topic.

  2. Öffnen Sie ein Topic, das ein Hauptabschnitt mit Unterabschnitten werden soll.

  3. Wählen Sie die Registerkarte Einfügen im Symbolleiste.

  4. Wählen Sie Komponente aus, danach ein Topic.

    Das Topic wird als import-Element hinzugefügt und Sie sehen es nun als Unterabschnitt in Ihrem Topic.

  5. Wiederholen Sie die Schritte 3 bis 4 für jeden Unterabschnitt, den Sie hinzufügen möchten, und speichern Sie jedes Topic.

  6. Drücken Sie Speichern.

  7. Wenn Sie mit dem Hinzufügen von Topics als Komponenten fertig sind, veröffentlichen Sie sie in HTML.

Mit dem section-Element Unterabschnitte generieren

Eine schnelle und einfache Möglichkeit zur Erstellung eines Unterabschnitts besteht darin, innerhalb eines section-Elements ein weiteres section-Element hinzuzufügen. Sie können dann während der Bearbeitung den Hauptabschnitt und den Unterabschnitt im selben Topic sehen. Da dieses Vorgehen einige Beschränkungen aufweist, empfiehlt es sich, stattdessen eine einfügbare Komponente zu verwenden:

  • Wiederverwendbarkeit – Der Unterabschnitt kann nicht einfach in anderen Topics wiederverwendet werden, es sei denn, Sie Unterabschnitte in separate Topics umwandeln und importieren diese als Komponenten, siehe Komponenten zum Erstellen von Unterabschnitten verwenden.

  • Anzahl der Unterabschnitte – Bei der Paligo-Validierung wird eine Höchstmenge von10 Abschnitten pro Topic (ein Hauptabschnitt mit 9 Unterabschnitten) empfohlen. Diese Vorgabe wird über die „Empfohlenen Regeln in Paligo“ im Editor-Einstellungen beim Validieren/Speichern eines Topics durchgesetzt. Beachten Sie, dass für Unterabschnitte, die als Komponenten eingefügt werden, keinerlei Beschränkungen bestehen. Wenn Sie jedoch bereits wissen, dass ein Unterabschnitt nur in einem Topic benötigt wird, können Sie diesen als Abschnitt (section) innerhalb eines Abschnitts erstellen. Weitere Informationen zu möglichen Einstellungen finden Sie in Editor-Einstellungen.

  • Durchsuchbarkeit – Unterabschnitte, die nicht als Komponenten eingefügt werden, werden möglicherweise mit der Websuche schwieriger gefunden als Topics. Auch über den Content Manager kann es für den Ersteller schwieriger sein.

So fügen Sie ein zweites section-Element als Unterabschnitt hinzu:

  1. Positionieren Sie den Cursor an einer gültigen Position für einen Unterabschnitt.

    Ein Abschnitt kann als Unterabschnitt nur an Positionen eingefügt werden, die beide folgenden Bedingungen erfüllen:

    • Ein direkter Abkömmling eines section-Elements (entweder der Abschnitt für das Haupt-Topic oder ein Abschnitt zu einem Unterabschnitt). Er darf sich nicht innerhalb eines anderen Elements befinden.

    • Unmittelbar nach ihm folgt ein anderes section-Element oder ein abschließendes section-Element (</section>).

      Ihre Inhalte dürfen nicht zwischen Unterabschnitten „schwimmen“ oder sich zwischen einem Unterabschnitt und dem Ende des Haupt-Topics befinden. Inhalte müssen innerhalb des Haupt-Topics und vor den Unterabschnitten oder innerhalb eines der Unterabschnitte stehen.

    RICHTIG: Der Cursor steht außerhalb der anderen Elemente und ist ein direkter Abkömmling des section-Elements des Haupt-Topics. Das Element hinter der Position ist – genau wie </section> – das Abschlusselement des Haupt-Topics. Auf einen Unterabschnitt darf nur ein section- oder abschließendes section-Element folgen.

    FALSCH: Der Cursor befindet sich innerhalb eines Elements. Die ausgewählte Position ist kein direkter Abkömmling des section-Elements im Haupt-Topic.

    Anmerkung

    In einem Topic müssen alle Inhalte einschließlich der Unterabschnitte innerhalb der Haupt-<section>- und </section>-Tags des Topics liegen.

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

  3. Geben Sie section ein und wählen Sie es im Menü aus.

    Ein neues section-Element wird dem Topic hinzugefügt. Da es sich innerhalb des Haupt-section-Elements befindet, erscheint das neue section-Element als Unterabschnitt.

  4. Geben Sie dem neuen Unterabschnitt einen Titel. Anschließend können Sie dem Unterabschnitt Inhalte hinzufügen, wie bei jedem anderen Topic.

Anmerkung

Zwischen Unterabschnitten dürfen sich weder para-Elemente noch sonstige Blockelemente befinden. Der einzige zulässige Inhalt nach dem Ende eines Unterabschnitts ist ein weiterer Unterabschnitt.