Code-Blöcke in Kommentaren

In der Computerei gibt es (mindestens) zwei Höllen. Die erste heisst "internationale Zeit- und Datum-Formatierung" und die zweite hört auf den Namen "Zeichen-Codierung". Normale Anwender:innen sind von diesen Höllen nicht betroffen, weil ihnen dieses Problem von den Programmierern (überwiegend) abgenommen wird. Doch es gibt Anwendungsfälle, bei denen auch ihr davon betroffen sein könntet.

Habt ihr schon einmal einen Kommentar zu einem Artikel bei GNU/Linux.ch geschrieben, in dem Code-Blöcke enthalten waren? Das kommt häufig vor und wir erhalten bisweilen Fragen zur Formatierung solcher Code-Blöcke. Hier ist ein Beispiel:

In meinem Kommentar zu dem Artikel möchte ich eine Lösung vorschlagen. Der Code dafür lautet so:

print("Hallo Welt")

Ich hoffe, mein Kommentar hilft den Lesern weiter.

Was bei diesem Beispiel so einfach aussieht, entpuppt sich bei der Kommentarfunktion unseres CMS (Bludit) als Herausforderung. Wir verwenden Snicker als Kommentar-Plug-in in Bludit. Bei diesem Plug-in ist (auf den ersten Blick) nicht klar, welche Formatierungen unterstützt werden. Tim ist dabei, dieses Rätsel zu lüften.

Unser Ziel ist es, die Kommentarfunktion mit einer Information über die möglichen Formatierungen zu ergänzen. Bis Tim das ausgegraben hat, möchte ich euch eine Möglichkeit vorstellen, um Code-Blöcke einzubinden. Und jetzt geht es los:

Um einen Code-Block in einen Kommentar einzufügen, klammert ihr den Code in drei Gravis ein.

Alles klar, oder versteht ihr nur Bahnhof? Mit "klammern" meine ich, dass der Code-Block mit drei Gravis beginnt und mit drei Gravis endet, nämlich so:

```

Code

```

Was ist ein Gravis und wie tippe ich das ein? Die Antwort hängt von deinem Tastatur-Layout ab. Auf einer Schweizer Tastatur befindet sich das/der/die Gravis auf der Taste Shift-Caret (^). Es handelt sich um ein 'oben nach links gerichtetes' einfaches Anführungszeichen. Dummerweise gibt es verschiedene 'oben nach links gerichtete' Anführungszeichen. Ihr ahnt es; so kommen wir nicht weiter.

Unicode

Um die Sache in den Griff zu bekommen, muss ein universaler Zeichensatz her. Den gibt es und er heisst Unicode. Dieser Standard beschreibt in der Version 16.0 knapp 160.000 Zeichen. Da ist für jeden etwas dabei. Nun gibt es zwei Anforderungen: entweder möchte man einen Unicode eintippen und das zugehörige Zeichen sehen; oder man möchte das Zeichen eintippen und den zugehörigen Unicode sehen.

Wie ihr es vermutet, gibt es im Linux-Universum viele GUI-Anwendungen, die diese Anforderung erfüllen. Es gibt noch mehr Webseiten für diesen Zweck. Um die Lösung möglichst allgemein zu halten, schlage ich die Kommandozeile vor. Der Vorteil dieser Lösung ist, dass man nicht auf zig Betriebssysteme, Distros und Desktop-Anwendungen eingehen muss. Ich möchte beim Gravis bleiben.

Um den Unicode des Gravis zu ermitteln, habe ich keine befriedigende Lösung gefunden. Doch so geht es halbwegs:

python
print(format(ord('`'), '#08x'))
0x000060

Falls ihr eine bessere Lösung kennt, schreibt sie bitte in die Kommentare.

Umgekehrt geht es einfacher:

echo -e '\u0060'
`

Die erste Lösung ist unbefriedigend, weil man den Python-Interpreter starten muss und das Ergebnis (0x000060) in u0060 umgewandelt werden will. Doch damit kann man arbeiten.

Nachtrag

So geht es. Allerdings muss man das Gravis mit einem Backslash escapen:

printf '%x\n' "'\`"
60

Eingabe

Zum Schluss stellt sich die Frage, wie man ein Unicode-Zeichen eintippt. Das ist einfach: Ctrl+Shift+u 0060 ergibt das Zeichen `

Wenn ihr einen Code-Block in einen Kommentar bei uns einfügen möchtet, tippt ihr dreimal die oben genannte Tastenkombination oder dreimal das Gravis über die Tastatur ein. Dann fügt ihr den Code-Block ein und schliesst diesen mit drei Gravis ab.

Titelbild: https://pixabay.com/photos/cms-wordpress-265128/

Quelle: Ralf