Blogvorlage

FUNKTIONSWEISE

Aus einer beliebigen Anzahl an Textdateien und Vorlagedateien werden automatisch html-Dateien erzeugt, die komplett miteinander verlinkt sind, ähnlich wie bei einem interaktiven Blog. Trotzdem kommt alles mit statischen Seiten und ohne Skripte aus. Es gibt ein paar Voraussetzungen an die Quelldateien, aber prinzipiell ist kein Wissen zu html-Dateien erforderlich. Mit Webdesign-Kenntnissen kann das Layout stark angepasst werden.
Die Standardvorlage ist W3C konform und wenn es der Inhalt der einzulesenden Dateien ebenfalls ist, so sind es automatisch alle erzeugten Dateien.



WICHTIG

Da keine Überprüfung der Enkodierung durchgeführt wird, müssen alle Quelldateien UTF-8 kodiert sein (sonst werden Probleme mit Umlauten auftauchen). Dateinamen mit Umlauten führen i.d.R. auch zu Problemen bei der Verlinkung und sind deshalb zu vermeiden. Um unter Windows schnell und einfach neue UTF-8 Textdateien zu erstellen, sollte man einen entsprechenden Editor nutzen (z.B. Notepad++) oder eine der vorhandenen Dateien kopieren, umbenennen und editieren statt eine neue Datei anzulegen.



MOTIVATION

Warum erzeugt man nicht das gleiche mit php/Ajax automatisch? Das kommt auf den Verwendungszweck an. Wenn man möglichst viel Interaktivität mit den Nutzern will (Kommentare von Benutzern, mehrere Autoren, Einbinden in soziale Medien, ... ), dann sollte man sich eher nach einer anderen Lösung umsehen. Geht es aber hauptsächlich darum, als Einzelnutzer einfach, unkompliziert und ohne unnötige Skripte eine scheinbar interaktive Seite bereitzustellen, dann kann das von diesem Programm realisiert werden.



ALLGEMEINES

Das Programm braucht für die Eingabe einen Unterordner "quelldateien", in dem die Eintragsdateien als .txt Dateien liegen. Außerdem werden die beiden Dateien "dateianfang.txt" und "dateiende.txt" erwartet, die im gleichen Verzeichnis wie das Programm selbst sein müssen.

Für die Ausgabe braucht das Programm einen Unterordner "www", in dem sich die Ordner "eintraege" und "schlagwoerter" befinden.

Aus jeder Eintragsdatei wird eine html-Seite erstellt, die automatisch nach Alphabet, Datum und Schlagwörtern in die Übersichtsliste verlinkt wird. Zusätzlich wird auch eine Verlinkung über die Schlagwörter erzeugt, so dass alle Einträge miteinander vernetzt sind.

Dieser Vorgang wird jedesmal ausgeführt, wenn man das Programm startet. Wenn neue Quelldateien dazugekommen sind, werden sie automatisch integriert.

Werden Quelldateien entfernt, dann wird beim Ausführen des Programmes die Vernetzung der restlichen Quelldateien durchgeführt. Da das Programm keine Dateien löscht, bleiben Dateien, die vorher erstellt wurden, als "Dateileichen" zurück. Sie sind zwar über die normalen Seiten nicht mehr verlinkt, aber können noch per Hand aufgerufen werden (da sie noch esistieren). Je nach Änderung kann und wird die Verlinkung von einer "Dateileiche" zu den anderen Dateien nicht mehr richtig sein.

Deshalb empfehle ich, dass vor jedem Löschen und Umbenennen von Quelldateien die vormals erstellten Dateien entweder gelöscht oder verschoben werden sollten.



FORMATANFORDERUNGEN DER QUELLDATEIEN

Der Titel eines Eintrags muss für die korrekte Formatierung in einer Zeile und zwischen den Tags
<titel> ... </titel>
sein. Dabei kann der Titel frei vom Dateinamen gewählt werden. Es ist empfehlenswert für eine einfache Zuordenbarkeit den Dateinamen ähnlich wie den Titel zu wählen. Um Probleme beim Verlinken zu vermeiden, sollte auf Umlaute und Leerzeichen innerhalb des Dateinamens verzichtet werden. Die Quelldateien selbst müssen im UTF-8 Format vorliegen, da eine andere Kodierung eine falsche Darstellung von Umlauten zur Folge haben wird. Leerzeichen sollten funktionieren, sind aber für eine bessere Browserkompatibilität zu vermeiden.

Das Datum muss in einer Zeile und zwischen den Tags
<datum> ... </datum>
stehen. Das Format dafür muss TT.MM.JJJJ sein.

Schlagwörter, die Einträge miteinander verlinken, müssen ebenfalls in einer Zeile und zwischen den Tags
<schlagwoerter> ...</schlagwoerter>
stehen. Dabei können beliebig viele Schlagwörter definiert werden (empfehlenswert sind 2-5). Mehrere Schlagwörter sind durch genau ein Komma und ein Leerzeichen zu trennen (", ").

Der (Haupt-)text eines Eintrags muss sich zwischen den Tags
<inhalt>
...
</inhalt>

befinden und kann nach Belieben in HTML formatiert werden. Dabei müssen die inhalt-Tags alleine in einer Zeile stehen, da sonst Anfang/Ende des Inhalts abgeschnitten werden.

Falls Fussnoten verwendet werden sollen (nur im Inhaltsbereich möglich), dann muss der Inhalt einer Fussnote in einer Zeile und zwischen den Tags
<fussnote> ... </fussnote>
stehen. Die Tags mit dem Fussnotentext sind genau dort anzubringen, wo später die Zahl stehen soll, die auf die Fussnote verweist.

Um mehrere Fussnoten an einer einzigen Stelle zu erzeugen, ist (in der selben Zeile ohne Umbruch) einfach ein weiterer Fussnoten-Tag anzuhängen. Zwei oder mehr Fußnoten werden auch zusammengefasst, wenn lediglich ein Komma dazwischen steht
<fussnote> ... </fussnote>,<fussnote> ... </fussnote>



MANUELLE VERLINKUNGEN

Soll auf Dateien im Netz verlinkt werden (absolute Pfade mit http://... ), kann einfach die entsprechende Adresse verwendet werden. Für alle relativen Angaben/Links auf andere Einträge des Blogs, empfiehlt es sich die passende der drei folgenden Variablen zu wählen:
=__zu_den_eintraegen__= : wird vom Programm für jede Datei passend durch den Pfad zu den Einträgen ersetzt
=__zu_den_schlagwortern__= : wird ebenfalls für jede Datei durch den Pfad zu den Schlagwörtern ersetzt
=__zum_hauptverzeichnis__= : das gleiche für den Pfad zum Hauptverzeichnis.
Ein Verweis in einem Eintrag auf den Eintrag in der Datei mein-ziel.txt lautet entsprechend:
<a href="=__zu_den_eintraegen__=mein-ziel.html"> Es darf kein "\" oder "/" vor dem Dateinamen stehen und die Endung ist natürlich ".html". Mit der Variable =__zum_hauptverzeichnis__= ist es auch möglich, Dateien in einem beliebigen Unterordner zu verlinken. Wenn beispielsweise die Datei "muster.pdf" im Unterordner "dateien/vorlage/" (relativ zum Hauptverzeichnis) verlinkt werden soll, dann lautet der Link
<a href="=__zum_hauptverzeichnis__=dateien/vorlage/muster.pdf">



HTML VORLAGEN ANPASSEN

Natürlich kann mit Webdesign-Kenntnissen das Design beliebig angepasst werden. Änderungen am Layout können in der Datei "style.css" im www-Ordner vorgenommen werden. Im Ordner Beispiele sind die identischen Seiten mit zwei unterschiedlichen "style.css" Dateien zu finden, die beispielhaft zeigen, was man allein durch Austauschen dieser Dateien erreichen kann. Die html-Elemente und html-Struktur selbst können in den beiden Dateien "dateianfang.txt" und "dateiende.txt" angepasst werden. Für das dritte Beispiel wurden der Stil und die Vorlagedateien "dateianfang.txt" und "dateiende.txt" minimal verändert. Dabei können die Vorlagedateien nach Belieben angepasst/ersetzt werden. Wichtig (für Layout und Stil) ist nur zu wissen, dass vom Programm
<div class="eintrag"> ... </div>
Elemente für jeden Eintrag erstellt werden (die man nur im Quellcode des Programmes ändern kann). Diese Ebenen haben jeweils folgende drei Unterebenen:
<div class="eintrag">
   <div class="ueberschrift">
Hier gehen formatierter Titel und Datum der Quelldateien hin</div>
   <div class="text">
Hier steht der Eintrag (Text zwischen <inhalt> und </inhalt>)</div>
   <div class="anhang">
Hier werden die formatierten Schlagworte eingefügt</div>
</div>



WEITERE MÖGLICHKEITEN

Es ist auch möglich, ohne besondere Programmierkenntnisse (aber mit einem Kompiler) folgende Einstellungen im Quellcode (aktuell Zeile 37 bis 55) zu ändern:
- die Anzahl der (neusten) Einträge, die auf den index-Seiten angezeigt werden sollen (Standard: 5)
- ob in der Übersichtsliste bei den Schlagwörtern die Anzahl der vorhandenen Einträge zu den Schlagwörtern (Werte in Klammern) angezeigt werden sollen (Standard) oder nicht.
- die Namen der Ordner zu den Quelldateien/für die Ausgabe.
Anschließend muss aber das Programm (neu) kompiliert werden. Einfacher wäre das natürlich durch eine Konfigurationsdatei, die während dem Ausführen des Programmes eingelesen wird, aber das ist nicht implementiert worden.



HAFTUNG

Auch wenn das Programm nach besten Wissen und Gewissen erstellt wurde, kann und wird keine Garantie für das Programm und dessen Funktionsweise übernommen. Das Herunterladen und Ausführen geschieht auf eigene Gefahr.



VERWENDUNG/RECHTLICHES

Das Programm ist unter der Creative Commons BY-3.0 Lizenz veröffentlicht. Die Lizenz findet sich hier und eine Kurzform kann hier eingesehen werden. Damit darf das Programm (oder Teile davon) nach Belieben kopiert, verändert, veröffentlicht und verkauft werden, solange eine Namensnennung des Autors erfolgt. Positive Rückmeldungen und konstruktive Kritik sind willkommen.



DOWNLOAD

Im Archiv befinden sich drei Beispiele, diese Bedienungshinweise in reiner Textform, eine für Windows (32bit) kompilierte Version, eine Version für Linux (64bit) und der C++-Quellcode.


Version: 02.07.2013

Blogvorlage (zip)

© 2010-2016 Dominik Zobel <dominik.zobel@tu-harburg.de>

Creative Commons BY License Die aufgelisteten Ausarbeitungen und Skripte sind unter dieser Creative Commons BY 3.0 Lizenz ( Kurzform ) lizenziert.

Valid XHTML 1.0 Strict