Static Blog

Was ist Static Blog?

Static Blog erstellt statische HTML-Seiten, sowie RSS 2.0- und Atom-Feeds. Es muss kein CGI-Programm auf dem Web-Server installiert werden.

Achtung: Static Blog ist keine ausführliche getestete Software, es kann durchaus zu fehlerhaften Einträgen, Abstürzen, gelöschten Daten oder anderen Fehlern kommen.

Static Blog benutzen

Laden sie Static Blog Version 0.1 hier herunter.
Entpacken sie es mit tar xjf staticblog-0.1.tar.bz2 in ein Verzeichnis ihrer Wahl.

An staticblog können folgende Parameter übergeben werden:

--content-directory=PFAD, -c PFAD

Gibt an in welchem Verzeichnis die Blog-Daten liegen.

Standardwert: Es wird das Arbeitsverzeichnis verwendet.

--destination-directory=PFAD, -c PFAD

Gibt das Verzeichnis an in dem die statischen Seiten generiert werden sollen.

Standardwert: dest

Blog erstellen

Das Blog-Verzeichnis, dass mit --content-directory angegben wird, enthält alle Informationen aus dem die Seiten erzeugt werden. Die einzelnen Verzeichnisse in denen die Einträge abgelegt wurden werden auf Kategorien abgegbildet. In jeder Kategorie können alle Einstellungen der Eltern-Kategorie wiederum überschrieben werden.

Eine Static Blog-Kategorie verwendet folgende Dateien:

*.flavour

Beinhaltet alle Informationen für die jeweiligen Ausgabeformate. Kann in jeder Kategorie vorkommen. Die erzeugten Dateien erhalten als Endung den Namen des Flavours. Mit folgenden Dateien kann die Ausgabe gesteuert werden:

index.kid

Wird verwendet um die Index-Datein zu erstellen.

entry.kid

Wird verwendet um die Seiten für einzelne Einträge zu erstellen. Dieses Template ist optional

config

INI-Datei die nur die Sektion [flavour] enthält, mit folgenden Einträgen:

content_type: Der MIME-Type für das Ausgabeformat.
serializer: Der Ausgabeserializer, entweder xml oder html.
title: Name des Formats. Wird hauptsächlich für die Links der HTML Seiten verwendet.
index_size: Die maximale Anzahl der Einträge in einer Index-Datei.
all_entries: Wenn true, dann werden alle Einträge in einer Index-Datei angezeigt.

*.cat

Ein Verzeichnis, dass wiederum eine Unterkategorie enthält.

description.txt

Beschreibung für den Blog. Siehe: Format der Einträge.

*.html

Einträge im Blog. Siehe: Format der Einträge.

config

INI-Datei die alle Einstellungen und Metadaten für den Blog enthält. Nur im obersten Verzeichnis.

Einträge in der Sektion [metadata]:

author: Name des Blog-Autors.
email: E-Mail Adresse des Autors.
author_url: Homepage des Autors.
icon: Logo, Symbol oder Bild das den Blog representiert.
lang: Sprache des Blogs.
sitetitle: Titel der Homepage in dem der Blog eingebettet ist.
blogtitle: Titel des Blogs.
license: Lizensebedingungen.
license_href: Link auf die Lizensbedingungen.

Einträge in der Sektion [paths]:

base: Die Basis-URL der Homepage in die der Blog eingebettet ist.
blogbase: Die URL unter der der Blog relativ zur Homepage zu erreichen ist.
stylesheet: Verweis auf ein CSS-Stylesheet.

Format der Einträge

Die Enträge bestehen jeweils aus einem Titel, ein oder mehreren Zeilen Metadaten und dem eigentlichem Text. Beim Title und Text wird davon ausgegangen, dass sie in gültigem XHTML vorliegen. Die erste Zeile ist der Titel. Jede folgende Zeile die mit einem Lattenkreuz (#) beginnt wird als Metadatum aufgefasst, der Rest ist der eigentliche Eintrag.

Die Metadaten bestehen jeweils aus einem Wort, gefolgt von einem Doppelpunk (:) und den Metadaten. Es können alle Metadaten überschrieben werden, die auch in config angegeben werden können. Zusätzlich gibt es noch:

published: Datum im Format: YYYY-MM-TT HH:MM:SS ZONE. Gibt den Zeitpunkt der Erstveröffentlichung an.

Voraussetzungen

Folgende Software muss installiert sein:

Python: Static Blog ist in Python geschrieben und benötigt Version 2.4 oder höher. Ist die Version 2.4 installiert, so muss zusätzliche ElementTree installiert werden.
Kid: Ab Version 0.9.3 oder höher. Die statischen HTML-Seiten und Feeds werden aus Kid-Templates erzeugt.