Skip to main content
  • Paligo-Dokumentation
  • Kurzanleitung
  • Topics als strukturierte Inhalte

Topics als strukturierte Inhalte

Topics sind die Hauptbausteine Ihres strukturierten Inhalts. Sie verwenden sie als „Container“ für jeden Abschnitt Ihres Inhalts, was als „themenbasiertes Authoring“ bezeichnet wird.

Themenbasiertes Authoring unterscheidet sich von herkömmlicher Dokumentation, bei der Sie alle Inhalte in einem langen Dokument schreiben würden. Bei Topics befindet sich jeder Abschnitt in einem separaten Topic. Um Unterabschnitte zu erstellen, können Sie ein Topic in ein anderes Topic einfügen. Die Idee ist, dass Sie Ihre Abschnitte als eigenständige Topics schreiben, damit sie in vielen Publikationen wiederverwendet werden können.

Um eine fertige Ausgabe zu erstellen, z. B. ein Benutzerhandbuch, erstellen Sie eine Publikation und fügen eine Sammlung von Topics hinzu.

Das folgende Bild zeigt eine Publikation. Seine Struktur besteht aus Verweisen auf einzelne Topics.

Publication structure. It is made up of a series of topics, which are arranged in a hierarchy, similar to a table of contents in a book.

Eine Publikation „Cybersicherheit“. Jedes seiner „Kapitel“ und Unterkapitel ist ein eigenes Topic. Die Topics werden der Publikationsstruktur hinzugefügt und in der entsprechenden Reihenfolge organisiert.

Vorteile von Topic-basiertem Authoring

Warum verwenden wir Topics? Weil sie Ihre Inhalte vielseitiger machen. Sie können ein Topic in vielen verschiedenen Publikationen gleichzeitig wiederverwenden, anstatt die Informationen zu duplizieren. Das bedeutet konkret:

  • Sie können Informationen einmal an einem Ort schreiben und überall dort wiederverwenden, wo sie benötigt werden.

  • Wenn Sie ein Topic aktualisieren, gelten die von Ihnen vorgenommenen Änderungen überall dort, wo dieser Inhalt wiederverwendet wird.

  • Übersetzungen sind schneller und kostengünstiger. Übersetzungsmanagementsysteme (TMS) können erkennen, ob ein Topic Änderungen aufweist, die übersetzt werden müssen.

Wenn Sie Best Practices befolgen und jedes Thema zu einer Sache machen, z. B. zu einer Aufgabe oder einem Thema, kann das Topic-basierte Authoring auch die Qualität Ihrer Dokumentation verbessern. Indem Sie sich auf eine Sache konzentrieren, schränken Sie den Umfang der Informationen ein, sodass das Topic spezifischer auf die Bedürfnisse des Benutzers zugeschnitten ist.

Topic und seine Struktur erstellen

Sie können ein Topic in Paligo erstellen, indem Sie die Option Inhalt erstellen verwenden und dann Topic auswählen. Die Option Inhalt erstellen ist im Punktemenü ( ... ) für Ordner verfügbar. Alternativ können Sie die Schaltfläche Inhalt erstellen oben im Content Manager verwenden.

Wenn Sie ein neues Topic in Paligo erstellen, hat es standardmäßig ein Element section, ein Element title und ein Element para. In der XML-Baum-Leiste im Seitenbereich sehen Sie diese Struktur. Wenn Sie ein Element im Editor auswählen, zeigt das Menü Elementstruktur oben den Pfad zu diesem Element an.

A close-up view of the top of a topic. Label 1 highlights the element structure menu, which shows the path from the section element to the currently selected element. Label 2 highlights the title of the topic. Label 3 highlights a paragraph.
XML tree view of a new topic. The section element is at the top. Inside that there is a title element that has the title text and an empty para element.

Bild links: Neues Topic im Editor. (1) ist das Menü Elementstruktur, (2) ist ein title-Element und (3) ist ein para-Element. Bild rechts: XML-Baumansicht des Topics. Es zeigt an, dass das Abschnittselement das übergeordnete Element ist und untergeordnete title- und para-Elemente enthält.

Das Element section repräsentiert das gesamte Topic. Innerhalb des Element section benötigen Sie mindestens einen title gemäß den Docbook-Regeln. Paligo enthält auch ein Element para, um Ihnen den Einstieg zu erleichtern.

Für zusätzliche Inhalte müssen Sie zuerst die Struktur hinzufügen und dann den Inhalt eingeben. Nähere Informationen finden Sie unter Elemente als strukturierter Inhalt.

Beispiel eines Topics

Schauen wir uns nun ein Beispiel für ein einfaches Topic an, das Sie in einem Helpcenter finden könnten. Schauen wir uns zunächst an, wie es im Haupteditor aussieht.

Example of a topic. It has a title, a paragraph, a procedure with 4 steps. The third step has text and an image.

Beachten Sie, dass es wie ein regulärer Inhalt aussieht, mit einem Titel, einem einleitenden Absatz und Schritt-für-Schritt-Anleitungen. Aber jeder Teil des Inhalts hat ein oder mehrere Strukturelemente, um die Informationen aufzunehmen. Sie können sie in der XML-Baumansicht sehen:

XML tree view of the topic. It has a section element at the top. Inside that it has a title, a para, and a procedure element. Inside the procedure element there is a step element for each step. Inside the steps, there are para elements for the text. The third step also has a mediaobject element for the image.

Die Struktur besteht aus einer Hierarchie von Elementen:

  • section repräsentiert das gesamte Topic.

  • title ist die Überschrift für das Topic

  • para ist der einleitende Absatz und es gibt auch para-Elemente in jedem Schritt. Das para-Element ist ein Container für einen Absatz oder Satz.

  • procedure ist die Struktur für eine schrittweise Verfahrensliste.

  • step ist die Struktur für jeden Schritt im Verfahren. Beachten Sie, dass es sich bei den step-Elementen um untergeordnete Elemente des übergeordneten procedure-Elements handelt.

    Jeder step hat einen para, der den Text für den step enthält.

  • mediaobject ist eine Struktur zur Aufnahme eines Bildes. Hier handelt es sich um ein untergeordnetes Element des dritten Schritts, da das Bild Teil von Schritt 3 ist.

Diese Idee, dass Inhalte innerhalb struktureller Elemente liegen, ist ein konsistentes Thema in Paligo. Sie erstellen eine Komponente, z. B. ein Topic, um die Informationen aufzunehmen. Anschließend bauen Sie die Informationen auf, indem Sie eine Struktur aus Elementen erstellen und den Inhalt innerhalb der Elemente hinzufügen.

Anmerkung

Informationen zum Erstellen eines eigenen Topics finden Sie unter Topics erstellen.