Beispielcode

Dieses Dokument enthält die Anleitung zur Verwendung von 'structured text'. Dieses Dokument wurde mit Microsoft Word erstellt und mit WordXML automatisch in XML , HTML und HTMLHelp (.chm) konvertiert. Mit WordXML, dem Word-PlugIn der struktur AG, erweitern Sie Microsoft Word zu einem leistungsfähigen XML-Werkzeug.

Beispielcode

Wie bereits oben erwähnt, gibt es für structured text –Autoren einfache Konventionen, um etwa die monotypische Semantik des Tags <code> zu erreichen:

Wenn der Dialog erscheint, klicken Sie auf den ‘OK’-Button.

wird wie folgt in HTML dargestellt:

 Wenn der Dialog erscheint, klicken Sie auf den <code>OK<code>-Button.

Wie auch immer, manchmal hat man sehr lange Code-Passagen. Zum Beispiel könnte man eine Python-Funktion mitten in einem Artikel beschreiben wollen. Ein Codeblock kann auch dadurch angezeigt werden, daß der vorhergehende Paragraph mit ’::’ endet, und der bzw. die folgende(n) Paragraph(en) eingerückt werden.

Wir betrachten ein Beispiel:

In unserem folgenden Python Beispiel , rechnen wir Menschenjahre in Hundejahre um::

def hundeJahre(alter):

“““Umrechnung von Menschenjahre in Hundejahre”””

return alter*7

Und in HTML:

 In unserem folgenden Python Beispiel , rechnen wir Menschenjahre in Hundejahre um:

<pre>def hundeJahre(alter):

“““Umrechnung von Menschenjahre in Hundejahre”””

return alter*7

</pre>

Die Verwendung von ’::’ als Endzeichen des letzten Satzes eines Paragraphen bedeutet mehr als die Anwendung der <code>-Tag-Semantik. Der eingerückte Block wird escaped, das bedeutet, daß Zeichen, die im Kontext von structured text oder HTML eine spezielle Bedeutung haben, diese Bedeutung verlieren und nur als ihre druckbare Repräsentation verstanden werden. Beispielsweise wird ‘<’ als Kleinerzeichen ausgegeben und nicht als Tag-Anfang interpretiert.

Genau so konnten auch die ganzen Code-Ausschnitte in diesem Artikel formatiert dargestellt werden.

Noch ein Beispiel. Die Zeichen ‘größer als’, ‘kleiner als’ und ‘Kaufmanns-Und’ sind escaped:

Hier ist ein HTML-Beispiel::

<html>

Dies ist eine Seite über Hunde und Katzen.

</html>

… und folgendes HTML wird erzeugt:

Hier ist ein HTML-Beispiel:

<pre>

<html>

Dies ist eine Seite über Hunde und Katzen.

</html>

</pre>