Skip to main content

Attribute

Jedes Element verfügt über eine Reihe von Attributen, d. h. Eigenschaften, die die Eigenschaften des Elements definieren. Jedes Attribut besitzt einen Wert, und durch Ändern des Werts können Sie beeinflussen, wie das Element in Paligo verwendet werden soll.

Attribute werden im Panel „Elementattribute“ behandelt.

Element_Attributes_Panel.jpg

Tipp

Sie können Ihre Inhalte mithilfe von Attributen filtern, siehe Filterung/Profiling.

Stil mit Attributen

Jedes Element verfügt über eine Reihe von Attributen, d. h. Eigenschaften, die die Eigenschaften des Elements definieren. Jedes Attribut besitzt einen Wert, und durch Ändern des Werts können Sie beeinflussen, wie das Element in Paligo verwendet werden soll.

Hier sehen Sie einige gängige Anwendungsbeispiele für Elementattribute:

  • Legen Sie das width-Attribut eines Bildobjekts fest, um seine Größe (z. B. Breite) in der Ausgabe zu steuern: 50 %

  • Stellen Sie das role-Attribut einer section auf accordion, damit der Abschnitt in der Ausgabe als einklappbar erscheint.

  • Wenn Sie das audience-Attribut von para auf developer einstellen, wird der Absatz nur in Inhalten angezeigt, die sich an Entwickler richten.

Stil mit Attributen Das wird in Panel „Elementattribute“ behandelt. Mithilfe der erweiterten Suche können Sie nach Komponenten suchen, die bestimmte Attribute und Profilwerte enthalten, siehe Nach Attributen suchen.

Durch Auswahl des Elements werden aktuell verwendete Attribute und Werte im Panel „Elementattribute“ (1) angezeigt. Über das Dropdown-Menü Attribut hinzufügen (2) können Sie zusätzliche Attribute hinzufügen. Wenn Sie ein Attribut hinzufügen, müssen Sie auch dessen Wert in das Feld neben dem Attributnamen (1) eintragen. Über die Felder können Sie auch bestehende Attributwerte ändern. Weitere Informationen finden Sie unter Attribute.

Element attributes

1 = Panel Elementattribute, 2 = Dropdown-Menü Attribut hinzufügen

Tipp

Enthält ein Topic Informationen zu mehreren Produkten, kann es sinnvoll sein, Favoritenprofile zu erstellen, die bestimmte Filter und Variablen enthalten, die sich beim Betrachten von Inhalten oder Versenden von Inhalten an Revisoren oder Verfasser einschalten lassen.

Attribute hinzufügen

Attribute finden in Paligo für viele verschiedene Zwecke Einsatz, einschließlich der Anwendung von Filtern auf Ihre Elemente, um Inhalte in verschiedenen Szenarien ein- oder daraus auszuschließen. Viele Attribute stammen aus dem DocBook-Standard, doch es gibt auch einige spezifische für Paligo.

So fügen Sie einem Element Attribute hinzu:

  1. Wählen Sie das Element im Topic aus.

  2. Platzieren Sie den Cursor im Menü „Elementstruktur“ unter der Symbolleiste.

    Element_Structure_Menu_small.png

    Anmerkung

    Wenn Sie ein Element im Strukturmenü des Elements auswählen, markiert Paligo es gelb.

  3. Wählen Sie das Element aus und wählen Sie Zum Element gehen, um die Attribute für dieses bestimmte Element anzuzeigen.

    Remove_element_attributes_2.png

    Der Panel „Elementattribute“ zeigt nun die Attribute für das ausgewählte Element an.

  4. Verwenden Sie die Suche Attribut hinzufügen, um den Namen des Attributs einzugeben oder durch die verfügbaren Optionen zu scrollen. Search.png

    element-attributes-add.jpg

    Im Bild oben wird das Attribut zu einem para-Element hinzugefügt.

  5. Wählen Sie das einzufügende Attribut Search.png.

    Anmerkung

    Sie können nur Attribute hinzufügen, die für das ausgewählte Element gültig sind.

  6. Geben Sie dem Attribut einen Wert. Je nach Attributtyp:

    • Wählen Sie einen Menüpunkt aus.

    • Geben Sie den Wert manuell in ein Texteingabefeld ein.

    • Setzen Sie ein Häkchen vor einem Profiling-Wert oder Profiling-Werte erstellen

    attributeswidget.png
    Profiling values dialog shows a list of profile values, a button to add a value, and cancel and apply buttons.

    Links – Der Größenwert für das Attribut width wird manuell eingetragen. Rechts – Für das Attribut audience sind mehrere Profiling-Werte zur Auswahl aufgelistet.

  7. Drücken Sie Speichern. Save icon.

  8. Wiederholen Sie diesen Vorgang für alle weiteren Elemente, die Attribute benötigen.

Tipp

Um ein Elementattribut zu entfernen, siehe Attribute entfernen.

Um einen Profiling-Wert für ein Attribut zu aktualisieren, siehe Profiling-Werte hinzufügen oder entfernen.

Mehrere Werte zu einem Attribut hinzufügen

Elementattribute sind Eigenschaften, die Sie einem Element hinzufügen können, z. B. ein Kapitel oder eine Tabelle. Die vielen verschiedenen Attribute sind im Panel Elementattribute enthalten, worüber sie ausgewählt und hinzugefügt werden können (siehe Stil mit Attributen). Sobald Sie ein Elementattribut hinzufügen, müssen Sie auch dessen Wert festlegen. In der Regel haben sie genau einen Wert, aber Sie können bei Bedarf auch mehrere Werte hinzufügen.

Wenn Sie beispielsweise über das role-Attribut einen Klassennamen zu einer section zuordnen und auch einklappbar machen möchten, müssten Sie zwei Werte hinzufügen. In diesem Fall fügen Sie „accordion“ (um es einklappbar zu machen) und einen weiteren Wert für den Klassennamen hinzu.

So fügen Sie mehrere Werte hinzu:

  1. Im Panel Elementattribute können Sie Attribute zu Elementen hinzufügen.

  2. Geben Sie die Werte in das Feld neben dem Attribut ein. Trennen Sie die Werte wie folgt:

    • Verwenden Sie ein Semikolon zwischen den Werten. Beispielsweise besitzt das role-Attribut zwei role-Werte: Akkordeon und Unterabschnitt. Die einzelnen Werte werden durch Semikolons getrennt.

      role="accordion;subsection;"
      Role attribute has the value: accordion;subsection;

    • Mit einem Doppelpunkt trennen Sie „Schlüssel“ von Werten. „Schlüssel“ sind Eigenschaften, denen Werte zugewiesen sein können. Sie eignen sich nur für bestimmte Attribute, wie z. B. das style-Attribut, das Sie einem Tabellenelement zuweisen können. Beispiel:

      style="border-style:solid 2px;border-color:blue;"
      style attribute has the value: border-style:solid 2px;border-color:blue;

      Das Attribut ist hier „style“. Der erste Schlüssel steht für den Rahmenlinientyp und wird von seinem Wert (solid 2px) durch einen Doppelpunkt (:) getrennt. Die zweite Taste steht für die Rahmenlinienfarbe und wird von ihrem Wert (blau) durch einen Doppelpunkt (:) getrennt. Jedes Schlüssel- und Wertepaar wird durch ein Semikolon (;) vom nachfolgenden getrennt.

  3. Drücken Sie Speichern. Save icon.

Anmerkung

Für einige Attribute ist auch das Leerzeichen als Trennzeichen zulässig. Wenn Sie beispielsweise ein role-Attribut hinzufügen und seinen Wert auf "specifications table" setzen, erhält es im veröffentlichten HTML zwei Klassennamen. In der HTML-Ausgabe erscheint es als class="specifications table", was bedeutet, dass „specifications“ eine Klasse und „table“ eine andere Klasse ist.

Aus diesem Grund ist es besser, für die Benennung eines Wertes, der als Klasse fungieren soll, keine Leerzeichen zu verwenden. Verwenden Sie daher z. B. "specifications-table" (mit Bindestrich), da dies eine Klasse ist, anstatt "specifications table", was für zwei Klassen steht.

Attribute entfernen

Jedes Element in Paligo kann Attribute haben, und diese stehen für Eigenschaften. Beispielsweise könnte ein Absatz ein role-Attribut mit dem Wert „example-style“ haben, sodass dieser mit CSS anders als andere Absätze gestaltet werden kann. Nicht mehr benötigte Attribute können Sie löschen.

So entfernen Sie ein angewendetes Attribut:

  1. Wählen Sie das Element im Topic aus.

  2. Platzieren Sie den Cursor im Menü „Elementstruktur“ unter der Symbolleiste.

    Element_Structure_Menu_small.png

    Anmerkung

    Wenn Sie ein Element im Strukturmenü des Elements auswählen, markiert Paligo es gelb.

  3. Wählen Sie das Element aus und wählen Sie Zum Element gehen, um die Attribute für dieses bestimmte Element anzuzeigen.

    Remove_element_attributes_2.png

    Der Panel „Elementattribute“ zeigt nun die Attribute für das ausgewählte Element an.

  4. Setzen Sie den Cursor im Panel Elementattribute auf das Attribut und klicken Sie auf X, um es aus dem Element zu entfernen.

    Remove_element_attribute_3_small.png

  5. Drücken Sie Speichern. Save icon.

Unterstützte Attribute

Paligo basiert auf DocBook 5.1 und unterstützt die meisten Attribute, die in diesem Content-Modell enthalten sind. Erfahren Sie mehr über DocBook 5.1. Zu berücksichten sind allerdings einige Unterschiede, nämlich dass in Paligo

  • das Element <article> für Publikations-Topics verwendet wird, siehe Unterstützte Info-Elemente,

  • <section> für Topics verwendet wird und

  • keine anderen Elemente auf Stamm-Ebene unterstützt werden, wie <book> oder <set>.

Achtung

Paligo unterstützt auch einige „interne Attribute“ wie xinfo:image, xinfo:resource und xinfo:text. Diese „internen Attribute“ werden von Paligo automatisch erstellt und gepflegt und dienen der Zuordnung von IDs zu Elementen. Sie sollten diese unberührt lassen.

Jedes Element verfügt über eine Reihe von Attributen, d. h. Eigenschaften, die die Eigenschaften des Elements definieren. Für jedes Attribut gibt es einen Wert, und durch Ändern des Werts können Sie beeinflussen, wie das Element in Paligo verwendet werden soll. Typische Einsatzgebiete sind:

Element attributes panel. The td element is selected and it has a style attribute. The value of the style attribute is set to background-color:bg1

Im vorstehenden Bild ist style das Attribut und background-color:bg1 ist dessen Wert.

Paligo unterstützt Attribute filtern sowie die folgenden Attribute:

Attribut

Beschreibung

Tiefe 

Wird in imagedata-Elementen verwendet, um den Wert für die Bildtiefe (-höhe) im Verhältnis zum Ansichtsfenster einzustellen. Das Ansichtsfenster ist die Fläche, die für das imageobject zur Verfügung steht. Erfahren Sie mehr über Bildgrößenbestimmung.

contentdepth 

Wird in imagedata-Elementen verwendet, um den Wert für die Bildtiefe (-höhe) einzustellen, und hat keine Auswirkungen auf das Ansichtsfenster. Das Ansichtsfenster ist die Fläche, die für das imageobject zur Verfügung steht. Erfahren Sie mehr über Bildgrößenbestimmung.

contentwidth 

Wird in imagedata-Elementen verwendet, um den Wert für die Bildbreite einzustellen, und hat keine Auswirkungen auf das Ansichtsfenster. Das Ansichtsfenster ist die Fläche, die für das imageobject zur Verfügung steht. Erfahren Sie mehr über Bildgrößenbestimmung.

continuation

Für eine fortlaufende Nummerierung in Seitenleisten, siehe Verwenden von Nummerierungen in Seitenleisten.

label

Wird auf das section-Element eines Topics angewendet, um zu verhindern, dass es in einer PDF-Ausgabe nummeriert wird (ein Wert von 0 bedeutet keine Nummerierung).

language

Wird in programlisting-Elementen verwendet, um die Sprache für ein Codebeispiel einzustellen, siehe Syntax-Hervorhebung.

role

Für das role-Attribut werden spezifische Werte eingegeben, um eine bestimmte Funktionalität in Paligo zu erreichen, siehe role-Attributwerte

scalefit

Hiermit lässt sich die Größe eines Bildes an die jeweils verfügbare Fläche anpassen. Lautet der Wert scalefit="1", wird das Bild skaliert (mit demselben Faktor für beide Dimensionen), sodass die Grafik nur innerhalb der verfügbaren Höhe oder Breite passt (je nachdem, was stärker einschränkt). Wird ein anderes Bildgrößenattribut angegeben, bestimmen diese Attribute die Grafikgröße, und scalefit wird ignoriert.

style

Legen Sie den Stil der Hintergrundfarben für einzelne Tabellenzellen (td oder th) für die PDF-Ausgabe fest, siehe Formatieren des Tabellenkörpers (PDF).

tabstyle

Gestalten Sie das table-Element mit kompakten Absatzabständen, siehe Festlegen des Absatzabstands von Tabellenzellen.

width 

Wird in imagedata-Elementen verwendet, um den Wert für die Bildbreite width im Verhältnis zum Ansichtsfenster einzustellen. Das Ansichtsfenster ist die Fläche, die für das imageobject zur Verfügung steht. Erfahren Sie mehr über Bildgrößenbestimmung.

xinfo:appid

Wird bei der Einrichtung einer kontextsensitiven Hilfe auf das section-Element angewendet, siehe Kontextsensitive Hilfe.

Das Präfix @xinfo: gibt an, dass es sich um ein Erweiterungsattribut handelt.

xinfo:chunk

Wird auf das section-Element angewendet, um Paligo anzuweisen, ein Topic in HTML-Ausgaben als separate Seite anzuzeigen, siehe Unterabschnitte erstellen.

Das Präfix @xinfo: gibt an, dass es sich um ein Erweiterungsattribut handelt.

xinfo:keep-together

Dient zur Steuerung von Elementen über zwei Seiten in PDF-Ausgaben, siehe Weiche Seitenumbrüche.

Das Präfix @xinfo: gibt an, dass es sich um ein Erweiterungsattribut handelt.

xinfo:keep-with-next

Dient zur Steuerung von Elementen über zwei Seiten in PDF-Ausgaben, siehe Weiche Seitenumbrüche.

Das Präfix @xinfo: gibt an, dass es sich um ein Erweiterungsattribut handelt.

xinfo:outname

Wird im section-Element angewendet, um die URL für das Topic zu steuern, wenn es für HTML-Ausgaben in eine Seite konvertiert wird. Der von Ihnen eingegebene Wert wird als URL verwendet, siehe Dateinamen von Topics.

Das Präfix @xinfo: gibt an, dass es sich um ein Erweiterungsattribut handelt.

xinfo:pagebreak

Zum Festlegen eines Seitenumbruchs in PDF-Ausgaben, siehe Harte Seitenumbrüche.

Das Präfix @xinfo: gibt an, dass es sich um ein Erweiterungsattribut handelt.

xlink:href

Hiermit können Bilder als Links verwendet werden, siehe Bilder und andere Elemente in Links verwandeln.

xlink:show

Überschreibt das Standard-Linkverhalten für einzelne Links, siehe Individuelles Verknüpfungsverhalten aktualisieren.

Tipp

Informationen zum Hinzufügen eines Elementattributs finden Sie unter Attribute.

role-Attributwerte

Sie können für das role-Attribut spezifische Werte eingeben, um eine bestimmte Funktionalität in Paligo zu erzielen. Zu den zahlreichen Möglichkeiten zählt das Hinzufügen von Klassennamen zu HTML-Ausgaben, das Hinzufügen von besonders reaktionsschnellen Funktionen zu HTML-Tabellen oder die Steuerung von Seitenumbrüchen in PDF-Ausgaben.

Element attributes panel. The role attribute is added and it has a value of extra-responsive

Tipp

Wenn bereits ein role-Attribut vorhanden ist, trennen Sie die Werte mit einem Semikolon.

Die folgende Tabelle enthält die role-Attribute und -Werte, die Sie in Paligo verwenden können.

Attributwert

Beschreibung

accordion

Hiermit lassen sich Abschnitte (section) ein- und ausklappen. Der Abschnittstitel ist sichtbar und wenn der Benutzer darauf klickt, wird der Abschnitt erweitert, um den Inhalt anzuzeigen, siehe Akkordeons (einklappbare Abschnitte).

column-count

Dient zum Einstellen der Spaltenanzahl in einem sidebar-Element in PDFs, siehe Aktivieren mehrerer Spalten (PDF).

column-gap

Wird verwendet, um den Spaltenabstand in einem sidebar-Element für PDFs einzustellen, siehe Aktivieren mehrerer Spalten (PDF)).

extra-responsive

Dient in table-Elementen zum Hinzufügen einer festen Kopfleiste („Sticky Header“) und von Spaltenfiltern zu Tabellen für HTML5-Ausgaben, siehe Aktivieren des Spaltenfilters und des Sticky Headers.

font-size

Wird verwendet, um die Größe der Beschriftung eines verbatim-Elements, z. B. programlisting, einzustellen, siehe Verbatim (Code und Software).

<free text>

Kann für jedes Element verwendet werden und Sie können beliebigen Text als Wert eingeben, z. B. role: online-image. Der Wert wird als Klassenname in HTML-Ausgaben verwendet, allerdings nur, wenn das HTML-Layout so eingestellt ist, dass das role-Attribut als Klassenname aufgenommen wird, siehe Klassen und Attribute, HTML5.

img-thumbnail

Wird für mediaobject-Elemente verwendet, um diese in HTML-Ausgaben als kleine „Miniaturansichten“ einzustellen, siehe Miniaturansichten.

img-thumbnail-reset

Wird für mediaobject-Elemente verwendet, um zu verhindern, dass diese in HTML-Ausgaben als Miniaturansicht dargestellt werden, siehe Miniaturansichten.

multi-publication-portal

Wird für articleElemente verwendet, wenn Sie im selben Helpcenter mehrere Publikationen veröffentlichen, siehe Portal für Mehrfach-Veröffentlichungen.

notintoc

Wird in section-Elementen verwendet, um ein bestimmtes Topic aus dem Inhaltsverzeichnis von PDF-Ausgaben auszuschließen, siehe Optionen im PDF-Layout-Editor.

portal-category

Hiermit werden in section-Elementen Kategorie-Panels für Topics in HTML-Helpcenter-Ausgaben erstellt, siehe Topics für Kategorie-Panels.

promoted-content

Dient in section-Elementen dazu, ein Topic als „Hervorgehobener Inhalt“ festzulegen, siehe Topics für ausgewählte Inhalte.

reuse-range

Dient in procedure- und orderedlist-Elementen dazu, die Nummerierung der Schritte/Elemente eines vorherigen Verfahrens oder einer vorherigen Liste fortzusetzen, siehe Listenelemente wiederverwenden.

swagger-topic

Dient in section-Elementen zum Einbetten von Swagger/Open-API-Inhalten in Paligo für die Veröffentlichung als:

top-nav-link

Wird im section-Element verwendet, um zu einem Topic aus dem oberen Navigationsmenü zu verlinken, siehe Hinzufügen von Top-Navigationslinks zu Topics.

wrap-option

Dient in verbatim-Elementen, wie z. B. programlisting, zur Steuerung von Zeilenumbrüchen, siehe Verbatim (Code und Software).

Hervorhebungsattribut hinzufügen

Mit dem Attribut emphasis können Sie den Inhalt fett, kursiv oder unterstrichen markieren. Beim Hinzufügen des emphasis-Attributs wird der Text standardmäßig kursiv formatiert. Wenn Sie eine Rolle hinzufügen, ersetzt deren Wert (fett oder unterstrichen) die standardmäßige Kursivformatierung.

Sollten Sie bei der Anwendung des emphasis-Attributs eine andere Hervorhebung bevorzugen, nutzen Sie es in Kombination mit den Symbolleiste-Schaltflächen oder Tastenkombinationen.

Wichtig

Sie können Text hervorheben, der bereits über ein inline-Element verfügt, wie z. B. code. Dabei ist wichtig, dass das emphasis-Element sich außerhalb des inline-Elements befindet, zum Beispiel:

 <para><emphasis><code>code snippet content goes here</code></emphasis></para>

  1. Markieren Sie den Text, der fett, kursiv oder unterstrichen formatiert werden soll.

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

  3. Geben Sie emphasis ein und wählen Sie es aus.

    Standardmäßig wird der Text kursiv angezeigt.

  4. Um ihn fett oder unterstrichen zu formatieren, wählen Sie das emphasis-Element aus oder markieren Sie den entsprechenden Text.

    empasis-role-bold.jpg

  5. Fügen Sie das role-Attribut hinzu und setzen Sie dessen Wert im Abschnitt Elementattribute auf bold oder underline.

    Die Kursivformatierung wird durch den gewählten Wert ersetzt.

  6. Drücken Sie Speichern. Save icon.