Keywords… « ◉ » Kapitelende

Codeabschnitt

Aktualisiert am 14.02.2024 Lesedauer 1 - 2 Min.

Mit einigen Markdown-Erweiterungen kann  OSE  die Interpretation von Markdown aussetzen. Konzeptionell folgt das dem generellen Ansatz von Markdown, dass z.B. HTML-Code durchgereicht wird. Die „Abschnitte“ erfüllen eine zusätzliche Funktion: Innerhalb dieser Bereiche wird keine Markdown-Ersetzung durchgeführt.

Allen vier Varianten haben eine Gemeinsamkeit: Die Markdown-Interpretation wird nur ausgesetzt, wenn sich die umschließenden Marken alleinstehend in einem Absatz am Anfang und Ende des Bereichs befinden.

Quelltext

Das ist ein „normaler“ Markdown-Code, der bequem auf einen markierten Block angewandt werden kann. Ohne Blockmarkierung wird ein Bereich eingefügt. Der Cursor steht in beiden Fällen in der ersten Codezeile des Bereichs.

PHP

Dieser Abschnitt wird als PHP-Code durchgereicht. In den meisten Fällen wird ggf. eine darin programmiertes echo eine Ausgabe erzeugen. Alles, inklusive der Umklammerung <?php … ?> wird beim Export in der Zieldatei abgelegt.

Die „PHP-Klammer“ kann zwar innerhalb eines Absatzes verwendet werden, der Text dazwischen wird dennoch als Markdown behandelt. Das kann zweckmäßig sein.

Vorsicht

Es findet keine Validierung des PHP-Codes statt. Ob damit eine anzeigefähige Seite entsteht, sollte auf jeden Fall in einer Testumgebung überprüft werden.

Beliebig

Entspricht dem PHP-Abschnitt, mit einem entscheidenden Unterschied: Die Klammer <?code … ?> drumherum wird entfernt. Das ermöglicht die übergabe beliebigen Codes, z.B. eines Inline-Stylesheets. Auch hier findet keine Validierung statt.

HTML-Kommentar

Kommentare hinterlassen alles zwischen den Marken in der Export-Datei, das ist in der Seitendarstellung jedoch unsichtbar.

Anwendungshinweise

  • Dies Umklammerungen können auch kombiniert werden, sie werden „von innen nach außen“ aufgelöst, d.h. es darf keine Überschneidung der verschiedenen Typen geben.
  • Soll in einem Code-Abschnitt eine Auszeichnung verwendet werden, die einen Code-Abschnitt markiert (am Absatzanfang), kann die Interpretation durch ein vorangestelltes Leerzeichen oder einen „unsichtbaren Trennstrich“ (\-) ausgesetzt werden.
  • Die generelle Escape-Funktion gilt überall, inklusive aller Code-Abschnitte!
Keywords… « ◉ » Kapitelende