Skip to main content
  • Paligo-Dokumentation
  • Kurzanleitung
  • Elemente als strukturierter Inhalt

Elemente als strukturierter Inhalt

Um Inhalte in einem Topic oder einer anderen Komponente zu erstellen, müssen Sie Strukturelemente hinzufügen und dann Ihren Inhalt in diese Elemente einfügen. Die zur Verwendung verfügbaren Elemente werden durch das DocBook-Inhaltsmodell definiert und beim Hinzufügen müssen Sie die DocBook-Regeln befolgen.

DocBook hat viele verschiedene Elemente in seinem Inhaltsmodell und die meisten sind benannt, um einen Inhaltstyp zu beschreiben. Beispielsweise para für Absatz, procedure für eine Liste von Anweisungen und step für jeden Schritt in der Liste. Einige Elemente sind selbsterklärend, andere etwas unklarer. Wenn Sie Inhalte in Paligo erstellen, müssen Sie das Inhaltsmodell nicht im Detail kennen, aber es hilft Ihnen, sich dessen bewusst zu sein, was verfügbar ist. Informationen zu DocBook-Elementen finden Sie auf der offiziellen DocBook-Website.

Blockelemente und Inline-Elemente

Es gibt viele verschiedene Elemente, die Sie verwenden können, aber alle können entweder als Blockelement oder als Inline-Element kategorisiert werden.

  • Blockelemente

    Blockelemente erzeugen Strukturen, die sich auf einer neuen Zeile befinden und sie sind die wichtigsten „Bausteine“ für den Inhalt innerhalb eines Topics oder einer Komponente. Häufige Beispiele für Blockelemente sind para und procedure. Der Editor von Paligo ist so konzipiert, dass die Blockelemente aus der Ansicht ausgeblendet werden, damit Sie sich auf den eigentlichen Inhalt konzentrieren können. Aber Sie können die Blockelemente sehen, indem Sie sich die XML-Baumansicht ansehen.

    A topic's structure as shown in the XML tree view. There is a section element at the top. Inside that there is a title element, a para element, and a procedure element. Inside the procedure element there are a series of step elements.

    Für Blockelemente positionieren Sie den Cursor im Editor und fügen dann über die Symbolleiste oder das Element „Kontextmenü“ das gewünschte Element hinzu. Achten Sie auf die Position des Cursors und stellen Sie sicher, dass er sich innerhalb oder außerhalb des vorherigen Blockelements befindet, je nachdem, wohin Sie das neue Element verschieben möchten.

  • Inline-Elemente

    Inline-Elemente sind für den Einsatz innerhalb eines Blockelements ausgelegt. Sie dienen dazu, einem bestimmten Wort oder einer Wortfolge Struktur zu verleihen. Häufige Beispiele für Inline-Elemente sind emphasis und guilabel.

    A line of text. The word "edit" is in bold black letters. A callout arrow points to it.

    Markieren Sie für Inline-Elemente den Text und verwenden Sie dann das Element Kontextmenü, um das Element hinzuzufügen.

Strukturelemente hinzufügen

Für die meisten häufig verwendeten Elemente verfügen die Registerkarten Bearbeiten und Einfügen in Paligo über Symbolleistenoptionen zum Hinzufügen der Struktur. Beispielsweise gibt es Symbolleistenoptionen zum Hinzufügen eines neuen Absatzes, einer nummerierten Liste, einer Aufzählungsliste und eines Verfahrens. Dies erleichtert Ihnen das Hinzufügen der Struktur.

Two images. One is of the Edit menu and its toolbar options. The other is of the Insert menu and its toolbar options

Sie können auch über das Element Kontextmenü einzelne Elemente für die Struktur hinzufügen.

Element context menu. It has a search and a list of elements that are valid at the current cursor position.

Einhaltung der DocBook-Regeln

Wenn Sie Strukturelemente hinzufügen, müssen Sie die Docbook-Regeln einhalten. Paligo leitet Sie meistens an, indem es Ihnen nur erlaubt, Elemente dort einzufügen, wo sie gültig sind. Wenn Sie ein Element hinzufügen möchten, aber Paligo es nicht zulässt, liegt dies wahrscheinlich daran, dass die Cursorposition falsch ist. Die häufigste Ursache ist, dass sich der Cursor noch innerhalb des vorherigen Elements oder außerhalb der übergeordneten Struktur befindet, z. B. wenn sich der Cursor außerhalb eines Verfahrens befindet und Sie einen Schritt hinzufügen möchten.

Close up of Element Context Menu's search. The user has searched for the step element but the search returns no results. This is because the step element is not valid at the current cursor position.

Paligo erlaubt es dem Benutzer nicht, ein step-Element an der aktuellen Position hinzuzufügen. Bei der Suche nach dem Schritt wird „Nichts gefunden …“ angezeigt. Dies liegt daran, dass sich die aktuelle Cursorposition außerhalb eines Verfahrens befindet und Schritte nur innerhalb eines Verfahrens gültig sind.