Author: Stefan Spaeth
Description: Beschreibung der Optionen für createPhotoWebPages.pl

# createPhotoWebPages.pl - Optionen

zurück zur Hauptseite

createPhotoWebPages.pl verfügt über eine ganze Reihe von Optionen. Sie steuern im Wesentlichen den script-Ablauf, und weniger das tatsächliche Aussehen der HTML-Seiten.

Die Optionen lassen sich in Gruppen einteilen:

- Allgemeine Optionen
- Programm-Optionen
- Sortier-Optionen
- Umbenennungs-Optionen

## Aufruf von createPhotoWebPages.pl

Das script wird wie folgt aufgerufen:
`createPhotoWebPages.pl [Optionen] Konfigurationsdateiname [Pfad-Namen]`
"Konfigurationsdateiname" ist der Name der Konfigurationsdatei. Die "Pfad-Namen" werden nur bei Angabe der "-scan"-Option benötigt und werden in allen anderen Fällen als Eingabefehler betrachtet.

Die Optionen werden in den folgenden Abschnitten genauer erläutert. Man beachte, daß es eine Langform und eine aus einem Buchstaben bestehende Kurzform für jede Option gibt.

## Allgemeine Optionen

Hierzu zählen alle Optionen die immer angegeben werden können (auch wenn sie nicht immer etwas bewirken müssen ;-).

- -verbose
  -v
  Diese Option bewirkt, daß auch Info-Meldungen und Warnungen in jedem Fall auf die Konsole gedruckt werden. In der Grundeinstellung werden nur allgemeine Hinweise und Fehlermeldungen auf die Konsole ausgegeben. In jedem Fall werden alle Meldungen in der Log-Datei abgelegt. Die Log-Datei hat den gleichen Namen wie die Konfigurationsdatei, aber mit angehängter Dateiendung ".log". Sie wird im gleichen Verzeichnis wie die Konfigurationsdatei abgelegt.
- -help
  -h
  Diese Option bewirkt die Anzeige einer Hilfeseite. Danach wird das script ohne weitere Aktion beendet.
- -force
  -f
  Diese Option dient dazu den Überschreibe-Modus für erzeugte Bilder und zugehörige HTML-Seiten zu aktivieren. In der Grundeinstellung werden diese Dateien nur neu erzeugt. Diese Dateien werden nicht überschrieben wenn sie schon existieren. Gleiches gilt für eine eventuell vorhandene "CSS-Stylesheet"-Datei.
  Man beachte, daß die Thumbnail-HTML-Seiten genauso wie die Log-Datei, oder die Konfigurationsdatei in jedem Fall bei Bedarf überschrieben werden.
  Bei bestimmten Aktionen, wie zum Beispiel Dateinamensänderung oder Drehen eines Bildes, wird automatisch der Überschreibe-Modus aktiviert.
  Die "-force"-Option sollte benutzt werden um alle Bilder oder HTML-Seiten neu zu erzeugen. Dies ist zum Beispiel für HTML-Seiten sinnvoll, wenn sich Textkommentare zum Bild geändert haben. Bei Bildern ist die Option zum Beispiel dann sinnvoll, wenn sich der Inhalt des Originalbildes geändert hat.
  Die Option sollte sinnvollerweise mit "-images" oder "-html" kombiniert werden.
- -write
  -w
  Diese Option erzwingt ein Neuschreiben der Konfigurationsdatei. Normalerweise wird die Datei nur bei Angabe der Optionen "-scan" oder "-rename" geschrieben. Die Konfigurationsdatei wird in jedem Fall ohne weitere Nachfrage überschrieben.

## Programm-Optionen

Dies sind die Haupt-Optionen die den Arbeitsmodus des scripts einstellen. Es können mehrere Optionen gleichzeitig angegeben werden. Ist keine dieser Optionen angegeben, so wird automatisch "-images -html" als Grundeinstellung angenommen.

- -scan
  -s
  Diese Option aktiviert den Scan- oder Bildersuch-Modus. Er wird benutzt um Dateien und Verzeichnisse nach Bildern abzusuchen und anschließend eine Konfigurationsdatei zu schreiben. In diesem Modus werden in der Grundeinstellung keine Bilder und HTML-Dateien erzeugt. Mit der "-images" und/oder "-html" Option kann dies aber erzwungen werden. Ist die "-rename" Option aktiv, so wird zusätzlich (wenn nötig) noch ein Umbenennen der Originalbilddateien vorgenommen.
  Die Sortier-Option "-order" kann ausschließlich zusammen mit der "-scan" Option verwendet werden.
- -rename
  -r
  Die Rename-Option hilft bei der Umbenennung von Bilddateien. Sie sorgt dafür, daß neben der Originaldatei auch die bereits vorhandenen abgeleiteten Dateien auf den aktuellen Stand gebracht werden. Die Grundfunktion besteht darin den Dateinamen des Originalbildes an den Text des "IMAGE_NAME" Eintrages anzupassen. Hierzu existieren zusätzlich einige konfigurierbare Regeln die in einer separaten Regel-Seite erläutert werden.
  Zwei Zusatzoptionen (die weiter unten erklärt werden, siehe Umbenennungs-Optionen) helfen bei zudem beim Anfügen von Prefix-Bestandteilen und bei der Konvertierung der Dateinamensendung von Großbuchstaben in Kleinbuchstaben.
- -html
  -t
  Diese Option kann benutzt werden wenn man die Erzeugung von HTML-Seiten explizit aktivieren will. Ist dann nicht gleichzeitig die "-images" Option gesetzt so werden keine Bilder erzeugt. Soll die Erzeugung von HTML-Dateien erzwungen werden muss gleichzeitig die "-force" Option gesetzt sein.
  Im Bilder-Suchmodus ("-scan" Option) muss diese Option gesetzt sein wenn man HTML-Seiten erzeugen will.
- -images
  -image
  -i
  Diese Option kann benutzt werden wenn man die Erzeugung von Bildern explizit aktivieren will. Ist dann nicht gleichzeitig die "-html" Option gesetzt so werden keine HTML-Seiten erzeugt. Soll die Erzeugung von Bildern erzwungen werden muss gleichzeitig die "-force" Option gesetzt sein.
  Im Bilder-Suchmodus ("-scan" Option) muss diese Option gesetzt sein wenn man Bilder erzeugen will.

Alle folgenden Optionen kann man nur in Kombination mit bestimmten Hauptoptionen nutzen.

## Sortier-Optionen

Die Sortier-Option funktioniert nur in Verbindung mit dem Bilder-Suchmodus ("-scan" Option). Wird keine Sortier-Option angegeben, so gilt die Reihenfolge in der die Bilddateien gesucht und gefunden werden.

- -order name
  -order date
  -o name
  -o date
  Es stehen zwei Sortier-Varianten zur Auswahl. "name", alphabetisch sortiert nach Bilddatei- und oder Pfadnamen, oder "date", nach Bildaufnahme-Datum.
  Die "name" Variante funktioniert immer, wähend die "date"-Variante vorhandene Datums-Information voraussetzt.
  Die "date" Variante setzt Bilddateien im JPEG-Format voraus. Es wird die EXIF-Zusatzinformation der JPEG Bildatei ausgewertet. Wenn vorhanden wird für das Sortieren der "Date/Time" Eintrag verwendet. Oftmals ist kein brauchbarer EXIF-Eintrag mehr vorhanden. Dann schlägt diese Sortier-Variante fehl. Die "date" Variante sollte deshalb nur wenn notwendig benutzt werden.

Hinweis:
Wenn Bilder der Digitalkamera direkt nach dem Herunterladen verarbeitet werden so reicht zumeist die "name" Variante. Die von der Kamera vergebenen Namen ergeben alphabetisch sortiert ohnehin die korrekte zeitliche Reihenfolge.
Stellt man aber später, womöglich nach dem Umbenennen von Dateien, Bilder aus verschiedenen Bildserien zusammen kann es interessant sein die "date" Variante einzusetzen. Voraussetzung ist aber immer das Vorhandensein korrekter EXIF-Einträge.
Die Verwendung von "date" setzt das Hilfsprogramm "jhead" voraus.

## Umbenennungs-Optionen

Die Umbenennungs-Optionen funktionieren nur in Verbindung mit dem Umbenennungs-Modus ("-rename" Option). Für die Prefix-Option ("-prefix") ist zusätzlich auch der Bilder-Suchmodus ("-scan" Option) möglich.

- -prefix
  -p
  Diese sehr nützliche Option stellt sicher daß sich die Bilddateien auch noch nach der Vergabe von sinnvollen Namen alphabetisch sortieren lassen. Es wird einfach ein alphabetischer zwei Zeichen langer Vorspann mit zusätzlichem Unterstrich jedem Bilddateinamen vorangestellt. Der Vorspann wird wie folgt gebildet:
  `aa_, ab_, ac_, ..., az_, ba_, ..., zy_, zz_, aa_`
  Wie man erkennen kann lassen sich so nur 26x26=676 Dateien zweifelsfrei sortieren. Sind diese aber auf mehrere Verzeichnisse verteilt, stellt das in der Praxis selten ein Problem dar.
  Wird später ein Rename-Lauf durchgeführt, so bleibt der Vorspann immer erhalten (siehe auch IMG_NAME_NO_ALPHA_PREFIX Eintrag).
  Kombiniert man die Option "-rename" mit der Option "-prefix", ohne im Scan mode zu sein, so wird im Rename-Lauf ein neuer Prefix erzeugt. Die Reihenfolge ergibt sich hierbei aus der Reihenfolge der Bilder innerhalb der Konfigurationsdatei. Die Kombination sollte mit Vorsicht angewendet werden, da die ursprünglich vom Prefix vorgegebene Reihenfolge zerstört wird.
- -extension
  -ext
  -e
  Mit dieser Option können sehr schnell mit Großbuchstaben geschriebene Dateiendungen (z.B. ".JPG" statt ".jpg ") in Kleinbuchstaben umgewandelt werden. Großbuchstaben werden häufig in der Kamera verwendet oder entstehen beim Kopieren unter Windows-Betriebssystemen.

zurück nach oben, zurück zur Hauptseite