Quellcode im Topic einfügen

Aufgabe

Quellcode-Beispiele sollen in ein Topic oder Snippet eingefügt werden. Die quellcode-typischen Einrückungen sollen dabei erhalten bleiben.

Lösung ab MadCap Flare V2020

Mit Code Snippets können Sie Quellcode in Ihre Dokumentation einfügen. Die Syntax wird automatisch hervorgehoben.

  1. Cursor im Topic platzieren

  2. Menü Einfügen > Abschnitt Text > Code Snippet

  3. Im Dialog Code-Editor Quellcode einfügen und rechts die gewünschten Einstellungen wählen, z. B. Beschriftung, Sprache, Zeilennummern.

  4. Schaltfläche OK klicken

    —> In der HTML5-Ausgabe wird der Code-Snippet eingefügt. Ergänzt ist eine Schaltfläche zum Herauskopieren des Quellcodes.

Lösung vor MadCap Flare V2020

Die Auszeichnungen des Quellcodes bleiben beim Einfügen in ein Topic oder Snippet nicht erhalten, z. B. Farben.

  1. Quellcode in die Zwischenablage übernehmen

  2. Topic bzw. Snippet öffnen

  3. Quellcode aus Zwischenablage einfügen (Paste Inline Text)

    pre {

    display: block;

    font-family: monospace;

    white-space: pre;

    margin: 1em 0;

    }

  4. Einrückungen erzeugen:

    1. Fenster Formatvorlagen öffnen: Home > Abschnitt Formate > Fenster „Format“

    2. Cursor in den eingefügten Quellcode setzen > im Fenster Formatvorlagen: Formatvorlage pre wählen.

      pre {
        display: block;
        font-family: monospace;
        white-space: pre;
        margin: 1em 0;
      }

Das Attribut width wird in HTML5 nicht unterstützt. Mit width kann die Anzahl Zeichen pro Zeile festgelegt werden.

pre hat keinen Zeilenumbruch, was bei der Darstellung auf kleinen Bildschirmen unschön aussieht. Zeilenumbrüche können mit dem Attribut white-space erzeugt werden.

Weitere Informationen

Autor: Jörg Ertelt / Letzte Änderung: 28.2.2025