METHODICA TICKER (JAVA APPLET)
==============================



Einleitung:
----------

METHODICA TICKER wird Ihnen zur Verfgung gestellt durch
methodica herger & krasznai, Informationstechnologie (methodica).
Copyright (C) 2002, methodica. Alle Rechte, insbesondere die Urheberrechte vorbehalten.

Die Software im vorliegenden Archiv ist sogenannte Freeware. D.h. sie darf in nicht-kommerziellen und kommerziellen Umgebungen kostenlos verwendet werden. Im Archiv enthalten sind sowohl ausfhrbare Java-Klassen und Skripte wie auch die zugehrigen Java-Quellcodes.

Die Software darf unter folgenden Bedingungen weitergegeben werden:
1. Die "liesmich.txt" Datei, die Copyright-Vermerke und rechtlichen Hinweise hier und in den Quellcode-Dateien bleiben unverndert resp. werden zusammen mit den Quellcodes und den ausfhrbaren Dateien geliefert. 
2. Die Weitergabe ist fr die Empfnger ebenfalls unentgeltlich, mit der Ausnahme, dass die Selbstkosten fr Speichermedien und den Kopieraufwand belastet werden drfen.
3. Sie drfen die Quelldateien an Ihre Bedrfnisse anpassen, erweitern und erneut umwandeln, sofern die resultierende Software ebenfalls als Freeware in die "public domain" gegeben wird. Falls Sie es wnschen und uns eine Kopie Ihrer Anpassungen resp. einen Link darauf zusenden, publizieren wir Sie nach Mglichkeit auf unserem Server.

Der METHODICA TICKER umfasst ein Applet (ticker.class) und einen erweiterbaren Satz an Text-Servern. 
Ticker.class ist in der Lage, Text statisch oder horizontal rollend auszugeben. Viele Darstellungs-Eigenschaften lassen sich via Parameter einstellen.
Text-Server beliefern ticker.class mit Text, der aus diversen Quellen stammen kann. So wird aus dem Ticker-Applet z.B. ein Text-Datei Betrachter, eine normale Uhr, eine Internet-Zeit Uhr oder eine Differenz-Zeit Uhr.
Sie knnen eigene Text-Server Klassen schreiben, welche auf der abstrakten Klasse "txtsrvr" (Dateien "txtsrvr.java" and "txtsrvr.class") basieren.


Rechtliche Hinweise:
-------------------

Methodica lehnt jede Haftung fr direkte und indirekte Schden durch den Gebrauch dieser Software ab. Nachdem der Quellcode zur Verfgung steht, kann sich der potentielle Anwender selber von der Korrektheit des Codes berzeugen resp. ihm notwendig erscheinende nderungen vornehmen. Falls ein solcher absoluter Ausschluss jeglicher Produkte-Haftung in Ihrem Land rechtlich ausgeschlossen ist, drfen Sie die Software nicht verwenden.
Wir leisten grundstzlich keinen Support fr diese Software. Dennoch sind Fehlermeldungen und Verbesserungsvorschlge willkommen. Das heisst, das Produkt ist uns zwar nicht gleichgltig, wir knnen ihm aber keinerlei Prioritt einrumen.


Inhalt des "ticker26.zip" Archivs:
---------------------------------

readme.txt / liesmich.txt               (Diese vorliegende Datei, englische / deutsche Version)
demo.txt                                Text-Datei, in t_ticker.htm mit dem fildtxt.class Text-Server verwendet.
tickercls.zip                           Gleich wie (*)
t_ticker.htm                            Test und Demo-Seite.
    without_log.zip              (Gesamtarchiv, ohne Logging)
        tickercls.src                   Quellcodes aller Klassen
            ticker.java                 Ticker Klasse (standard, Quellcode, ldt indirekt Text-Server Klassen)
            urlldcls.java               URL-Handler Klasse (standard, Quellcode)
            logger.java                 Dummy Logger Klasse (standard, Quellcode)
            txtsrvr.java                Text-Server Basisklasse (standard, Quellcode)
            deftext.java                Standard-Text Server Klasse (standard, Quellcode)
            fildtxt.java                Datei-Anzeiger Text-Server Klasse (standard, Quellcode)
            datimtxt.java               Datum/Zeit Text-Server Klasse (Quellcode)
            itimtxt.java                Internet-Zeit Text-Server Klasse (Quellcode)
            y2kdtxt.java                Datum-/Zeit-Differenz Text-Server Klasse (Quellcode)
        tickercls.zip / tickercls.jar   (*) Klassen-Archive, ohne Logging
            ticker.class                Ticker Klasse (standard, ausfhrbar)
            urlldcls.class              URL-Handler Klasse (standard, ausfhrbar)
            logger.class                Dummy Logger Klasse (standard)
            txtsrvr.class               Text-Server Basisklasse (standard, ausfhrbar)
            deftext.class               Standard-Text Server Klasse (standard, ausfhrbar)
            fildtxt.class               Datei-Anzeiger Text-Server Klasse (standard, ausfhrbar)
            datimtxt.class              Datum/Zeit Text-Server Klasse (ausfhrbar)
            itimtxt.class               Internet-Zeit Text-Server Klasse (ausfhrbar)
            y2kdtxt.class               Datum-/Zeit-Differenz Text-Server Klasse (ausfhrbar)
    with_log.zip                 (Gesamtarchiv, mit Logging, Details siehe unten)
        tickercls.src                   Quellcodes aller Klassen
            logger.java                 Logger Klasse, client-seitig, (Quellcode)
                                            [ alle brigen .java Dateien wie oben ]
        tickercls.zip / tickercls.jar   Klassen-Archive, mit Logging
            logger.class                Logger Klasse, client-seitig, (ausfhrbar)
                                            [ alle brigen .class Dateien wie oben ]
        setlogent.cgi                   Logger Skript (PERL), server-seitig
        logger.cfg                      Logger Konfigurations-Datei



Generelle Installationsanweisungen:
----------------------------------

1. Entscheiden Sie, ob Sie mit Logging oder ohne arbeiten mchten. Logging ist zu empfehlen, wenn Sie Applets und Text zur Verfgung stellen, das Applet aber auf nicht unter Ihrer Kontrolle stehenden Webseiten eingebunden wird (Newsticker). So behalten Sie den berblick, wo das Applet wie verwendet wird.
   Falls Sie Logging verwenden mchten, fahren Sie mit den Dateien aus dem "with_log.zip" Archiv weiter, sonst mit denjenigen aus dem "without_log.zip" Archiv.
2. Expandieren Sie das gewhlte Archiv in ein neu eingerichtetes Verzeichnis.
3. Kopieren Sie von dort entweder das "tickercls.zip" or the "tickercls.jar" Archiv (unterschiedliche Formate bei identischem Inhalt) in das Verzeichnis auf Ihrem Web-Server, wo auch die HTML-Seiten mit dem einzubindenden Applet gespeichert sind oder in das Verzeichnis, auf durch den "CODEBASE=..." Tag in den HTML-Seiten verwiesen wird.
   Kopieren Sie ebenfalls die Dateien "demo.txt" und "t_ticker.htm" ins gleiche Verzeichnis. Damit knnen Sie spter die Korrektheit der Installation verifizieren.
  
   ---- nur wenn Logging gewhlt (Details siehe unten) ----
4. Kopieren Sie das "setlogent.cgi" Skript in das /cgi-bin/ (oder das entsprechende) Skript-Verzeichnis Ihres Web-Servers. Bitte beachten Sie, dass die Parameter zuvor korrekt eingestellt worden sind (siehe Details unten).
5. Nachdem der "LogScript"-Schlssel in der Datei "logger.cfg" richtig gesetzt ist, kopieren Sie diese Datei ins gleiche Verzeichnis wie Sie das "tickercls.xxx" Archiv zuvor kopiert haben.
   ---- Ende: nur wenn Logging gewhlt ----

6. Rufen Sie nun im Web-Browser die Datei "t_ticker.htm" auf und testen Sie Ihre Installation. Wenn alles in Ordnung ist, sollten jetzt alle eingebundenen Applets den entsprechenden Text anzeigen. Bleibt die Applet-Flche grau, ist oft eine Fehl-Konfiguration des Logging dafr verantwortlich (setlogent.cgi nicht ausfhrbar, usw.).

Falls frhere Versionen des METHODICA TICKER Applets in Seiten eingebunden worden sind, fehlt dort die Anweisung "archive=tickercls.zip" / "archive=tickercls.jar". Damit die Applets in diesen Seiten weiterhin funktionieren, entpacken Sie die .class Dateien aus dem "tickercls.zip" Archiv und kopieren Sie sie ins gleiche Verzeichnis wie frher. Mit der Anweisung "archive=" verkrzen sich die Ladezeiten, weshalb es sich lohnen wird, trotzdem gelegentlich die HTML-Seiten anzupassen.



Die Logging-Funktionen etwas detaillierter:
------------------------------------------

Das ticker.class applet hat einen Mechanismus zur Mitschreiben (logging), wo es und mit welchen Text-Servern es verwendet wird. 
Der Logging-Eintrag wird client-seits durch die "logger.class" Klasse ausgelst und server-seits durch das PERL-Skript "setlogent.cgi" vollzogen. "Logger.class" wird automatisch durch "ticker.class" immer dann aufgerufen, wenn das Applet geladen wird. "Logger.class" ruft "setlogent.cgi" oder ein anderes Skript auf dem Web-Server gemss Konfiguration auf. Diese Zweiteilung ist ntig, weil ein Java-Applet aus Sicherheits-Grnden nicht direkt auf dem Server nderungen an Dateien vornehmen darf.

Die folgenden Konfigurations-Parameter sind in der Datei "logger.cfg" anzupassen:

(1)   LogScript=http://www.yourdomain.com/cgi-bin/setlogent.cgi
(2)   MaxLogSize=50000

Dabei bedeutet "LogScript" (1) die URL, unter welcher das Skript "setlogent.cgi" oder ein entsprechendes Skript angesprochen werden kann. Das Skript sollte ja zuvor ins Verzeichnis fr Skripte auf dem Web-Server kopiert worden sein (blicherweise /cgi-bin/). Stellen Sie sicher, dass fr das Sktipt die notwendigen Berechtigung (mindestens "lesen" und "ausfhren", Attribut-Code 755) gesetzt worden sind.
Das Skript "setlogent.cgi" nimmt als MAXSIZE-Parameter die maximale grsse entgegen, die eine Log-Datei erreichen darf. Sobald dieses Maximum erreicht ist, benennt das Skript die bisherigen Log-Dateien um und legt eine neue an. Den Namen frherer Log-Dateien werden die Ziffern "0" (jngste) bis "9" (lteste) angehngt. Die Maximal-Grsse in Bytes wird  durch "logger.class" aufgrund des Parameters "MaxLogSize" (2) festgelegt und an das "setlogent.cgi" Skript weitergegeben.

Die folgenden Konfigurations-Parameter sind im Skript "setlogent.cgi" anzupassen:

(1)   #!/usr/bin/perl
(2)   $serverRoot="/home/yourdomain/Web";
(3)   $httpRoot="www.yourdomain.com";
(4)   $logtempl = "%HOST% - %USER% [%CDATE%:%CTIME%] \"%MODE% - %PROT%\" - - \"-\" \"%TEXT%  Agent: %USRA%\"";
(5)   $inmxlfsize = 50000;
(6)   $applfname = "applet";
(7)   $applfext = "log";

Der absolut erste Eintrag (1) im Skript zeigt auf das Verzeichnis auf dem Web-Server, wo der PERL-Interpreter installiert ist. Gegebenenfalls fragen Sie den Web-Master resp. den Service-Provider. blicherweise stimmt der oben gezeigte Pfad.
Der "serverRoot" Parameter (2) zeigt den Basis-Verzeichnis zu den Web-Seiten auf dem Web-Server. Das ist das gleiche Verzeichnis, in welches resp. in dessen Unterverzeichnisse Sie blicherweise HTML-Seiten ablegen. Unter MS Windows kann er auch beispielsweise so aussehen: "C:/Web/mydomain".
Der Parameter "httpRoot" (3) ist der Hostname (www.xxxx.yyy). Mit einem "personal web server" auf Ihrer Arbeitsstation ist der Hostname oft "localhost".
Das Log-Template (4) legt in symbolischer Form fest, wie und mit welchen Informationen das Skript Log-Eintrge aufbaut. Folgende Platzhalter stehen dabei zur Verfgung:
      %HOST%  : Name oder IP-Adresse des Servers, von dem aus die Anforderung fr den Log-Eintrag stammte.
      %USER%  : Benutzer-Identifikation (falls durch Browser geliefert)
      %CDATE% : Aktuelles System-Datum (Web-Server)
      %CTIME% : Aktuelle System-Zeit (Web-Server)
      %NOW%   : Datum/Zeit, aktuell (Web-Server)
      %MODE%  : Anforderungsmodus (GET, POST, usw.)
      %PATH%  : Skript-Pfad (interne Darstellung, falls verfgbar)
      %PROT%  : Verwendetes Internet-Protokoll (z.B. HTTP/1.1)
      %REFR%  : Vorgnger-URL (z.B. URL der zuvor besuchten Seite, falls durch Browser bermittelt)
      %USRA%  : Use-Agent (kennzeichnet den verwendeten Browser-Typ)
      %TEXT%  : Spezifischer Text, durch "logger.class" geliefert;
                enthlt die URL der Seite, in welcher das Ticker-Applet eingebunden ist plus 
                den Pfad zum Ticker-Applet selber.
Sonderzeichen (wie %, ", usw.) werden buchstblich verwendet, falls ihnen ein sogen. Bachslash (\) vorangestellt wird.
(5) bezeichnet den Standard-Wert fr die Maximale Grsse der Log-Dateien, falls er nicht durch die "logger.class" Datei aufgrund eines gltigen "MaxLogSize" Eintrages in der Datei "logger.cfg" bersteuert worden ist.
(6) und (7) legen den Namen (Namensstamm) und die Endung der Log-Dateien fest. Im obigen Beispiel wrde die aktuelle Log-Datei "applet.log" heissen, frhere Log-Dateien htten die Namen "applet0.log" (jngste) bis "applet9.log" (lteste).



Viel Spass und viel Erfolg mit dem Ticker-Applet wnscht Ihnen...

methodica herger & krasznai
Fellstr. 3, Postfach 80
5413 Birmenstorf AG, Schweiz
http://www.methodica.ch
mail@methodica.ch
