Anmerkungen zu Codeblöcken erstellen
Mithilfe des Elements calloutlist
und von co
-Elementen können Sie Anmerkungen erstellen. In der veröffentlichten Ausgabe fungieren die Callouts als anklickbare „Hotspots“, mit denen sich Teile des Codes hervorheben lassen. Klickt man auf einen „Hotspot“,
gelangt man zum Callout-Erklärtext für diesen „Hotspot“.
Beispielsweise besitzt das Codebeispiel in der nachstehenden Abbildung zwei Callout-„Hotspots“, die mit 1 und 2 bezeichnet sind. Unterhalb des Codebeispiels befinden sich Ziffern, die den Hotspots entsprechen, und neben jeder Ziffer steht eine Anmerkung, die über den Zweck des entsprechenden Codeabschnitts aufklärt.
So erstellen Sie Anmerkungen mit calloutlist
:
-
Wählen Sie eine Position im Codeblock, an die ein Callout-„Hotspot“ gesetzt werden soll.
-
Drücken Sie Alt + Enter ⏎ (Windows) oder Command ⌘ + Enter ⏎ (Mac), um den Kontextmenü „Elemente“ anzuzeigen.
-
Wählen Sie das
co
-Element aus und geben Sie ihm im Abschnitt Elementattribute einenxml:id
-Wert. Jedesco
-Element muss einenxml:id
-Wert besitzen, der in diesem spezifischen Topic eindeutig ist. Zum Beispiel können Sie dem erstenco
-Element diexml:id
id_1, dem zweitenco
-Element diexml:id
id_2 und so weiter geben. -
Fügen Sie hinter dem
programlisting
-Element, das Ihren Codeblock enthält, eincalloutlist
-Element hinzu.Tipp
Meist empfiehlt es sich, die
programlisting
- undcalloutlist
-Elemente in einexample
-Element einzufügen, so dass sie sich alle in einem gemeinsamen „Container“ (demexample
-Element) befinden. -
Weisen Sie außerdem jedem
callout
in dercalloutlist
einexml:id
zu, die sich von denen in denco
-Elementen unterscheidet, z. B. „callout_1“, „callout_2“ usw. Auch diese IDs müssen eindeutig sein. -
Verknüpfen Sie die
co
-Elemente mit dencallout
-Elementen:-
Fügen Sie für jedes
co
-Element einlinkends
-Attribut hinzu. Stellen Sie den Wert deslinkends
-Attributs auf denxml:id
-Wert voncallout
ein, mit dem Sie es verknüpfen möchten. -
Fügen Sie für jedes
callout
-Element das Attributarearefs
hinzu. Geben Sie als Wert des arearefs-Attributs denxml:id
-Wert desco
-Elements ein, mit dem es verknüpft werden soll.
-