﻿Slideshow Modul 0.98 für CONTENIDO 4.8.x

################################################################################
TOC (Table of contents)

- BESCHREIBUNG
- INSTALLATION
- CHANGELOG
- SLIDESHOW MODUL THEMEN IM CONTENIDO FORUM
- SCHLUSSBEMERKUNG


################################################################################
BESCHREIBUNG

JavaScript Slideshow Modul für CONTENIDO 4.8.*.
Verwendet die JavaScript Frameworks Prototype und script.aculo.us für die Darstellung 
mehrerer Bilder, die mit einem Überblendeffekt ausgetauscht werden.
Basiert auf die Slideshow von Remco van ‘t Veer, siehe http://blog.remvee.net/post/17.

Das Modul bietet diverse Einstellungsmöglichkeiten zur Steuerung der Slideshow. 
Unterstützt die Bildformate jpg, jpeg, png, und gif. Die Skalierung der Bilder ist 
von der installierten GD-Library oder ImageMagick abhängig. Die Ausgabe der Slideshow 
ist valides XHTML-Strict.

Konfigurationsmöglichkeiten des Moduls:
* Auswahl des Bilderordners innerhalb des upload-Verzeichnisses des Mandanten
* Verwendung von Bildern auch in Unterordnern
* Angabe der Geschwindigkeit für die Slideshow (Zeit zwischen Überblendungen)
* Dauer des Überblendeffektes
* Horizontale Zentrierung der Bilder. Diese Option kann z. B. gewählt werden, 
  wenn Bilder verschiedene Größen haben, und die Slideshow mittig dargestellt soll. 
  Die vertikale Zentrierung ist über die CSS Datei möglich.
* Angabe für maximale Breite/Höhe/Anzahl der Bilder
* Cachedauer für herunterskalierte Bilder
* Mehrfache Verwendung innerhalb einer Seite


################################################################################
INSTALLATION

Die im Modulpackage enthaltenen Dateien/Sourcen sind wie im Folgenden beschrieben 
zu installieren.
Die Pfade zu den Sourcen (CSS, JS und Templates) können von Projekt zu Projekt 
unterschiedlich sein und sind bei Bedarf anzupassen. 
Bei der Installationsbeschreibung wird davon ausgegangen, dass CONTENIDO in das 
DocumentRoot-Verzeichnis eines Webservers installiert wurde und das 
Mandantenverzeichnis "cms/" ist.


1.) cms/css/slideshow.css:
--------------------------
Formatdefinition für die Slideshow. Entweder (a) die Datei im head-Bereich des 
Layouts einbinden
[code]
    <link rel="stylesheet" href="/cms/css/slideshow.css" type="text/css" 
        media="screen, projection" />
[/code]
oder (b) den Inhalt in die eigene CSS-Datei kopieren und die Formatierung den 
eigenen Wünschen anpassen.


2.) cms/includes/*:
-------------------
- class.uploadmeta.php (GenericDB Klassen für Zugriff auf die Upload-Meta Tabelle)
- class.module.slideshow.input.php (Klasse für Slideshow Moduleingabe)
- class.module.slideshow.output.php (Klasse für Slideshow Modulausgabe)

Sind in das Verzeichnis "cms/includes/" zu kopieren.


3.a.) cms/js/scriptaculous/*:
-----------------------------
Enthält die Sourcen des script.aculo.us JavaScript Frameworks (v 1.9.0). 
Im head-Bereich des Layouts sind 2 JavaScript-Dateien aus dem script.aculo.us 
Paket einzubinden.
Beispiel:
[code]
    <script src="/cms/js/scriptaculous/lib/prototype.js" type="text/javascript"></script>
    <script src="/cms/js/scriptaculous/src/effects.js" type="text/javascript"></script>
[/code]


3.b.) cms/js/protoaculous.js:
-----------------------------
Alternative komprimierte JS-Datei bestehend aus Prototype 1.7.0 und Scriptaculous 1.9.0.
Originalbezeichnung der Datei ist protoaculous.1.9.0.min.js, die Quelle ist:
http://groups.google.com/group/prototype-core/files

Die Datei kann anstatt der Scripte aus "/cms/js/scriptaculous/" im head-Bereich 
des Layouts eingebunden werden.
[code]
    <script src="/cms/js/protoaculous.js" type="text/javascript"></script>
[/code]
Der Vorteil dabei ist, dass Prototype und Scriptaculous komplett darin in 
komprimierter Form enthalten ist, d. h. einmal im Header eingebunden, steht die 
volle Funktionalität beider Libraries auch für andere Module/Verwendungszwecke 
zur Verfügung.

WICHTIG:
Zum Einbinden der benötigten JS-Libraries entweder die Version aus 3.a.) oder 3.b.) 
verwenden, nicht beides zusammen.


4.) cms/js/slideshow.js:
------------------------
Die eigentliche JavaScript Datei für die Slideshow, ist im head-Bereich des 
Layouts einzubinden
[code]
    <script type="text/javascript" src="/cms/js/slideshow.js"></script>
[/code]


5.) cms/templates/slideshow.html:
---------------------------------
Das Template für die Ausgabe, ist in das Verzeichnis "cms/templates/" zu kopieren.


6.) Slideshow.xml:
------------------
XML-Export des Slideshow Moduls, ist über das CONTENIDO-Backend als Modul zu importieren.


7.) slideshow_deutsch.xml:
--------------------------
XML-Export der deutschen Modulübersetzung, ist über das CONTENIDO-Backend als 
Modulübersetzung zu importieren.


8.) slideshow_english.xml:
--------------------------
XML-Export der englischen Modulübersetzung, ist über das CONTENIDO-Backend als 
Modulübersetzung zu importieren.


################################################################################
CHANGELOG

2011-09-20 Slideshow Modul 0.98
    * change: Update auf protoaculous.1.9.0 (Prototype.js 1.7.0 + Scriptaculous 1.9.0)
    * change: Auslagern der Modulcodes (Moduleingabe und -ausgabe)
    * added:  Option zur Verwendung von Bildern auch in Unterordnern
    * added:  Dauer des Überblendeffektes
    * added:  Begrenzung für Anzahl der Bilder
    * added:  Englische Modulübersetzung

2009-03-05 Slideshow Modul 0.95
    * new: Erweitert auf mehrfachen Einsatz innerhalb einer Seite
    * change: Update auf scriptaculous-js-1.8.2
    * change: Umstellung auf PHP5

2008-11-16 Slideshow Modul 0.9
    * bugfix: Nur Uploadordner des aktuellen Mandanten ist für die Slideshow auswählbar

2008-09-28 Slideshow Modul 0.8
    * change: Update auf scriptaculous-js-1.8.1
    * change: Angepasst auf CONTENIDO 4.8.x
    * change: Auslesen der Beschreibung aus der Upload-Meta Tabelle
    * new: Neue Option zum Festlegen der Reihenfolge der Ausgabe

2006-12-20 Slideshow Modul 0.6
    * new: Behandlung von Bildern mit verschiedenen Größen
    * new: Horizontale Zentrierung der Bilder
    * new: Maximale Breite und Höhe für Bilder der Slideshow inklusive der Zeit 
      für das Cachen von skalierten Bildern

2006-12-17 Slideshow Modul 0.4
    * Erste Veröffentlichung des Slideshow Moduls.


################################################################################
SLIDESHOW MODUL THEMEN IM CONTENIDO FORUM

Slideshow Modul >0.8 für CONTENIDO 4.8.x:
http://forum.contenido.org/viewtopic.php?t=22583

Slideshow Modul 0.4/0.6 für CONTENIDO 4.6.x:
http://forum.contenido.org/viewtopic.php?t=14923


################################################################################
SCHLUSSBEMERKUNG

Benutzung des Moduls auf eigene Gefahr!

Murat Purc, murat@purc.de
