Technische Dokumentation Online-Shop 1 2 Allgemeines ____________________________________________________________ 2 1.1 Einsatzmöglichkeiten ______________________________________________________ 2 1.2 Voraussetzungen zur Installation ____________________________________________ 2 Katalog-File ____________________________________________________________ 2 2.1 Dateiformat ______________________________________________________________ 2 2.2 Definitionskopf ___________________________________________________________ 2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.2.10 2.2.11 2.2.12 2.2.13 2.2.14 2.2.15 2 2 2 2 2 2 3 3 3 3 3 3 3 3 3 2.3 Definieren der Navigation __________________________________________________ 3 2.4 Produkte definieren _______________________________________________________ 3 2.4.1 2.5 3 Email_fuer_Bestellung _________________________________________________________ Mailprogramm________________________________________________________________ Hintergrundfarbe ______________________________________________________________ Schriftart ____________________________________________________________________ Schriftfarbe __________________________________________________________________ NavigationZwischenraum _______________________________________________________ Ueberschriftsfarbe _____________________________________________________________ Tabellenfarben________________________________________________________________ Zielfenster ___________________________________________________________________ Programmquelle ______________________________________________________________ Quelle_fuer_Grafiken __________________________________________________________ Waehrung ___________________________________________________________________ Unterzeile ___________________________________________________________________ Abschied ____________________________________________________________________ heading _____________________________________________________________________ Thumbnail in Produkttabelle darstellen _____________________________________________ 4 Bestellung per Email _______________________________________________________ 4 Verbesserungen, Updates, Fehlerbeseitigung _________________________________ 4 Ronald Haase Postfach 600 346 10253 Berlin Email [email protected] Internet www.Haa.de 1 Allgemeines 1.1 Einsatzmöglichkeiten Der hier behandelte Online-Shop ist für die Präsentation und den Verkauf von Produkten jeder Art über das Internet gedacht. Die Produkte können in beliebig vielen Untergruppen dem Kunden in Tabellenform vorgestellt werden. Dabei kann z.B. in einer Produkttabelle für jedes Produkt ein sog. Thumbnail erscheinen und zusätzlich kann der Benutzer sich vom interessierenden Produkt eine Großansicht anzeigen lassen. Um ein Produkt unverbindlich vorzumerken steht ein entsprechender Button zur Verfügung. Das gewählte Produkt wird nur auf der Festplatte des Benutzers gespeichert und später, wenn das Bestellformular aufgerufen wird, in selbiges eingetragen. Für die Bestellung steht eine Funktion zur automatischen Generierung eines Bestellformulars zur Verfügung. Dieses wird dann vom Server, auf dem der Online-Shop installiert ist, per Email verschickt. 1.2 Voraussetzungen zur Installation Für den Betrieb des Online-Shops muß auf dem Server Perl 5 installiert sein. Das Perl-Script und die Katalogdatei müssen in ein Verzeichnis kopiert werden, in dem die Ausführung von Programmen zulässig ist (i.A. cgi-bin). Das Perl-Script und die Katalog-Datei müssen den gleichen Namen haben, sie werden lediglich durch ihre Endungen unterschieden (z.B. shop.pl und shop.txt). Die Endungen pl und txt sind feststehend. Das Perl-Script sollte mit den Rechten 555 und der Katalog mit 444 eingerichtet werden. 2 Katalog-File 2.1 Dateiformat Das Dateiformat ist eine ASCII-Tabelle. Am einfachsten ist diese mit Microsoft Excel zu erstellen, wenn diese als ASCII mit Tab (09h) als Trennzeichen abgespeichert wird. Dabei ist es egal, ob als Zeilenumbruch ein 0dh 0ah (DOS/Windows) oder nur ein 0ah (Unix) vorhanden ist. 2.2 Definitionskopf 2.2.1 Email_fuer_Bestellung Hier wird die Emailadresse eingetragen, an welche vom Server, auf dem der Online-Shop läuft, die Bestellung verschickt wird. Beispiel [email protected] 2.2.2 Mailprogramm Hier wird das vom Server verwendete Programm für die Versendung von Emails angegeben. Zusätzlich ist es erforderlich, die Option zum Öffnen des Programms zum Senden anzugeben. Beispiel: /usr/sbin/sendmail -t 2.2.3 Hintergrundfarbe Hier wird die Hintergrundfarbe für alle vom Online-Shop generierten HTML-Seiten angegeben. Die Angabe erfolgt hexadezimal als RGB-Farbe, der Wertebereich liegt also zwischen 000000 und FFFFFF. Der Wert darf nicht in Anführungszeichen stehen und nicht von einem Doppelkreuz angeführt werden. Beispiel: 0080ff (für hellblau) 2.2.4 Schriftart Die Schriftart, die für den Katalog verwendet werden soll, wird hier angegeben. Optional können durch Kommata weitere Schriftarten angegeben werden, die für die Darstellung der HTML-Seiten benutzt werden, wenn in dieser Aufzählung weiter vorn stehende Schriften auf dem Zielsystem nicht verfügbr sind. Durch ein Semikolon getrennt wird am Ende die Schriftgröße angegeben. Beispiel: Verdana,Arial,Helvetica;2 2.2.5 Schriftfarbe Hier wird die Schriftfarbe für alle vom Online-Shop generierten HTML-Seiten angegeben. Weiteres siehe Punkt 2.2.3. Beispiel 000000 (für schwarz) 2.2.6 NavigationZwischenraum Hier wird angegeben, was im Navigationsfenster zwischen den einzelnen Textzeilen bzw. Grafiken angezeigt werden soll. Das Programm erkennt automatisch ob es sich um Text oder um eine Grafik handelt und benutzt entsprechend die erste oder die zweite Angabe, welche durch ein Komma getrennt wird. Wenn eine Grafik als Zwischenraum angegeben wird, dann muß diese Grafik in dem Verzeichnis gespeichert sein, welches unter Quelle_fuer_Grafiken (siehe Punkt 2.2.11) angegeben wurde. Beispiel: <br>;leer.gif (für Leerzeile nach Text und Grafikdatei nach Grafiken zur Navigation) 2.2.7 Ueberschriftsfarbe Hier wird die Farbe des Kopfes der Produkttabellen angegeben. Weiteres siehe Punkt 2.2.3. Beispiel ffff00 (für gelb) 2.2.8 Tabellenfarben In den Produkttabellen kann jede Zeile abwechselnd farbig hinterlegt werden. Dies kann die Übersichtlichkeit innerhalb der Tabelle erhöhen. Die zwei dafür vorgesehenen Farben werden durch ein Semikolon getrennt angegeben. Weiteres siehe Punkt 2.2.3. Soll diese Funktion nicht benutzt werden, so werden beide Werte gleich der Hintergrundfarbe gesetzt. Beispiel: c0c0c0;ffffff (für abwechselnd grau/weiß) 2.2.9 Zielfenster Der Online-Shop wird normalerweise in einem Frameset dargestellt. Hier wird angegeben, in welchem Frame (Fenster) die Produkttabelle dargestellt werden soll. Im Normalfall wird das das größte Frame sein, da die Tabelle den meisten Platz beansprucht. Beispiel: haupt 2.2.10 Programmquelle Hier wird die absolute Position des Online-Shops im Internet angegeben. Beispiel: http://www.haa.de/cgi-bin/shop.pl 2.2.11 Quelle_fuer_Grafiken Hier wird das Verzeichnis angegeben, in dem alle vom Programm verwendeten Grafiken (außer Produktbilder) gespeichert sind. Beispiel: http://www.haa.de/lt/html/images/ 2.2.12 Waehrung Hier wird die Währung angegeben, die für den Katalog gilt und die in der Bestellung angezeigt wird. Beispiel: DM 2.2.13 Unterzeile Der hier eingegebene Text wird unter jeder Produkttabelle und auf der Bestellung angezeigt. Der Text kann mit Hilfe von HTML-Tags frei formatiert und Grafiken können eingebunden werden. Beispiel: <i>Bitte beachten Sie unsere AGB.</i> 2.2.14 Abschied Der hier eingegebene Text wird auf einer Seite angezeigt, die nach dem Absenden der Bestellung erscheint. Es gilt das gleiche wie unter Punkt 2.2.13 bereits erwähnt. 2.2.15 heading Hier werden die Spaltenüberschriften der Produkttabelle definiert. Einige Spalten sind frei definierbar (siehe Punkt 2.4). 2.3 Definieren der Navigation Im derzeitigen Entwicklungsstand hat die Navigation fest zwei Ebenen. Diese werden im Katalog mit level1: bzw level2: gekennzeichnet und werden direkt gefolgt von der Bezeichnung der Ebene, z.B. level1:TK-Anlagen. Die Bezeichnung darf kein Leerzeichen enthalten. In der Navigationsleiste erscheinen die Ebenen in der gleichen Reihenfolge, wie sie in der Katalog-Datei definiert sind. Für Leerzeichen kann ein Underline (_) eingesetzt werden, dieses wird dann bei der Generierung der HTMLSeiten in ein Leerzeichen umgewandelt. Ansonsten sollten nur Buchstaben und Zahlen und keine weiteren Sonderzeichen verwendet werden, da diese auf unterschiedlichen Plattformen falsch dargestellt bzw. übertragen werden. Zwischen der Definition der einzelnen Ebenen muß jeweils eine Leerzeile stehen, die Produkte müssen hingegen direkt ohne Leerzeile hinter der level2-Definition aufgeführt werden. 2.4 Produkte definieren Jedes Produkt wird direkt unter der level2-Markierung bzw. unter dem vorherigen Produkt plaziert. Dafür stehen 7 Spalten zur Verfügung. Diese können zum Teil frei verwendet werden. Die einzelnen Spalten haben folgende Funktion. 1. 2. 3. 4. 5. 6. 7. enthält die Bestellnummer, die auch in der Bestell-Email erscheint (fest vordefiniert) kann z.B. die Herstellernummer des Produktes enthalten (frei verfügbar) kann z.B. die Beschreibung des Produktes enthalten (frei verfügbar) enthält den Preis, dieser kann ohne oder mit teilweisem Bruchteil der vollen Währungseinheit angegeben werden, der Online-Shop fügt – wenn erforderlich – bis zu 2 Stellen an, das Trennzeichen muß ein Komma sein (fest vordefiniert) kann z.B. die Lieferzeit enthalten (frei verfügbar) kann Informationen zum Produkt enthalten, die nicht angezeigt werden sollen (z.B. wenn die Katalog-Datei in eine Datenbank für die Bestellabwicklung eingebunden werden soll) (frei verfügbar) enthält die absolute Angabe der Quelle einer Grafikdatei zum Produkt, falls diese auf Anforderung angezeigt werden soll (fest vordefiniert) 2.4.1 Thumbnail in Produkttabelle darstellen Mit Hilfe des Bild-Tags ist es möglich in der Spalte 3 (normalerweise die Beschreibung des Produktes) ein Bild darzustellen. Um die Übertragungszeit der Produkttabelle gering zu halten, sollten hier nur kleine Bilder (Thumbnails) eingefügt werden. Das Thumbnail muß zu Beginn der Produktbeschreibung definiert werden, da nur danach stehender Text in der Produkttabelle angezeigt wird. Nach dem Bild-Tag muß der absolute Pfad zur Grafik-Datei angegeben werden. Beispiel: #Bild:http://www.haa.de/lt/html/images/lasertoner/hp92291a-th.jpg 2.5 Bestellung per Email Die Bestellung wird vom Programm per Email verschickt. Die Email ist so formatiert, daß sie leicht automatisiert weiterverarbeitet werden kann. Eine Bestell-Mail hat folgendes Format: Fa. Mustermann Mustergasse 2 12345 Kleinsiehstenicht Besteller: Herr Mustermann 040-765765 [email protected] Zahlungsart: Rechnung Bemerkung: Nur mal so eine Bemerkung. Artikel: CN BC-20BK 2 VGAS15S15200 HP C3903A 1 1 Unter Artikel sind die bestellten Waren aufgeführt. Die Bestellnummer und die Anzahl ist durch ein Tab getrennt. 3 Verbesserungen, Updates, Fehlerbeseitigung 19.1.99 Hinzufügen der Thumbnail-Funktion in der Produkttabelle. Jedes Produkt kann nun schon in der Produkttabelle mit einem Bild präsentiert werden. Hinzufügen der Funktion Alternativer Text bei grafischer Navigation. Für die Benutzer von nur textdarstellenden Browsern ist die Benutzung des Online-Shops nun möglich. Weiterhin wird bei defekten Grafik-Links (z.B. wegen abgeschaltetem Server) statt der Grafik nun ein Text angezeigt. 18.1.99 Microsoft Internet Explorer 5.00: Konvertierung der deutschen Umlaute vom voreingestellten Unicode in ANSI-Code 14.1.99 Microsoft Internet Explorer 4.72: Bug in der Cookie-Behandlung, dadurch Fehler bei der Anzeige eines leeren Warenkorbs