blazeintro - eine Einführung in BlazeBlogger
$ blaze-init $ blaze-add $ blaze-make
Dieser Text soll eine erste knappe Einführung dazu sein, wie neuer Seiteninhalt kreiert wird, wie man ihn konfiguriert und hinzufügt und wie man statische Seiten aus dem BlazeBlogger Repository generiert.
Jedes der folgenden Kommandos ist ein einzelnes Hilfsprogramm. Die Kommandos können wahlweise in eine der beiden Formen angewendet werden - entweder blaze-command oder blaze command. In diesem Text wird einheitlich die erste Form verwendet, da es die am Besten portierbare ist.
Um ein neues Blog zu kreieren, muß zuerst ein Repository (Verzeichnis, Ordner) für die grundsätzlichen Blogdateien geschaffen werden. Dieser Ordner ist ein sogenanntes verstecktes Verzeichnis und muß .blaze benannt werden. In diesem Ordner legt BlazeBlogger die grundsätzlichen Dateien ab und generiert aus diesem Ordner die statischen Seiten. Will man mehrere Blogs mit BlazeBlogger generieren, ist für jedes Blog ein Ordner anzulegen, in dem dann jeweils als erstes das Repository (.blaze) geschaffen wird.
Da BlazeBlogger ein Kommandozeilen-Tool ist, findet alles weitere auf der Kommandozeile statt. Nach dem Wechsel in das Verzeichnis, in dem sich .blaze befindet, gibt man im Terminal folgenden Befehl ein, um ein neues Blog ins Leben zu rufen:
$ blaze-init
Falls bisher alles richtig gelaufen ist, kommt danach diese Meldung:
Created/recovered a BlazeBlogger repository in .blaze.
Wie man an dem Wort »recovered« erkennen kann, ist das Kommando auch später dazu verwendbar, das Repository in einen konsistenten Zustand zu bringen, wobei die übrigen Daten (z.B. Konfiguration, Blogartikel und Seiten) intakt bleiben. Es besteht aber auch die Möglichkeit, alle Dateien in den Ausgangszustand zu versetzen - indem man dem Kommando die Option --force mitgibt.
$ blaze-init --force
Obwohl die Grundeinstellungen (default) direkt einen Start zulassen, sollte man sich einige der Konfigurationen näher ansehen.
Da sämtliche Texte (Artikel, Seiten) mit einem externen Editor geschrieben werden, willst Du sicher den Editor Deiner Wahl nutzen und die Konfiguraton entsprechend anpassen. Ist kein Editor in der Konfigurationsdatei festgelegt, versucht BlazeBlooger den systemweit gesetzten EDITOR zu verwenden. Falls dies nicht funktioniert, wird vi aufgerufen. Um den Editor Deiner Wahl festzulegen (z.B. gedit), gibst Du folgenden Befehl ein:
$ blaze-config core.editor gedit
Was Du sicher auch anpassen willst, ist der Blog-Titel, der Blog-Subtitel und der Username:
$ blaze-config blog.title My Blog $ blaze-config blog.subtitle yet another blog $ blaze-config user.name Your Name
Falls zum Blog ein RSS Feed generiert werden soll (was BlazeBlogger macht), musst Du die Basis-URL des Blogs spezifizieren - z.B.:
$ blaze-config blog.url http://blog.example.com/
Schlußendlich - falls Du es im Terminal bunt haben willst, setzt Du noch folgende Optionen:
$ blaze-config color.list true $ blaze-config color.log true
Die komplette Liste der verfügbaren Optionen findest Du in der blaze-config(1) man page. Um zu sehen, welche Daten in der Konfigurationsdatei den einzelnen Optionen zugeordnet sind, gibst Du die Option ohne Wert ein:
$ blaze-config user.name
Du kannst auch die Konfigurationsdatei im Editor öffnen und dann alles in einem Durchgang anpassen:
$ blaze-config --edit
Um einen neuen Artikel hinzuzufügen, dient folgender Befehl:
$ blaze-add
Es startet der externe Editor in eine Datei, in der schon ein vorformatierter Header enthalten ist, an den sich der freie Raum für Deinen Text anschließt. Die meisten Headerzeilen enthalten Erklärungen. Einige wollen wir uns aber näher ansehen:
Der Titel des Artikels - ohne Titel - kein Artkel, oder?
Der Autor des Artikels. Der in der Konfigurationsdatei spezifizierte Username wird per Grundeinstellung gesetzt, kann aber geändert werden - nach freier Wahl. Was nicht sein darf - ein Semikolon im Namen!
Das Veröffentlichungsdatum des Artikels. Das Format ist YYYY-MM-DD (der 17. Juli 2009 würde so erscheinen: 2009-07-17 ). Per Grundeinstellung wird das Tagesdatum des Erstellungstages gesetzt, was aber überschreibbar ist.
Eine durch Kommas getrennte Liste von Kategorien, denen der Artikel zugeordnet werden soll. Eine Begrenzung der Anzahl der tags ist nur insoweit gegegebn, als sie nicht über eine Zeile hinausgehen dürfen. Sie dürfen ebenfalls kein Semikolon enthalten. Man kann diese Option auch leer lassen oder später füllen.
Hier geht es um die URL, die dem Artikel zugeordnet wird. Normalerweise gibt es hier nichts zu tun - bis auf zwei Fälle: (1) wenn der Titel spezielle Buchstaben oder Zeichen enthält (z.B. Umlaute), entfernt BlazeBlogger diese bei der Generierung der statischen Seiten, was dann vielleicht in der URL nicht gut aussieht oder (2) wenn eine abweichende URL gewünscht wird, weil der Titel vielleicht zu lang ist. Zu beachten ist, daß die URL nur aus alphanumerischen Zeichen, Bindestriche und Unterstriche bestehen soll.
Behalte dies im Kopf. Der erste Artikel sieht nach dem Start im Editor vielleicht so aus (Hinweis: Das häufig als Kommentarzeichen verwendete Zeichen # vor den Zeilen ist hier stehen zu lassen - auch vor den vorstehend besprochenen Zeilen):
# This and following lines beginning with `#' are the post header. # Please take your time and replace these options with desired val- # ues. Just remember that the date has to be in an YYYY-MM-DD form, # the tags is a comma separated list of categories the post (pages # ignore these) belong and the URL, if provided, should consist of # alphanumeric characters, hyphens and underscores only. Specifying # your own URL is especially recommended when you use non-ASCII cha- # racters in your post title. # # title: The Hobbit, or There and Back Again # author: David # date: 2009-07-17 # tags: childrens literature, fantasy # url: the-hobbit # # The header ends here. The rest is the content of your post. You # can use <!-- break --> to mark the end of the part to be displayed # on index page.
<p>“In a hole in the ground there lived a hobbit.” — these are the words that introduces us to the incredible world of nowadays classic Tolkien's novel. But what is so fascinating about it that generation after generation keep returning to its charms?</p>
<!-- break -->
<p><em>The Hobbit</em> is a story about Bilbo Baggins, a hobbit ...
Um einen relativen Pfad anzugeben, kann als Platzhalter %root% verwendet werden - in URLs und in Links zu Dateien oder Bildern - Beispiel:
<a href="%root%index.rss">RSS Feed</a>
Bist Du fertig mit dem Schreiben des Artikels, speichere ihn und schließ den Editor. Im Terminal kommt eine Bestätigung und die ID des neuen Artikels.
Schreibst Du die Artikel im voraus, kannst Du mehrere Dateien wie folgt hinzufügen, ohne den Editor zu öffnen:
$ blaze-add file1 file2 file3
Um einen existierenden Artikel zu editieren, z.B. den mit der ID-Nummer 3, gib folgendes Kommando ein:
$ blaze-edit 3
Soll dieser Arikel komplett entfernt werden, geht dies wie folgt:
$ blaze-remove 3
Beachte, dass das Programm unbarmherzig alles löscht - unwiderrufbar (ausser, Du hast ein Backup gemacht). Um sich vor versehentlichen Verlust von Daten zu schützen, kann im interaktiven Modus wie folgt gearbeitet: mit der Option
--interactive (oder knapper -i). Dann muß jede Löschung bestätigt werden.
Seiten sind der passende Platz für die Informationen, die von jeder Seite der Website schnell erreichbar sein sollen (z.B. About, Contact, Downloads, Themes). Man sollte die Anzahl knapp halten. Sie erscheinen im Basistheme als horizontales Menu unter dem Blogtitel.
Das hinzufügen und verwalten der Seiten, geht grundsätzlich wie bei den Artikeln. Dem Kommando wird lediglich folgende Option mitgegeben: --page (oder -p). Eine neue Seite kreieren sieht also so aus:
$ blaze-add --page
Anders als bei Artikeln, gibt es zu Seiten keine tags und auch der Autor oder das Datum wird nicht angezeigt.
Um eine existierende Seite (mit ID-Nummer 3) zu editieren, gibt man folgendes Kommando ein:
$ blaze-edit --page 3
Eine Seite mit der ID 2 zu entfernen, geht mit:
$ blaze-remove --page 2
Um alle Artikel im Repository aufzulisten (um z.B. nach einer ID zu suchen) gibt es folgendes Kommando:
$ blaze-list
Du kannst die Suche eingrenzen, indem Du ein Datum, den Autor oder tags mitgibst. Beispiel: Du suchst alle Artikel vom 19. Dezember 2008, geschrieben von David:
$ blaze-list --author admin --year 2008 --month 12 --day 19
Um in den Seiten zu suchen, fügst Du --pages hinzu:
$ blaze-list --pages
Um den statischen Inhalt (Artikel, Seiten) aus dem Repository in das Arbeitsverzeichnis zu generieren - mit allen Artikeln, Seiten, Archiven, tags und RSS Feed - dient folgender Befehl:
$ blaze-make
oder wenn auch eine Liste mit allen Dateien, die generiert wurden, angezeigt werden soll:
$ blaze-make --verbose
Das Ergebnis kannst Du auf Deinem Rechner im Browser testen und dann die Dateien auf den Server kopieren. Willst Du einen vollständigen Pfad generieren, um den off-line-Test zu erleichtern, gibt es diese Option:
$ blaze-make --full-paths
Ist die Website auf demselben Server, kann man mit folgenden Befehl eine direkte Generierung erreichen:
$ blaze-make --destdir ~/public_html
Für die komplette Liste aller Kommandos siehe die man page von blaze-make(1).
Signifikante Änderungen im Repository werden automatisch in einer Logdatei festgehalten - mit der Zeitangabe und dem, was passiert ist. Um diese Datei zu öffnen, dient folgender Befehl:
$ blaze-log
oder um Platz zu sparen:
$ blaze-log --short
Das Theme zu wechseln, ist eine einfache Sache. Die Datei für ein neues Theme findet sich im Menupunkt »Themes« auf der Projektseite. Nach dem Download muß sie entpackt werden. Willst Du z.B. das Theme »VectorLover« installieren:
$ tar xfz vectorlover-1.0.tar.gz
Öffne dann die Templatedatei, in diesem Fall vectorlover.html, in Deinem Editor und pass die Sidebarsektion Deinen Wünschen an und kopiere dann die Templatedatei und die korrespondierende CSS-Datei in die Verzeichnisse .blaze/theme/ bzw. .blaze/style/ - z.B. so:
$ mv vectorlover.html .blaze/theme/ $ mv vectorlover.css .blaze/style/
Zum Schluß ändere die Konfiguration wie folgt:
$ blaze-config blog.theme vectorlover.html $ blaze-config blog.style vectorlover.css
Anschließend ein blaze-make(1), um die statischen Seiten mit dem neuen Theme auszustatten.
Weitere Informationen - auch zur Generierung eines neuen Theme - finden sich auch hier in der blazetheme(7) man page.
Um die Blogsprache auf Deutsch umzustellen, kopiere die Datei de_DE in den .blaze/lang/ Ordner und ändere die Konfiguration:
$ blaze-config blog.lang de_DE
Nach einem erneuten blaze-make(1), sind alle generierten Dateien auf Deutsch umgestellt.
BlazeBlogger Konfiguration-Datei.
BlazeBlogger Repository log file.
BlazeBlogger themes directory.
BlazeBlogger stylesheets directory.
BlazeBlogger language files directory.
blaze-init(1), blaze-config(1), blaze-add(1), blaze-edit(1), blaze-remove(1), blaze-list(1), blaze-make(1), blaze-log(1).
Geschrieben von Jaromir Hradilek <jhradilek@gmail.com> (Übersetzung ins Deutsche von Hans Fährmann <BlazeBlogger.de>).
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included as a file called FDL in the main directory of the BlazeBlogger source package.