Anleitung zur Installation von Marquee

Version dieser Lieferung: v1.1b

Übersicht

Systemvoraussetzungen
Support: support@lexasoft.de
Inhalt
Installation
Parameter
Update
Besonderheiten bei mehrfachem Einsatz / mehreren Lexasoft - Applets
Anhang

Systemvoraussetzungen

Um das Applet nutzen zu können, muss Ihr Webserver keinerlei besondere Voraussetzungen erfüllen. Er muss lediglich das Herunterladen von Dateien mit den Endungen .jar, .properties und .txt zulassen. Das sollte in den allermeisten Fällen möglich sein.

Bei den Besuchern Ihrer Webseite müssen folgende Voraussetzungen erfüllt sein:

Inhalt

Die Marquee - Lieferung besteht aus der Zip - Datei marquee.zip, die folgende Dateien und Verzeichnisse enthält:

Verzeichnis / Datei Bedeutung
marquee.htm   Startseite für das Applet
readme.htm   Diese Anleitung.
lib

Verzeichnis mit den Java Archiven

marquee.jar Java Archiv mit dem Programm

j11util.jar Java Archiv mit Bibliotheken.
props   Verzeichnis mit Property- und Textdateien
  lexasoft.properties Datei mit allgemeinen Properties für Lexasoft - Applets.
  marquee.properties Datei mit speziellen Properties für Marquee. 
  texte.txt Beispieltextdatei
Zum Anfang

Installation 

  1. Entpacken Sie diese Dateien in ein Verzeichnis auf Ihrer Webseite (z.B. /marquee)
  2. Öffnen  Sie die Seite marquee.htm im Browser. Das Applet sollte bereits mit den mitgelieferten Beispieltexten starten.
  3. Je nach gewünschtem Anwendungsfall können Sie entweder diese Seite verlinken oder den Applet - Tag aus marquee.htm an die gewünschte Stelle in Ihrer html - Seite kopieren.
  4. Passen Sie den Applet - Tag an Ihre Webseite an. Insbesondere ist es wichtig, dass Sie den korrekten Pfad zu marquee.jar, ausgehend von der einbindenden html - Seite, angeben.
  5. Passen Sie die übrigen Parameter in den Dateien lexasoft.properties und marquee.properties an.
  6. Nicht zuletzt: Erstellen Sie eine Textdatei mit den Texten, die Sie scrollen lassen wollen und geben Sie die URL zu dieser Datei im Property MARQUEE_TextFile an ( Datei marquee.properties oder als Parameter im Applet - Tag).
Zum Anfang

 Parameter

Alle Parameter ( mit wenigen Ausnahmen ) können in jeder beliebigen Property - Datei oder als Parameter der HTML - Seite angegeben werden. Welche Property - Dateien vom Applet ausgelesen werden, muss im Applet Tag als Parameter "propertyfiles" angegeben werden ( s.a. Beispieldatei marquee.htm).

Die Angabe der Dateien muss ausgehend von der einbindenden HTML - Seite erfolgen. Mehrere Property - Dateien sind durch ";" zu trennen. 

Parameter dürfen auch mehrfach angegeben werden. Welcher Wert dann verwendet wird, richtet sich nach folgender Reihenfolge:

Die Form der Parameter in Property - Dateien oder als Parameter im Applet Tag ist den gelieferten Beispieldateien zu entnehmen.

Nachfolgend eine Aufstellung aller relevanten Parameter.

Parameter Bedeutung Wert / Erklärung Bemerkung
propertyfiles Property - Dateien, die vom Applet ausgewertet werden sollen. URLs zu den Propertyfiles, ausgehend von der einbindenen HTML - Seite, semikolonsepariert. ausschließlich als Parameter im Applet - Tag
ResourceBase Basisverzeichnis für Resourcen Ausgehend vom Verzeichnis der einbindenden HTML - Seite kann ein Verzeichnis angegeben werden, in dem sich Resourcen ( für Marquee ausschließlich Bilder - z.B. Hintergrundbild ) befinden. Nur nötig bei mehrfachem Einsatz. ausschließlich als Parameter im Applet - Tag
MARQUEE_TextFile URL zur Textdatei, die den zu scrollenden Text enthält. Ausgehend vom Verzeichnis der einbindenen HTML -Seite  
delay Verzögerung in Millisekunden Diese Zeit wartet das Applet, bevor der Text das nächste Mal verschoben wird.  
stepY Vertikale Schrittweite in Pixeln 0: keine Bewegung
negativ: von unten nach oben
positiv: von oben nach unten
 
stepX Horizontale Schrittweite in Pixeln 0: keine Bewegung
negativ: von rechts nach links
positiv: von links nach rechts
 
FONT_ScrollText Font des zu scrollenden Textes. Fontart, Schriftstil und Schriftgrösse, durch Komma getrennt. Beispiel:

Arial, Plain, 10

 
lineBreak Schaltet Zeilenumbruch  ein. true: Zeilen, die zu lang sind werden umgebrochen.
false: Zeilen, die zu lang sind, werden nicht umgebrochen. 
Diese Schalter wirken nur, wenn rein vertikales Scrollen eingestellt ist.
leftMargin Linker Rand bei Zeilenumbruch Breite des linken Randes, der beim Zeilenumbruch frei bleibt.
rightMargin Rechter Rand bei Zeilenumbruch Breite des rechten Randes, der beim Zeilenumbruch frei bleibt.
TextAlign
Ausrichtung des Textes
CENTER - zentriert
LEFT - linksbündig
RIGHT - rechtsbündig
COL_ScrollText Farbe des zu scrollenden Textes Codierung über englische Farbbezeichnungen ( z.B. black, white etc. ) bzw. wie in HTML z.B. #FFFFFF für weiss. Vgl. Anhang Farbkodierungen
IMG_Warning Icon in Warndialogen In Marquee nicht verwendet Empfohlen in lexasoft.properties
IMG_Stop Icon in Fehlerdialogen In Marquee nicht verwendet Empfohlen in lexasoft.properties
IMG_Question Icon in Fragedialogen In Marquee nicht verwendet Empfohlen in lexasoft.properties
IMG_background Hintergrundbild URL zu Hintergrundbild  
FONT_Normal Font des Applets Schreibweise wie FONT_ScrollText. Wird verwendet, wenn FONT_ScrollText nicht vorgegeben. Empfohlen in lexasoft.properties
COL_fgcolor Vordergrundfarbe ( Schriftfarbe ) Schreibweise wie COL_ScrollText. Wird verwendet, wenn COL_ScrollText nicht vorgegeben. Vgl. Anhang Farbkodierungen
COL_bgcolor Hintergrundfarbe Schreibweise wie COL_ScrollText. Vgl. Anhang Farbkodierungen
Zum Anfang

Updatehinweise

Um festzustellen, welche Version des Lexasoft Marquees Sie verwenden, starten Sie bitte die HTML - Datei aus der Originallieferung. Sie weist die Versionsnummer unterhalb des Beispieles aus.

Version v1.0.2x auf v1.0.3b

Ersetzen Sie lediglich das File marquee.jar in Ihrer Installation durch das gleichnamige File aus der Lieferung. Auf diese Weise erhalten Sie Ihre Einstellungen. Wollen Sie die neue Funktionalität des Zeilenumbruches nutzen, kopieren Sie den entsprechenden Abschnitt am Ende der gelieferten marquee.properties Datei in Ihre gleichnamige Datei.

Version v1.0.3b auf v1.1

Zwei Möglichkeiten gibt es für ein Update, um Ihre Einstellungen zu erhalten:

  1. Ersetzen Sie die Datei marquee.jar mit der Datei ./lib/marquee.jar aus der Lieferung und kopieren Sie die Datei ./lib/j11util.jar in das selbe Verzeichnis. ODER
  2. Kopieren Sie das Verzeichnis ./lib aus der Lieferung in Ihre Installation und entfernen Sie die bisherige Datei marquee.jar. Ändern Sie den Verweis in Ihrer Html Seite (Parameter ARCHIVE)  so, dass er jetzt auf ./lib/marquee.jar zeigt.
Tragen Sie in Ihre Property Datei ./prop/marquee.properties den neuen Schluessel TextAlign mit dem von Ihnen gewünschten Wert ein. Beispiel:
TextAlign=CENTER
Ein Beispiel finden Sie in der Datei ./prop/marquee.properties der Lieferung.

Besonderheiten bei mehrfachem Einsatz / mehreren Lexasoft - Applets

Natürlich kann Marquee grundsätzlich an unterschiedlichen Stellen in Ihrem Webauftritt eingesetzt werden. Ebenso ist eine Kombination mehrerer Lexasoft - Applets möglich. 

Aus diesem Grunde hat Lexasoft die Möglichkeit geschaffen, Parameter Ihrer Applets hierarchisch zu ordnen. Weiter oben wurde die Rangfolge der Auswertung bereits erläutert.

Sie sollten so vorgehen, dass Sie grundsätzlich sowohl das jar - File als auch die allgemeinen Properties ( lexasoft.properties ) nur einmal auf Ihrem Server halten und von den einbindenden HTML - Seiten darauf verweisen.

Die Datei lexasoft.properties definiert auch Parameter, die von Marquee nicht verwendet werden. Diese können sie auskommentieren ( bzw. auskommentiert lassen ), falls Sie nur Marquee einsetzen. 

Sie können diese Datei dazu benutzen, allgemeine Properties zu beschreiben, die default für alle Ihre Applets  gelten sollen. Damit können Sie diese perfekt an das Aussehen Ihrer Webseite anpassen.

Da alle URLs relativ zum Verzeichnis der einbindenden HTML - Seite angegeben werden, würden in lexasoft.properties getroffene Angaben zu Resourcen ( z.B. Hintergrundbild ) nicht immer funktionieren, da die einbindenden HTML - Seiten nicht immer im gleichen Verzeichnis stehen.

Deswegen kann mittels des Parameters "ResourceBase" ( nur als Parameter der einbindenden HTML - Seite ) ein spezielles Ressourcen - Verzeichnis angegeben werden. Diese wird vom Applet zusätzlich zum Verzeichnis der einbindenden HTML - Seite ausgewertet. URLs zu Bildern können dann sowohl relativ zu diesem Verzeichnis als auch relativ zum Verzeichnis der einbindenden HTML - Seite angegeben werden.

Die ResourceBase wird aber nur verwendet, wenn relativ zum Verzeichnis der HTML - Seite kein Bild gefunden wurde.

Beispiel:

/applets
  |
  + res
  |  + image1.gif
  + marquee.jar  
/inhalt
  + marqueeseite.htm
  + image2.gif

In diesem Falle ist das Verzeichnis /applets/res/ als globales Ressourcenverzeichnis gedacht. Um dies zu erreichen, muss im Applet - Tag in marqueeseite.htm ( ausgehend vom eigenen Verzeichnis ) angegeben sein:

...
<param name="ResourceBase" value="../applets/res/.">
...

Um das Bild image1.gif als Hintergrundbild zu verwenden, definiert lexasoft.properties:

IMG_background : image1.gif

Anders ausgedrückt: Alle Applets, die einen analogen Verweis auf das Ressourcenverzeichnis erhalten und lexasoft.properties verwenden, benutzen image1.gif automatisch als Hintergrundbild.

Um, abweichend davon, das Bild image2.gif als Hintergrundbild zu verwenden, könnte in einer anderen ( später aufgeführten ) Property - Datei dieser Wert wie folgt überschrieben werden:

IMG_background : image2.gif

oder als Parameter im Applet - Tag:

...
<param name="IMG_background" value="image2.gif">
...

Dies ist möglich, weil die Ressourcen auch ausgehend vom Verzeichnis der einbindenden HTML - Seite aus angegeben werden dürfen.

Empfehlung: Verwenden Sie in lexasoft.properties nur Verweise relativ zum globalen Ressourcenverzeichnis. In den Property - Files der einzelnen Java - Applets bzw. in den Parametern, mit denen sie aufgerufen werden, verwenden Sie nur Verweise ausgehend vom Verzeichnis der einbindenden HTML - Seite.

Auf diese Weise nutzen Sie die flexible Ressourcenverwaltung der Lexasoft - Applets optimal aus.

Zum Anfang

Anhang

Farbkodierungen

Farben in Lexasoft - Applets können als englische Farbbezeichnungen oder, wie in HTML Seiten üblich, in freier Codierung angegeben werden. Folgende Farbbezeichnungen sind zulässig:

Zum Anfang

 

Systemvoraussetzungen
Support: support@lexasoft.de
Inhalt
Installation
Parameter
Update
Besonderheiten bei mehrfachem Einsatz / mehreren Lexasoft - Applets
Anhang