Google translator »

(Opens in a new window - öffnet in einem neuen Fenster)

Kurz-Dokumentation csvShop

Version csvShop 2.0 - released 2023-01

Kurzbeschreibung

Mit dem Plugin csvShop wird Ihre CMSimple Website zu einem OnlineShop.

Der csvShop verwendet eine .csv Datei als "Datenbank", darin sind die wichtigsten Eigenschaften der einzelnen Artikel gespeichert. Aus dieser "Datenbank" entstehen die Teaser und der erste Teil der Artikelseiten. Der nachfolgende Teil der Artikelseiten ist frei gestaltbar, hier haben Sie alle Möglichkeiten zur Verfügung, die CMSimple zu bieten hat: Fotogalerien, Videos, Kommentare und vieles mehr.

Die Shopseite (Übersichtsseite) sammelt alle Unterseiten ein, die den Pluginaufruf einer Artikelseite enthalten, erstellt Teaser und verlinkt einige Teaserelemente mit der entsprechenden Artikelseite. Man kann mehrere Shopseiten (Übersichtsseiten) einrichten und so die Artikel in Kategorien sortiert anbieten.

Hinweis: Die .csv Datei ("Datenbank") stellt die Artikel nur bereit, auf der Website passiert erst einmal gar nichts. Auf den Shopseiten erscheinen die Artikel erst, wenn entsprechende Unterseiten der Shopseiten (Artikelseiten) angelegt sind. Diese müssen genau so wie die Artikelnummer des Artikels heissen.

1. Systemvoraussetzungen

2. Installation

  1. zip-Datei herunterladen und mit einem geeigneten Programm entpacken
    • Laden Sie den komplette Inhalt des Verzeichnisses "CMSimpleRoot" (die Verzeichnisse "plugins" und "userfiles") in das Installationsverzeichnis von CMSimple hoch.
    • Bei einem Update laden Sie einfach das Verzeichnis "userfiles" nicht mit hoch.
      Sie sollten vor jedem Update mindestens die config.php und die Sprachdateien sichern.
  3. Vergeben Sie (wenn nötig) mit Ihrem ftp-Programm die erforderlichen Lese- und Schreibrechte für Ordner und Dateien. Auf modernen Servern ist das nicht notwendig.

3. Datei- und Ordnerrechte

Damit das Programm funktioniert und arbeiten kann (bzw. administrierbar ist), müssen auf älteren Servern eventuell für bestimmte Dateien und Ordner bestimmte Schreib- und Leserechte vergeben werden.

Dateien: chmod 666

Ordner: chmod 777

4. Die Artikeldatei ("Datenbank")

Die Funktion der Datenbank übernimmt die Datei csvs_data.csv im Verzeichnis ./userfiles/plugins/csvhop/, so dass diese Datei mit dem Filemanager von CMSimple hochgeladen werden kann.

Der Name der Artikeldatei kann in der Plugin Konfiguration geändert werden. So kann man diese Datei vor neugierigen Blicken schützen, indem man ihr einen kryptischen, passwortartigen Namen gibt.

Artikelverwaltung extern

Kleine Datendateien kann man in einem Texteditor bearbeiten, grössere Dateien bearbeitet man bequem in Excel oder OpenOffice. Mein OpenOffice liest die Datei im richtigen Format ein und speichert sie dann auch im richtigen Format wieder ab. Die Möglichkeit der Bearbeitung der Datendatei in Excel oder OpenOffice & Co. macht csvShop fit für hunderte Artikel im Shop.

Artikelverwaltung im Plugin Backend

Ab csvShop 2.0 gibt es eine Artikelverwaltung im Plugin Backend. Da können Sie die Artikeldatei online bearbeiten: Artikel erstellen, bearbeiten, löschen und sortieren.

Die Erstellung neuer Artikel sollte über die Eingabemaske erfolgen, dann werden die Eingaben auf Korrektheit geprüft.

Die neuen Artikel werden am Ende der Datei eingefügt, dashalb sollten Sie nach der Erstellung der neuen Artikel die Datei sortieren. Die Sortierfunktion befindet sich ganz unten in der Artikelverwaltung.

Die Struktur der Artikeldatei

Jede Zeile der Artikeldatei hat 8 durch Semikolon getrennt Felder. Hinter das letzte Feld gehört kein Semikolon.

Die Bedeutung der Felder können Sie der 1. Zeile entnehmen. Hier noch ein paar Informationen:

1 - Artikelnummer:Die Artikelnummer
2 - Artikel:Text (html tags erlaubt)
3 - Kurzbeschreibung:Text (html tags erlaubt)
4 - Bruttopreis:Zahl (ohne Angabe der Währung)
5 - MWSt_Satz:Zahl (ohne %)
6 - Versandgewicht[kg]:Zahl (ohne kg)
7 - Packmass[lxbxh_cm]:Text
8 - Stckz:Zahl (Vorbelegung i.d.R. 1)
9 - Varianten:Text (Varianten getrennt durch | )

In allen Feldern, die eine Zahl enthalten, muss auch dringend eine Zahl stehen - ohne weitere Angaben
wie Währung oder Einheit. Wenn keine Angabe gemacht werden soll, tragen Sie eine 0 (Null) ein.

Spezielle Hinweise

Nachkommastellen:
Bei Zahlen mit Nachkommastellen (z. B. Preise) muss statt des Kommas ein Punkt verwendet werden, also für 9,99 EUR muss in die csv Datei 9.99 eingetragen werden.

Versandgewicht und Packmass:
Wenn Gewicht und/oder Packmass nicht verwendet werden sollen, müssen Sie zwingend eine 0 (Null) eintragen. In diesem Fall wird auch die Anzeige auf der Artikelseite und im Warenkorb unterdrückt. Die Nullen sind wichtig, damit die Berechnungen nicht gestört werden.

vorletztes Feld (Stckz):
Mit der hier eingetragenen Zahl wird auf der Artikelseite das entsprechende Eingabefeld vorbelegt, im Normalfall 1.

letztes Feld (Varianten):
Wenn hier eine 0 (Null) eingetragen ist, gibt es keine Varianten. Soll der Artikel in verschiedenen Varianten zum gleichen Preis angeboten werden, können hier die Varianten mit "|" getrennt angegeben werden. Denken Sie daran: Kein Semikolon nach dem letzten Feld!

Beispiel: rot|blau|grün|gelb|weiss

In diesem Fall erscheint auf der Artikelseite über der Stückzahl eine Auswahlbox mit den Varianten. Die Varianten werden im Warenkorb an den Artikelnamen und die Artikelnummer angehängt.

Backups der Artikeldatei

Bei jeder Änderung der Artikeldatei legt csvShop ein Backup der Artikeldatei an. Gleichzeitig wird ab einer konfigurierbaren Anzahl von Backups das älteste Backup gelöscht. Die Backups werden in folgendem Ordner erstellt:

./backups/csvshop/

5. Die Artikelnummern

Es ist wichtig, sich von Anfang an Gedanken um die Struktur des Shops zu machen und die Artikelnummern entsprechend zu gestalten, z. B. die ersten Stellen Buchstaben für Artikelgruppen und dann 3 Ziffern, die ermöglichen pro Artikelgruppe 999 Artikel.

Die Artikelnummern dürfen keine Leerstellen enthalten!

Im csvShop dreht sich alles um die Artikelnummern: Bildnamen, Seitennamen usw.

6. Die Artikelbilder

Für jeden Artikel gibt es ein Bild, das im Teaser und im oberen Teil der Artikelseite erscheint. Diese Bilder liegen im Verzeichnis ./userfiles/plugins/csvshop/images/ und haben als Dateinamen die Artikelnummer.

Diese Bilder sollten mindestens 360px breit und nicht zu hoch sein, maximales Seitenverhältnis 4:3 im Querformat. Bei Bildern im Hochformat muss evtl. im Stylesheet die Höhe der Teaser angepasst werden.

8. Die Pluginaufrufe

8.1 Shop Übersichtsseite mit Teasern

Das ist die Funktion, die auf der Shopseite die Unterseiten einsammelt und als Teaser darstellt:

{{{plugin:csvshop();}}}

Es können mehrere Shopseiten eingerichtet werden, alle bedienen sich aus der gleichen Datendatei.

8.2 Die Artikelseiten

Die Artikelseiten sind Unterseiten der Shopseite und werden auf dieser automatisch als Teaser dargestellt, wenn sie den Pluginaufruf einer Artikelseite enthalten.

Im Normalfall wird man die Artikelseiten aus der Navigation (dem Menü) entfernen (verstecken).

Die Artikelseiten müssen exakt wie die Artikelnummer des Artikels heissen!

Diese Funktion rufen Sie auf den Artikelseiten auf:

{{{plugin:csvsItem();}}}

Diese Funktion erstellt aus der Datendatei den Standardteil der Artikelseite. In der Regel wird sie als erstes auf der Seite aufgerufen.

Danach haben Sie alle Möglichkeiten zur Verfügung, die CMSimple zu bieten hat: Fotogalerien, Videos, Kommentare und vieles mehr. Hier kann es auch Sinn machen, einige Tags für die interne CMSimple Suche zu platzieren

8.2.1 Verfügbarkeitsstatus angeben und anzeigen

Die Anzeige des Verfügbarkeitsstatus eines Artikels können Sie in der Plugin Konfiguration aktivieren und deaktivieren.

Mit der Angabe eines Parameters im Pluginaufruf können Sie den Verfügbarkeitsstatus eines Artikels angeben:

{{{plugin:csvsItem('Verfügbarkeitsstatus');}}}

'nl' steht für "nicht lieferbar" und deaktiviert das Formular, mit dem man den Artikel in den Warenkorb legen kann.

'beliebiger Text' erscheint oberhalb des Formulars, mit dem man den Artikel in den Warenkorb legen kann.

Beispiel:

{{{plugin:csvsItem('lieferbar ab August 2022');}}}

8.3. Die Warenkorb Seite

Die Warenkorb Seite wird in der Sprachdatei unter config => config cart page: definiert und muss dann auch so heissen. Leerstellen müssen durch Unterstriche ersetzt werden, es muss genau dem Seitennamen ab dem Fragezeichen in der Adresszeile des Browsers entprechen, also incl. der übergeordneten Seite(n).

Der Warenkorb sollte aber im Normalfall eine Seite der 1. Menüebene sein, damit er permanent erreichbar ist.

Diese Funktion rufen Sie auf der Warenkorbseite auf:

{{{plugin:csvsCart();}}}

Diese Funktion präsentiert den aktuellen Warenkorb und das E-mail Formular zur Versendung des Warenkorbes an den Shopbetreiber, sobald ein Artikel im Warenkorb liegt.

8.3.1 Das Mailformular mit SMTPmail

Für den Mailversand des Warenkorbes an den Shopbetreiber muss zwingend
das Plugin SMTPmail 2.2 oder höher installiert sein.

Ob der Versand der E-mails per php Funktion mail() oder per SMTP erfolgt, kann in der Plugin Konfiguration von csvShop festgelegt werden.

8.3.2 Schutz des E-mail Formulars mit dem Plugin MembersArea

Wenn Sie das abschicken eines Warenkorbes nur eingeloggten Mitgliedern gestatten wollen, können Sie das Plugin MembersArea installieren.

Der Folgende Pluginaufruf setzt das MembersArea Login Formular unter den Warenkorb:

{{{plugin:csvsCart('ma');}}}

Das E-mail Formular wird erst dann eingeblendet, wenn der Kunde sich angemeldet hat. Wie Sie ein anonymes Gast Login erstellen, erfahren Sie in der Hilfedatei von MembersArea.

8.3.3 Die Funktion Backlink

Mit dieser Funktion können Sie auf der Artikelseite an jeder gewünschten Stelle einen Backlink zur Übersichtsseite setzen:

{{{plugin:csvsBL();}}}

Das kann sinnvoll sein, wenn unterhalb des Standardteils eines Artikels noch umfangreiche weitere Informationen stehen.

9. Die Stylesheets

Es werden 2 Stylesheets mitgeliefert, ein einspaltiges mit breiten Teasern untereinander und eines mit schmalen, floatenden Teasern. Die Dateien styleheet.css finden Sie in Unterverzeichnissen des css/ Ordners des Plugins.

Die stylesheet.css des einspaltigen Stylesheets finden Sie im Ordner css/arial_small_teasers/ des Plugins. Dieses Stylesheet ist äusserst robust und funktioniert in nahezu jedem Template, als ob es dafür gemacht wäre.

Die stylesheet.css des Stylesheets mit schmalen, floatenden Teasern finden Sie im Ordner css/arial_small_teasers/ des Plugins.

Um eines der Stylesheets zu aktivieren, kopieren Sie die entsprechende stylesheet.css in den Ordner css/ des Plugins.

10. Shop anlegen - eine kurze Schritt-für-Schritt Anleitung

Diese Kurzanleitung geht davon aus, dass Sie bereits Erfahrung im Umgang mit CMSimple haben.

  1. Artikel in der Datenbank anlegen (offline), Datenbank hochladen (siehe 4.)
  2. Artikelbild(er) erzeugen (offline) und hochladen (siehe 6.)
  3. Wenn noch nicht geschehen, Shopseite erzeugen (siehe 8.1)
  4. Wenn noch nicht geschehen, Warenkorbseite anlegen (siehe 8.3.)
  5. Im Pagemanager die 1. Unterseite (den 1. Artikel) anlegen, den Pluginaufruf einfügen und speichern (siehe 8.2)
  6. Im Pagemanager die 2. Unterseite (den 2. Artikel) anlegen, den Pluginaufruf einfügen und speichern (siehe 8.2)
  7. usw. ...

Viel Spass, hier geht's zum CMSimple Forum »