Dokumentation fotoindex


Version 3.0 - Februar 2007



NAME

bildindex - erstellt eine Fotoalbum-Seite im html-Format


SYNOPSIS

fotoindex # -q -clean -help -dir directory -rename -cont -big -norm -view -version|-v -long -short -tab -bibl -style stylename -appendicons directory -withoutorig -namesort -numsort ## -overwiew [directory] -viewstyles [directory]


VORAUSSETZUNGEN

Auf dem Rechner muessen Perl und das Programmpaket Image-Magick installiert sein.


BESCHREIBUNG

Erstellt eine Fotoalbumseite im HTML-Format. Das Programm sucht alle Bilder in einem Verzeichnis erstellt im Unterverzeichnis thumbnails verkleinerte Bilder, mit denen eine Tabelle in HTML erstellt wird. Die Groesse dieser Thumbnails haengt von der waehl- baren Zahl der Bilder pro Zeile ab. Zusaetzlich werden im Ver- zeichnis mid_size Bilder im Format 600x800 Pixel erstellt. In das File legende.txt wird fuer jedes Bild ein Datensatz eingetragen. Die Datei legende.txt kann editiert werden und jedem Bild eine Bildunterschrift, ein Kommentar und eine Anwei- sung zum ev. Drehen des Bildes zugeordnet werden. Bei erneutem Aufruf von bildindex wird die Bildunterschrift in die HTML- Tabelle eingetragen und die Drehungen ausgefuehrt.

Mit der Option -rename koennen alle Bilder umbenannt werden. der neue Name setzt sich zusammen aus einem Basisnamen und einer laufenden Nummer.

Mit der Option -subdirs wird das Programm statt in dem aktuellen Verzeichnis in allen Sub-Verzeichnissen des aktuellen Verzeichnisses ausgefuehrt. Die Option -rename kann in diesem Fall durch die Zusatzoption -cont veranlasst werden die laufenden Nummern im Dateinamen ueber die Verzeichnisse durchgehend zu machen.


Aenderungen und Neuaufruf

Alle Parameter, die den Aufbau der html-Seite betreffen werden in der Datei legende.txt gespeichert und muessen bei einem Neuaufruf des Programms nur dann in der Kommandozeile neu eingegeben werden, wenn eine Aenderung gewuenscht ist.


AUFBAU VON legende.txt

Im Kopf von legende.txt koennen die folgenden Angaben eingetragen werden:


Titel

Titel der Albumseite


Titelbild

Bild fuer die Gestaltung eines Albums


Prolog

Text unter dem Titel, Beschreibung der Seite


Basisname

Name der Bilder fuer die rename-Funktion


Erste_Nr

Startnummer fuer die rename-Funktion


Prolog

Laufender Text, der auf der HTML-Seite zwischen Titel und Bildern eingefuegt wird. Endet mit zwei Leerzeilen.

Zu jedem gefundenen Bild wird eine Abschnitt in legende.txt angelegt, der die folgenden Felder enthaelt:


Name

Name der Datei


Sortno

Frei waehlbare Nummer fuer das Sortieren im Modus numsort Die Anfangsnummerierung richetet sich nach der Sortierung nach Bildnamen.


Datum Aufnahme

Datum und Uhrzeit der Aufnahme (aus Exif-Daten)


Inhalt

Bildunterschrift


Drehen

Drehwinkel beim naechsten Aufruf von bildindex


Kommentar

beliebiger, auch mehrzeiliger Kommentar, endet mit Leerzeile


Bibl

Optional, nur mit Kommandozeilenoption -bibl. Beliebige bibliografische Angaben fuer die Nutzung durch andere Programme


Verschiebungen

Ein Bild kann in der Reihenfolge verschoben werden, indem man hinter den Dateinamen nach '>>' die neue Position schreibt.

BEISPIEL:

Name : ferien2003-0034.jpg >> 25a

ordnet beim naechsten Aufruf von bildindex das Bild 34 hinter Bild 25 ein. mit -rename wird anschliesend neu durchnummeriert und 25a wird zu 26 etc.


Subtitel

Zwischen zwei Datensaetzen kann ein Subtitel eingefuegt werden mit der Syntax: Subtitel : <Text des Titels>

Statt Subtitel wird auch Subtitle oder Untertitel (gross- oder kleingeschrieben richtig erkannt. Die Tabelle wird an dieser Stelle unterbrochen, der Subtitel ausgegeben und danach mit einer neuen Tabelle fortgesetzt. Es muessen zwischen der letzten Zeile des vorhergehenden Kommentars und der Subtitel-Zeile mindestens 2 Leerzeilen und zum nechsten Name-Zeile mindestens eine Leerzeile eingefuegt sein.


Kommandozeilenparameter


-version|-v

Zeigt Version, Datum/Uhrzeit der letzten Aenderung


-dir <directory>

fotoindex wird in dem oder den angegeben Verzeichnissen ausgefuehrt. Bei Angabe von Wildcards '*' oder '?' ist die Angabe des Directory in Hochkommas zu setzen.


-big

Midsize-Bilder werden 1024x768 Pixel


-rename

Sortiert zuerst die mit >> zu verschiebenden Bilder um und benennt alle Dateien um entsprechend der Angaben den Feldern Basisname und Erste_Nr. Wirkt sich nur im Sortmode namesort (siehe -namesort) auf die Reihenfolge der Bilder im index.html aus..


-logrename

wie rename, schreibt aber den alten Namen der Datei ins entsprechende bibl-Feld


-cont

Nur zusammen mit -rename und -dir wirksam. Die Bilder aller relevanten Directories werden beginnend mit den Angaben im legende.txt durchgehend einheitlich benannt und durchnummeriert.


-norm

Midsize-Bilder werden 800x600 Pixel


-bibl

Im legende.txt wird im Datensatz fuer jedes Bild eine zusaetzliche Zeile bibl : eingefuegt. Hier koennen zusaetzliche (bibliografische) Angaben eingetragen wer- den, die durch andere Programme ausgewertet werden koennen.


-long

Alle Thumbnail-Bilder zwischen zwei Untertiteln werden in einer Zeile angeordnet, anstatt in einer Tabelle


-tab|-short

Setzt long wieder zurueck, die Ausgabe erfolgt in Tabellenform


-style <stylename>

Wahl der Farben (Hintergundbilder). Einige Styles sind eingerichtet. Einige Styles sind fest im Script eingebaut. Wird das File fistyles.conf gefunden, werden von dort weitere Styles eingelesen. Name und Pfad des conf-Files koennen in der Variablen $confile geaendert werden. Um das Einrichten eigener Styles zu erleichtern existiert der Style test, in dem durch eindeutige und unterscheidbare Farben die Zuordnung deutlich wird. Mit fotoindex -help werden alle verfuegbaren Styles angezeigt. Weitere Backgroundbilder die im fistyles.conf verwendet werden, koennen nach Eintrag im Script (in der Liste backpictures) mit fotoindex -appendicons dir in den __DATA__ Teil eingelesen, d.h. zugefuegt werden. Beim Erstellen der HTML-Gallerie index.html werden sie ins midsize-Directory kopiert. Man kann die Bilder aber auch direkt im midsize-Directory ablegen.


-overview <directory> oder -viewstyles <directory>

Erzeugt ein html-File im angegebenen directory mit einer Uebersicht ueber alle verfuegbaren Styles. Muster der Hintergrundbilder bzw. -farben, den Namen der zugehoerigen Styles und Namen der Bilder werden in einer Tabelle erzeugt. Die entsprechenden Angaben werden aus dem fistyles.conf gelesen. Die Groesse er Darstellung kann durch die Angabe einer Zahl in der Befehlszeile (Anzahl Bilder pro Zeile, default ist 8) gewaehlt werden. Es wird empfohle eines neues Directory zu waehlen, um es nach Gebrauch einfach wieder loeschen zu koennen. Falls es noch nicht exustiert, wird es automatsch angelegt (default ist ./fotoindex_overview/)


-clean

Loescht alle durch fotoindex erzeugten Files mit Ausnahme von legende.txt, welches statt geloescht zu werden nur umbenannt wird.


-appendicons <directory>

Die Bilder fuer die verschiedenen Buttons und den Hintergrund werden aus dem Directory in den __DATA__ Teil des Scripts kopiert und vorher uuencoded. Die Namen der Bilddateien muessen im Feld backpictures bzw buna eingetragen sein.


-writeicons

Die Bilder im DATA-Teil werden im entsprechenden Bildformat ins aktuelle Directory geschrieben. Dazu wird der Programmteil ohne Bilder ebenfalls dort abgelegt. So koennen alle Bilder (oder einige davon) ausgetauscht werden und an- schliessen mit -appendicons wieder an den Programmteil angehaengt werden. Bei Namensaenderungen sind diese ins Feld backpictures bzw buna einzutragen.


-withoutorig|-woo

Es werden keine Links zu den Originalbildern angelegt. Damit werden nach der Erzeugung der Files die Originalbilder nicht mehr gebraucht, die wegen ihrer Groesse oft nicht sinnvoll sind auf einer WWW-Seite. Dieses Feature wird nicht gespeichert, muss also bei jedem Aufruf eingegeben werden!


-movie

mpeg und avi Files werden ebenfalls erfasst. Bei der Anzeige werden sie ueber den Browser abgespielt.


-namesort

Die Bilder werden im index.html nach ihrem Dateinamen alphabetisch sortiert angeordnet.


-numsort [#]

Die Bilder werden entsprechend ihrem Eintrag im Feld Sortno in der Datei legende.txt angeordnet. Eine Aenderung der Reihenfolge kann durch editieren des Feldes Sortno erreicht werden. Bilder mit gleicher sortno werden alphabetisch nach Dateinamen sortiert. Die sortno des ersten Bildes kann in der Kommandozeile hinter -numsort angegeben werden (Default ist 1). Zum Einfuegen von Bilder koennen Dezimalzahlen im Feld Sortno eingetragen werden. Bei jedem Programmstart wird durch ein renumber auf durchgehende ganzzahlige Werte beginnend mit der Startnummer korrigiert.


-nocss|-css

Fuer das scrollen der thumbnail-Tablle und den feststehenden Hintergrund werden ccs-style-Tags benutzt. Falls der zu benutzende Browser diese nicht beherscht koennen die features mit -nocss abgeschaltet werden.


-exif|-noexif

Die Exif-Informationen der jpg-Bilder wird gelesen und in einem HTML-File im Directory midsize fuer jedes Bild abgelegt. In der mid-size-Darstellung erscheint ein Link ``EXIF'' der die Exif Daten anzeigt. Fuer diese Funktion muss einer der Exif-Reader, die im Array @exifreaders stehen installiert sein. Empfohlen wird exif (Debian: apt-get install exif)


Author: Rudolf Strub <rudolf@strub.org>