Skip to main content

Topics

Ein Topic ist ein Container für Ihre Inhalte und Bausteine für Ihre Ausgaben. Sie erstellen Inhalte innerhalb eines Topics, indem Sie Elemente für Absätze, Bilder, Verfahren, Aufzählungen, Tabellen usw. hinzufügen. Sie können beliebig viele Blockbausteine und Inline-Elemente hinzufügen, wobei die Größe eines Topics maximal 1 MB betragen darf.

Statt alle Abschnitte in eine große Datei zu schreiben, erstellen Sie jeden Abschnitt in einem separaten Topic. Es ist bewährte Praxis, dass ein bestimmtes Thema oder eine Aufgabe in einem eigenen Topic behandelt wird.

Zur Erstellung der Ausgabe stellen Sie

in Publikationen eine Sammlung von Topic-Verweisen zusammen. Die Topics sind Ihre Bausteine, die Sie in beliebig viele verschiedene Publikationen aufnehmen oder aus diesen ausschließen können. Deshalb sind Topics so wichtig für Über die Wiederverwendung von Inhalten. Sie ermöglichen es Ihnen, dieselbe Information in unterschiedlichen Publikationen zu verwenden, ohne dass Sie extra Kopien erstellen müssen. Es gibt eine „einzige Quelle der Wahrheit“.

mission-control-center-topic.jpg
mission-control-center-pub.jpg

Links ein Topic namens „Das Kontrollzentrum der Mission“. Rechts das gleiche Topic in einer Publikation.

[en] We recommend that you read Bearbeiten von Topics – Die Grundlagen as a starting point. Then, you can Topics erstellen.

Tipp

Wie Sie Quizze erstellen, erfahren Sie unter Das Topic „Quiz“.

Der Editor in Paligo ist so einfach wie möglich zu bedienen, quasi wie ein Textverarbeitungsprogramm, dennoch ist er ein XML-Editor. Auch wenn auf der Oberfläche nur wenige XML-Tags zu sehen sind, herrscht unter der Oberfläche nach wie vor eine fest geregelte Struktur. Falls Sie bisher noch nicht mit strukturierten Umgebungen gearbeitet haben, sollten Sie sich zumindest mit den Grundbegriffen des Hinzufügens und Verwendens von Elemente und Attribute vertraut machen, siehe Kurzanleitung.

Fügen Sie häufig verwendete Elemente über die Registerkarten Bearbeiten und Einfügen im hinzu Symbolleiste oder fügen Sie Elemente mithilfe von Kontextmenü „Elemente“ hinzu.

paligo-editor.jpg

Weitere Informationen zu den verschiedenen Teilen des Editors finden Sie unter Editor.

Bearbeitung im Kontext

Manchmal erweist es sich während der Arbeit an den verschiedenen Topics als hilfreich, Topics in einer bestimmten Publikation (z. B. für ein bestimmtes Produkt) im Kontext durchsuchbar zu machen.

Dies ist möglich, und Sie können einfache Bearbeitungen im Beitragseditor vornehmen. Zwar ist dieser hauptsächlich für Revisoren und Verfasser gedacht, doch natürlich haben auch Autoren Zugriff darauf. Zudem bietet er eine sehr bequeme Möglichkeit, Inhalte im Kontext zu durchsuchen und zu bearbeiten.

Im Folgenden sehen Sie das Grundkonzept:

  1. Öffnen Sie im Content Manager ein Topic auf eine der nachfolgend aufgeführten Arten:

    • Klicken Sie auf den Topic-Namen, um ihn im Editor anzuzeigen.

    • Wählen Sie In Editor öffnen aus dem Drei-Punkte-Menü (...) des Topics.

    paligo-editor.jpg
  2. Standardmäßig wird zunächst ein title (der gleiche wie der Topic-Name) und ein leerer Absatz (para-Element) generiert.

    In den meisten Fällen sollte Ihr Topic nur einen Titel bzw. eine Überschrift besitzen, siehe Überschriften und Untertitel . Wenn Sie Ihre Publikation im Strukturansicht erstellen, werden Unterüberschriften automatisch erstellt.

  3. Platzieren Sie im Editor den Cursor dort, wo Sie ein Element einfügen möchten, und führen Sie eineder folgenden Aktionen aus:

    • Verwenden Sie Symbolleiste, um den gewünschten Inhaltstyp (Element) einzufügen.

      Toolbar_Insert_small.png
    • Es zeigt die an der aktuellen Position verfügbaren Elemente an. Beginnen Sie mit der Eingabe, um die Liste einzugrenzen. Wenn Sie beispielsweise „par“ eingeben, sehen Sie das Element para.

      The Element Context Menu. At the top, there is a search field for searching for specific elements. Below that, there is a list of elements that are valid for the current cursor position.
  4. Um ein neues Element gleichen Typs hinzuzufügen, das Sie gerade eingefügt haben (z. B. para, listitem oder step in einer procedure) drücken Sie einfach die Eingabetaste.

    Tipp

    Weitere Tipps zur Beschleunigung Ihrer Dokumenterstellung im Editor finden Sie unter Tastenkombinationen.

  5. So entfernen Sie ein Element:

    1. Setzen Sie den Cursor auf das Element, das Sie entfernen möchten.

    2. Das Menü „Elementstruktur“ (auch „Breadcrumbs“ genannt) unter der Symbolleiste zeigt hierarchisch an, in welchem Element Sie sich befinden. Bewegen Sie den Cursor über den Elementnamen, den Sie entfernen möchten, und klicken Sie darauf, um ein Pop-up-Menü zu öffnen.

      breadcrumbsrow.png
    3. Fahren Sie mit dem Mauszeiger (ohne zu klicken) über den Menüpunkt Löschen, um das zu entfernende Element mit gelbem Hintergrund und rot durchgestrichenem Text hervorzuheben.

    4. Klicken Sie auf Löschen, um das ausgewählte Element zu entfernen.

  6. Verwenden Sie dasMenü „Elementstruktur“ in ähnlicher Weise, um volle Kontrolle auf die Bearbeitung der Inhalte zu haben, zum Beispiel:

    • Elemente hervorheben im Editor.

    • Elemente ausschneiden, kopieren und einfügen.

    • Elemente nach oben und unten verschieben (Elemente müssen sich auf derselben Ebene in der Struktur befinden).

    Topic editing

    Tipp

    Um ein Element (z. B. para oder step) in zwei separate Elemente aufzuteilen, positionieren Sie den Cursor innerhalb des Elements und drücken Sie die Eingabetaste, siehe Eine Liste aufteilen.

    Wenn Sie die Elemente bold oder italic zum Formatieren von Text verwendet haben und dies ändern möchten, siehe Hervorhebung entfernen.

Jedes Mal, wenn Sie in Paligo ein Topic zur Bearbeitung öffnen, wird das Topic automatisch ausgecheckt. Das bedeutet, dass Sie gerade Besitzer des Topics sind und andere Benutzer es nicht bearbeiten können. Auf diese Weise lassen sich Konflikte vermeiden, bei denen zwei Benutzer gleichzeitig versuchen, die Arbeit des anderen zu ändern.

Ein ausgechecktes Topic erkennen Sie in Content Manager, Ressourcenübersicht und Panel Ausgecheckte Dokumente. Paligo zeigt den ausgecheckten Status mit einem Häkchen an.

Paligo editor toolbar. There is a series of icons. A callout is under a cog icon and the callout text says Editor settings.

Um herauszufinden, wer ein Topic ausgecheckt hat, gibt es zwei Möglichkeiten:

Wir empfehlen Ihnen, für jeden Inhaltsabschnitt, der eine Überschrift benötigt (entweder eine Überschrift auf oberster Ebene oder eine Unterüberschrift), ein neues Topic anzulegen. Wenn Sie Ihre Inhalte in separate Topics unterteilen, werden sie wandelbarer. Beispielsweise könnte ein Topic in einer Publikation als Unterabschnitt fungieren, in einer anderen Publikation aber als Topic der obersten Ebene.

Wenn Sie ein Topic erstellen, können Sie Folgendes festlegen:

Anmerkung

Eine Einführung in Topics und Publikationen finden Sie unter Authoring auf der Grundlage von Topics.

Es gibt zwei Möglichkeiten, ein Topic aus dem Content Manager zu erstellen:

  1. zwei Möglichkeiten angezeigt werden:

    • wählen Sie das Menü oben im Content Manager aus, danach Topic, oder

      Create menu is selected, near the Paligo logo in the top left of the user interface. This reveals a menu containing various options, including Topic.
    • wählen Sie das Drei-Punkte-Menü (...) für einen Ordner und wählen Sie dann Inhalt erstellen.

      dotted-menu-create-content.png
  2. Im Dialog Inhalt erstellen legen Sie die Eigenschaften für die neue Komponente fest:

    Create content dialog. It has a field for entering a title, various options for selecting the type of content, a language selector, and options for selecting all languages, opening in the editor, and creating another component.
    • Stellen Sie sicher, dass der Dokumenttyp auf Topic eingestellt ist.

    • Geben Sie im Feld Dokumenttitel einen Namen für das neue Topic ein.

      Anmerkung

      Sie können folgende Zeichen für Titel verwenden: Zahlen, Buchstaben, Satzzeichen und Leerzeichen. Die Satzzeichen sind:

      ! " # $ % / & ' ( ) * + , - . : ; < = > ? @ [ \ ] ^ _ ` { | } ~

    • Wählen Sie im Abschnitt Sprache aus, welche Sprachen Paligo in das Topic aufnehmen soll. Sie können einzelne Sprachen auswählen oder das Kontrollkästchen Alle Sprachen auswählen aktivieren, um sämtliche Sprachen zu berücksichtigen.

      Anmerkung

      Sie können nur aus den Sprachen wählen, die auf Ihrer Paligo-Instanz aktiviert sind. Informationen zum Hinzufügen von Sprachen finden Sie unter Sprachmanagement.

    • Mit In Editor öffnen legen Sie fest, ob Paligo das neue Topic im Editor anzeigt.

      • Aktivieren Sie das Kontrollkästchen, wenn Paligo das Topic im Editor anzeigen soll

      • Deaktivieren Sie das Kästchen, wenn Paligo das Topic nicht im Editor anzeigen soll

    • Mit Weiteres hinzufügen entscheiden Sie, wie Paligo mit dem Dialogfeld „Inhalt erstellen“ verfährt, damit Sie ein weiteres Topic hinzufügen können.

      • Aktivieren Sie das Kontrollkästchen, wenn Sie möchten, dass Paligo das Dialogfeld „Inhalt erstellen“ geöffnet lässt

      • Deaktivieren Sie das Kästchen, wenn Paligo das Dialogfeld „Inhalt erstellen“ schließen soll

  3. Klicken Sie auf OK.

    Das neue Topic wird in Paligo erstellt.

Je nach Ihrer Auswahl öffnet Paligo das neue Topic im Editor automatisch. Alternativ können Sie das Topic im Content Manager auswählen, um es im Editor anzuzeigen.

Informationen zur Struktur, die standardmäßig in einem neuen Topic enthalten ist, finden Sie unter Strukturierung eines neuen Topics.

Tipp

Bitte beachten Sie, dass Ihr neues Topic (noch) in keiner Publikation enthalten ist. Informationen zum Hinzufügen des Topics zu einer Publikation finden Sie unter Inhalte zu einer Publikation hinzufügen.

Aus der Publikationsstruktur können neue Topics erstellt werden. Die beiden Vorteile dieser Methode sind folgende:

  • Das Topic wird automatisch in die Publikation aufgenommen.

  • Das Topic kann sofort an die gewünschte Stelle in der Publikationsstruktur verschoben werden.

Tipp

Oben im Content Manager haben Sie außerdem die Möglichkeit, Inhalte zu erstellen. Diese werden allerdings nicht automatisch in die Publikation aufgenommen.

Create_Content_Content_Manager.png
  1. Wählen Sie im Content Manager die Publikation aus. Publication.png

    Open_Structure_View.jpg

    Paligo zeigt die Strukturansicht an, die drei Abschnitte umfasst: Struktur, Metadaten und Vorschau.

  2. Klicken Sie auf den Pfeil neben der Schaltfläche Neues Topic, um auszuwählen, wo das neue Topic gespeichert werden soll.

    NewTopic_PublicationStructure.jpg

    Anmerkung

    Andernfalls wird das Topic standardmäßig im selben Ordner wie die oberste Publikation oder das oberste Topic gespeichert.

  3. Wählen Sie Neues Topic aus. Add_languages_button_small.png

  4. Benennen Sie das neue Topic.

  5. Verschieben Sie das Topic an seine vorgesehene Position in der Publikationsstruktur.

  6. Wählen Sie Speichern aus, um die Änderungen an der Publikation zu bestätigen. Save_Publication.jpg

Anmerkung

Das neue Topic wird an der gewählten Stelle angelegt und kann nun bearbeitet werden.

Wenn Sie ein neues Topic erstellen, fügt Paligo automatisch einige Strukturelemente hinzu. Standardmäßig besteht ein neues Topic aus einem section-Element, einem Titelelement und einem para-Element:

A new topic shown in the full editor. There are numbered callouts next to the section element (1), topic title (2), and the first paragraph (3).
  1. section dient als Container für die weiteren Elemente des Topics.

  2. title ist die Überschrift des Topics.

  3. para ist der erste Absatz des Topics.

Um einem Topic Inhalte hinzuzufügen, müssen Sie geeignete Elemente hinzufügen, um die Struktur zu bilden. Danach können Sie Ihre Inhalte in die Elemente einfügen. Wenn Sie beispielsweise zwei Absätze und ein Bild verwenden möchten, müssen Sie zwei para-Elemente sowie die Elemente mediaobject, imageobject und imagedata hinzufügen, welche für ein Bild benötigt werden. Paligo hält Symbolleistenoptionen bereit, mit denen sich häufig verwendete Strukturen mit nur wenigen Klicks hinzufügen lassen. Daneben besitzen die Elemente ein Kontextmenü „Elemente“, über das die einzelnen Strukturelemente nacheinander erstellen werden können.

Informationen zum Hinzufügen von Inhalten zu einem Topic finden Sie unter Über das Authoring.

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.

Image of Topic Templates page from the Paligo help. It has a main heading "Topic Templates" followed by some text and then a subheading "Create a Topic Template", which is followed by text and an image.

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

In Paligo hat jedes Topic einen:

heading-section-title.png
  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.

Image of Topic Templates page from the Paligo help. It has a main heading "Topic Templates" followed by some text and then a subheading "Create a Topic Template", which is followed by text and an image.

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

[en] To learn how to set up and manage the different types of subsection, see:

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:

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.

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    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.

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.
  4. Wählen Sie Zu Element wechseln aus.

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

    element-attributes-xinfo-outname.jpg
  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.

    element-attributes-xinfo-outname-2.jpg
  8. Drücken Sie Speichern. Save icon.

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 1. 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


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 editor. The Layout option in the header menu is highlighted.

    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.

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

    use-resource-name.jpg
    • 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.

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 editor. The Layout option in the header menu is highlighted.

    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.

    section-numbering-pdf.png

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

    section-numbering-html.png
  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.

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.

Published HTML5 page showing the table of contents has "WiFi" as the title. But in the main topic, the title is the longer title of "Configure the WiFi Connections for your ACME 100".

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.

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

  2. Positionieren Sie den Cursor zwischen dem Element title und dem ersten Element para.

    Topic showing "Configure the WiFi Connections for your ACME 100" as a title. The cursor is positioned below the title, but above the first paragraph in the topic.
  3. Drücken Sie Alt + Enter ⏎ (Windows) oder Command ⌘ + Enter ⏎ (Mac), um den Kontextmenü „Elemente“ anzuzeigen.

    Element context menu shows a search field and a list of elements that are valid at the current position.
  4. Geben Sie titleabbrev ein und wählen Sie es im Menü aus.

  5. Positionieren Sie den Cursor innerhalb des Elements titleabbrev.

    Topic showing "Configure the WiFi Connections for your ACME 100" as a title. A titleabbrev element has been added after the main title and before the first paragraph.
  6. Geben Sie den Text für den alternativen Titel ein.

    Topic showing a title with a titleabbrev element below it. The title is "Configure the WiFi Connections for your ACME 100". The titleabbrev is "WiFi".
  7. Drücken Sie Speichern. Save icon.

  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.

So öffnen Sie ein Topic:

  • Klicken Sie im Content Manager oder in der Ressourcenansicht auf den Namen des Topics.

    Close up of Documents section in the Content Manager. The cursor is on the name of a topic.

    Beispiel für die Auswahl eines Topics im Content Manager.

  • Klicken Sie auf dem Dashboard auf den Link zum Topic. Dies ist nur bei Topics und Publikationen möglich, die erst kürzlich bearbeitet wurden.

    Dashboard activity feed. It shows a topic that has recently been opened and there is a link button.

    Beispiel für einen Link zum Öffnen des Topics über das Dashboard

  • Wählen Sie das Drei-Punkte-Menü des Topics (...) und wählen Sie hier Bearbeiten und dann Im Editor öffnen aus. Weitere Optionen zum Öffnen des Topics gibt es in der Revisions-Ansicht, Verfasser-Ansicht und Übersetzungs-Ansicht.

    Das Drei-Punkte-Menü (...) des Topics ist im Content Manager , in der Ressourcenansicht sowie in der Publikationsstruktur verfügbar.

    Publication structure showing a topic's dotted menu options. The Edit option is selected, revealing further options, including Open in editor.

    Beispiel für das Öffnen des Topics aus der Publikationsstruktur

  • Wählen Sie den Link zu einem Ihrer Aufträge (entweder in der E-Mail, die Sie von Paligo erhalten haben, oder von Ihrem Dashboard aus). Paligo öffnet die Topics in diesem Auftrag in der Ansicht, die Ihrem Benutzerkonto entspricht. Beispielsweise öffnen sich für Verfasser die Topics in der Verfasser-Ansicht.

Zwischen dem Kopieren und dem Duplizieren von Topics besteht ein Unterschied:

  • Kopieren dient zum Hinzufügen von Gabelungen aus Topics zu einer Publikation, siehe Inhalte zu einer Publikation hinzufügen.

  • Mit Duplizieren erstellen Sie ein neues Topic mit dem gleichen Inhalt und Namen wie das Original; wobei dem Namen am Ende „Kopie“ und eine Nummer angefügt wird. Das duplizierte Topic hat eine eigene eindeutige ID und ist vom ursprünglichen Topic vollständig getrennt.

    In einem Duplikat gibt es keine Wiederverwendung von Inhalten, sondern derselbe Inhalt wird neu erstellt. Sie können die Kopie und deren Inhalt ohne Auswirkungen auf das ursprüngliche Topic bearbeiten.

Tipp

Wenn Sie verschiedene Versionen eines Topics erstellen möchten, ist der Verzweigungen möglicherweise eine bessere Option. Mithilfe einer Verzweigung können Sie eine Kopie erstellen, die bei Bedarf später wieder in das Original eingefügt werden kann.

So duplizieren Sie ein Topic:

  1. Wählen Sie das Drei-Punkte-Menü (...) im Content Manager für das Topic, das Sie duplizieren möchten.

  2. Wählen Sie Duplizieren. Copy_symbol.jpg

    Duplicate

    Paligo erstellt ein Duplikat des Topics.

  3. Wählen Sie das Drei-Punkte-Menü (...) und hier Umbenennen. Comment_small.png

  4. Geben Sie einen neuen Namen ein.

  5. Bestätigen Sie die Namensänderung mit dem Häkchen. Checkmark_small.png

In einer Vorschau können Sie sich ansehen, wie Ihr Topic in verschiedenen Ausgaben dargestellt wird. Dies verschafft Ihnen die Möglichkeit, die Größe von Bildern anzupassen, die Textmenge besser an Ihr Ausgabeformat abzustimmen, Akkordeons zu verwenden, um eine Seite übersichtlicher zu gestalten, beschädigte Links zu erkennen oder notwendige Aktualisierungen Ihrer Layouteinstellungen aufzuspüren. Paligo empfiehlt dringend, bei jeder Erstellung oder Aktualisierung von Inhalten eine Vorschau anzuzeigen.

Verwenden Sie für die Vorschau Ihre benutzerdefinierte Ausgabe, siehe Vorschau-Layouts einstellen. Weitere Informationen zum Filtern/Profiling finden Sie unter Filterung/Profiling.

Anmerkung

Für bestimmte Komponenten, wie z. B. informelle Topics, ist keine Vorschau verfügbar. Wenn Sie sie jedoch als Komponente zu einem regulären Topic hinzufügen, können Sie eine Vorschau des regulären Topics anzeigen, siehe Komponente einfügen.

Zur Vorschau eines Topics:

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

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

  2. Wählen Sie im Symbolleiste die Registerkarte Vorschau.

    Preview_menu_small.png
  3. Gehen Sie zu Profileinstellungen. Profile_settings_button_small.png

  4. Wählen Sie Variablen und Filterung/Profiling, die Sie für die Vorschau verwenden möchten.

    variables-preview.png

    Tipp

    Sie können die Variablen- und Profiling-Einstellungen als Standardeinstellungen für die Vorschau speichern, siehe auch Favoritenprofil erstellen (Registerkarte Vorschau) und Favoritenprofil als Standard festlegen.

  5. Wählen Sie Übernehmen und schließen Sie das Dialogfeld Profileinstellungen.

  6. Wählen Sie den Ausgabetyp (PDF, HTML oder HTML5).

    Preview HTML5 output

    Paligo zeigt die Vorschau in einem neuen Tap-Topic. Es verwendet das Standardlayout für jeden Ausgabetyp. So erhalten Sie eine gute Vorstellung davon, wie Ihr Topic bei Veröffentlichung aussehen wird.

    Wichtig

    Wenn Sie Änderungen an Ihrem Topic vornehmen, müssen Sie eine neue Vorschau generieren, da beim Aktualisieren der vorhandenen Vorschau im Browser lediglich die zuvor generierte Vorschau neu geladen wird.

Bei HTML5-Ausgaben werden die Dateinamen in der Regel automatisch generiert, sie lassen sich aber auch individuell festlegen.

Paligo hält eine Reihe von Optionen für die automatische Generierung der Dateinamen von HTML5-Ausgaben bereit: Entweder wird dafür die UUID (Universally Unique Identifier), der Titel eines Topics oder der Name der Ressource verwendet – je nach Ihren Einstellungen im Layout-Editor.

Bei Bedarf können Sie aber auch den Namen der Ausgabedatei individuell für bestimmte Topics festlegen. Dies kann nützlich sein, wenn Sie z. B. die Option nutzen, das Dateinamen aus dem Topic-Titel übernommen werden, danach aber den Titel ändern möchten. Wenn Sie die Ausgabedatei wie nachfolgend beschrieben einrichten, stellen Sie sicher, dass der Name sich nicht ändert, auch wenn Sie den Titel ändern.

So legen Sie den Dateinamen für ein Topic manuell fest:

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

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

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

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.
  3. Wählen Sie Zu Element wechseln aus.

  4. Fügen Sie xinfo:outname im Panel „Elementattribute“ hinzu.

    xinfo_outname.jpg
  5. Geben Sie als Wert den gewünschten Namen für die veröffentlichte Datei ein.

    Anmerkung

    Sie brauchen nur den Dateinamen einzugeben, ohne Dateierweiterung am Ende.

  6. Drücken Sie Speichern. Save icon.

Wenn Sie in HTML5 veröffentlichen, wird der Dateiname für das Topic auf den Wert gesetzt, den Sie für das Attribut xinfo:outname definiert haben.

Sie können Topics so einrichten, dass sie in Ihre HTML5-Ausgabe aufgenommen werden, jedoch nicht als Ergebnisse in der Suche erscheinen. Auf diese Weise gestalten Sie Ihre Suche nützlicher, indem Sie nur vertiefende Topics einbeziehen, die Ihre Benutzern mit den benötigten Informationen versorgen.

Beispiel 2. Häufig ausgeschlossene Inhalte

Freigabehinweise werden häufig aus den Suchergebnissen ausgeschlossen, da sie zwar nützlich für Ihre Dokumentation sind, aber selten konkrete Infos bereithalten.


Tipp

Sie können auch Topics aus der Navigations-Seitenleiste (auch Inhaltsverzeichnis genannt) ausschließen, siehe Inhalte vom Inhaltsverzeichnis einer Publikation ausschließen.

So schließen Sie ein Topic aus den Suchergebnissen aus:

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

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

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

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.
  3. Wählen Sie Zu Element wechseln aus.

  4. Fügen Sie das role-Attribut im Panel „Elementattribute“ hinzu und setzen Sie den Wert auf notinsearch.

    role-not-in-search.jpg

    Anmerkung

    Das role-Attribut wird nicht vererbt. Wenn Sie mit mehreren Topic-Ebenen arbeiten, müssen Sie die role nicht nur zum section-Element des Topics der obersten Ebene, sondern zu allen Abschnitten hinzufügen, die Sie von der Suche ausschließen möchten.

  5. Drücken Sie Speichern. Save icon.

Wenn Sie das Topic in Ihrem HTML5-Helpcenter veröffentlichen, wird das Topic nicht in die Suchergebnisse aufgenommen.

Wenn Sie ein leeres Topic als nicht anklickbare Beschriftung verwenden möchten, um Unter-Topics im Inhaltsverzeichnis (HTML5) zu kategorisieren, können Sie es in ein topichead umwandeln. Das bedeutet, dass sein Titel in der TOC-Seitenleiste angezeigt wird, jedoch nur als Beschriftung für seine untergeordneten Topics dient.

Wenn Sie das role-Attribut mit seinem auf topichead eingestellten Wert zum section-Hauptelement hinzufügen, wird das Topic:

Non-clickable_Topics_small.jpg

Die Haupt-Topics (Batterien, Ventilatoren, Motoren und Solarmodule) in diesem Bild sind „topicheads“ (Topic-Überschriften). Anders gesagt, leere Topics, die lediglich als nicht klickbare Etiketten in der Seitenleiste des Inhaltsverzeichnisses dienen.

Wichtig

Wenn Sie veröffentlichen und die untergeordneten Topics nicht für eine nicht anklickbare Beschriftung angezeigt werden, versuchen Sie, die Abschnittstiefe zu erhöhen. Diese Einstellung finden Sie in der Kategorie „TOC und Chunking“ in Ihrem HTML5-Layout.

Anmerkung

Dieser Beschriftungstyp dient nur zur Navigation in der TOC-Seitenleiste und ist nicht dasselbe wie Verzweigungsbeschriftungen oder Beschriftungen, die mit dem Element phrase hinzugefügt wurden.

So wandeln Sie ein Topic in eine nicht anklickbare Bezeichnung für HTML5-Ausgaben um:

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

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternativ können Sie Topics erstellen und dieses bearbeiten.

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

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.
  3. Wählen Sie Zu Element wechseln aus.

  4. Fügen Sie im Panel „Elementattribute“ das role-Attribut hinzu und setzen Sie den Wert auf topichead.

    Role_Topichead.png
  5. Drücken Sie Speichern. Save icon.

  6. Wiederholen Sie diesen Vorgang für alle Topics, die nicht anklickbar sein sollen.