Andreas K. Förster: lesen – Webanwendung zum Veröffentlichen von Literatur
20. Aufbau der Textdateien
Textdateien sollten einen möglichst kurzen Dateinamen haben und auf
„.txt“ enden. Anstelle von Leerzeichen sollte man im Dateinamen
lieber einen Unterstrich (__) verwenden. Der Dateiname ohne die
Endung wird Teil der Adresse.
Dateien, deren Namen mit „index“ beginnen, werden als Indexdateien
interpretiert (siehe unten).
Die Datei muss in [UTF-8] kodiert sein.
Die erste Zeile beginnt mit dem Namen des Autors, einem Doppelpunkt,
evtl. Freiraumzeichen und dem Titel des Buches. Falls der Autor unbekannt ist,
oder bleiben will, sollte in der Zeile entweder gar kein Doppelpunkt
verwendet werden, oder sie sollte gleich mit einem Doppelpunkt beginnen.
Einen Untertitel kann man durch zwei Schrägstriche abgrenzen.
Dann kann eine kurze Einleitung folgen, die durch die erste Kapitelzeile
abgeschlossen wird.
Kapitelzeilen müssen eingerückt sein, dann kommt eine Kapitelnummer,
gefolgt von einem Punkt, Freiraum und der Kapitelüberschrift.
Falls das Buch keine Kapitelüberschriften hat, kann stattdessen
durchgängig das Wort „Kapitel“ verwendet werden. Ein Vorwort muss die
Kapitelnummer „0.“ tragen. Mehrere Vorworte sollten zu einem Kapitel
zusammengefasst werden.
Kapitel werden durch die nächste Kapitelzeile oder dem Dateieinde
abgeschlossen.
Absätze werden durch eine oder mehrere Leerzeilen dargestellt.
Eine Zeile, die nur Freiraum und Sterne (*) enthält, ist eine
Trennzeile (
).
Ausdrücke in geschweiften Klammern ({Beispiel}) werden betont ().
Anstatt geschweifter Klammern kann man auch die Steuerzeichen
[Shift Out (U+000E)] und [Shift In (U+000F)] verwenden.
Ausdrücke in eckigen Klammern ([Beispiel]) werden ebenfalls unterschiedlich
dargestellt (). Deutsche Bücher, die in Fraktur gesetzt sind, setzen
beispielsweise anderssprachige Ausdrücke in Antiqua.
Die genaue Darstellung kann man in der Datei „lesen.css“ festlegen.
Ein einzelner Unterstrich (_) wird durch ein geschütztes Leerzeichen
ersetzt. Bei einem geschützten Leerzeichen wird ein Zeilenumbruch
an der Stelle verhindert.
Falls man eines dieser Zeichen tatsächlich darstellen lassen
will, muss man es doppelt angeben ({{…}}, [[…]], __).
Verse werden durch zwei Schrägstriche getrennt.
Zicke zacke //
Hühnerkacke
Zwei Schrägstriche erzwingen einen Zeilenumbruch, allerdings wird die
Zeichenkombination „://“ intakt gelassen, da diese in [URL]s verwendet
wird.
[URI]s werden automatisch erkannt für die Schemata http, https, ftp, ftps,
file, mailto, gopher, shttp, sftp, ssh, tel, telnet und urn.
Zur Abgrenzung zum umgebenden Text sind zB. Freiraum, spitze Klammern,
oder Anführungsstriche geeignet (siehe [RFC-3986], Anhang C).
Die Adresse muss jedoch zusammenhängend, in einer einzigen Zeile stehen.
Runde Klammern kann man beispielsweise nicht verwenden, da diese Teil der
[URI] sein könnten. Freiraum, oder Zeilenumbrüche innerhalb von [URI]s
sind nicht zulässig.
Anwendungsbeispiel: //
Der Autor ist per E-Mail erreichbar unter ,
oder telefonisch unter .
Zeichen, die in [XHTML] besondere Bedeutung haben, werden korrekt umgewandelt
und können somit bedenkenlos verwendet werden. Das bedeutet auch, dass
[(X)HTML]-Code in Textdateien textuell dargestellt wird. Das ist unter Anderem
auch eine Schutzmaßnahme.
30. Index-Dateien