|
Letzte
Bearbeitung dieses Dokuments: |
Voraussetzung für das Verständnis dieses Dokuments:Kenntnisse von HTML-Code und Javascript. |
Ungefährer Zeitaufwand für das Durcharbeiten dieses Dokumentes:In diesem Dokument
wird gelistet, welche Javascript-Funktionen für die JavaScout
Web-Präsentation aus HTML-Dokumenten aufgerufen werden und
welche Parameter dabei nötig sind. |
Dieses
Dokument enthält eine Liste der Javascript-Funktionen, die für
die Steuerung der Web-Präsentation verwendet werden.
Diese
Funktionen sind in den Dateien 'GeneralCode.js' und 'MailCode.js' (im
Verzeichnis '_scripts' enthalten.
Im
Detail ist die Wirkungsweise der Programme in den Kommentaren beim
Javascript-Code der Funktionen beschrieben.
Die Dateien mit dem
Code sind ein Teil-der Muster-Präsentation, die Sie auf den
eigenen Computer herunterladen können.
Eine Beschreibung
dafür finden Sie im Dokument Tutorial:
Gestaltung einer Web-Präsentation - Herunterladen der
Muster-Verzeichnisstruktur mit den Javascript-Dateien.
In
den einzelnen Abschnitten wird auf Dokumente des Tutorial
für die Gestaltung einer Web-Präsentation wie dieser
verwiesen.
Diese Dokumente enthalten Beispiele, wie die
Javascript-Funktionen in einem HTML-Dokument aufgerufen werden.
Vorbedingungen
Funktion
verifyFramesContent(...)
Funktion
showTranslatedDocument(...)
Funktion
mailComment(...)
Weitere
Schritte und verwandte Dokumentation
Kenntnisse der Programmierung mit Javascript.
Überblick
über den Aufbau der Web-Präsentation; Empfohlen ist das
Durchlesen der Dokumente mit dem Tutorial;
Das
Inhaltsverzeichnis dazu finden Sie unter Tutorial
für die Gestaltung einer Web-Präsentation wie dieser.
Diese
Funktion (in der Datei 'GeneralCode.js') prüft, ob das
anzuzeigende Dokument mit einem Haupt-Inhalt bereits innerhalb des
richtigen HTML-Framework angezeigt wird.
Ob es das 'richtige'
Framework ist, wird durch den Namen der Datei bestimmt, die das
HTML-Dokument für das 'Logo' enthält.
Der Name dieser
Datei wird als Parameter übergeben.
Wenn
noch kein oder ein nicht passendes HTML-Framework aufgebaut ist, wird
das in der Datei 'control_index.html' definierte HTML-Dokument –
das das passende HTML-Framework definiert – angezeigt. Die
Datei mit dem Dokument, das verifyFrameContent(...)
aufgerufen
hat wird als Parameter mitgeliefert und vom HTML-Dokument in der
Datei 'control_index.html' in jenem HTML-Frame, das für die
Anzeige des Haupt-Inhalts vorgesehen ist – angezeigt.
Welches
HTML-Frame für die Anzeige des Haupt-Inhalts vorgesehen ist wird
durch die Variable ContentFrameName
in
der Datei 'FrameworkArray.js' festgelegt.
Wenn
das Dokument mit dem Haupt-Inhalt innerhalb des 'richtigen'
HTML-Frames angezeigt wird, wird als Nächstes festgestellt
welche HTML-Dokumente in den Umgebungs-Frames angezeigt werden
müssen.
Die jeweiligen HTML-Dokumente für die
Umgebungs-Frames hängen von der Sprache und dem Themenbereich
des Dokumentes mit dem Haupt-Inhalt ab.
Wenn notwendig werden die
angezeigten HTML-Dokumente in den Umgebungs-Frames ausgewechselt.
Die
Dateien mit den HTML-Dokumenten für die Umgebungs-Frames sind in
der Datei 'FrameworkArray.js' festgelegt.
Ein
Muster, wie die notwendigen Javascript-Dateien in das HTML-Dokument
eingebunden und die Funktion aufgerufen wird, ist in Tutorial:
Gestaltung einer Web-Präsentation – Erstellen eines
Dokumentes für den Haupt-Inhalt > KompoZer – Aufruf des
Javascript-Programms bei der Anzeige des Dokuments
enthalten.
Parameter
parmLogoFileName:
Mit
diesem Dateinamen wird geprüft, ob bereits das 'passende'
HTML-Framework angezeigt wird.
Dazu wird der im Parameter
übergebene Dateiname mit dem Dateinamen, der das im 'Logo'-Frame
angezeigte HTML-Dokument enthält, verglichen.
Aus diesem
Grund wird empfohlen, für jede individuelle Web-Präsentation
die Dateinamen so zu benennen, dass die Namen der Dateien den Namen
des Projekts der Web-Präsentation enthalten und möglichst
unverwechselbar sind.
Zusätzlich
notwendige Javascript-Dateien
FrameWorkArray.js:
Diese
Datei enthält die variablen Daten für die
Web-Präsentation.
Das sind
* die Namen der Web-Frames für
das 'Logo'-Dokument und die Dokumente mit Haupt-Inhalt
und
*
die Dateien mit den HTML-Dokumenten, die in den Umgebungs-Frames
angezeigt werden.
Diese
Funktion (in der Datei 'GeneralCode.js') sucht, ob es zum angezeigten
Dokument mit dem Haupt-Inhalt eine Übersetzung in der
gewünschten Sprache gibt.
Dazu wird der Dateiname des
Dokuments, das im Web-Frame für den Haupt-Inhalt angezeigt wird,
ermittelt und anschließend das Array mit den Referenzen
zwischen Dokumenten mit gleichem Inhalt in verschiedener Sprache
durchsucht.
Wird kein Dokument in anderer Sprache gefunden wird
ein Dokument mit einer Entschuldigung angezeigt; der Name der Datei
wird als Parameter beim Aufruf der Funktion übergeben.
Welches
HTML-Frame das Dokument mit dem Haupt-Inhalt enthält wird durch
die Variable ContentFrameName
in
der Datei 'TranslationArray_ThemenbereichsVerzeichnis.js'
festgelegt.
Diese Datei enthält auch das Array mit den
Referenzen zwischen den Dokumenten.
In
'TranslationArray_ThemenbereichsVerzeichnis.js'
sind nur die Referenzen zwischen den Dokumenten für den
jeweiligen Themenbereich enthalten.
Die Datei (und das darin
enthaltene Array) ist daher individuell für jeden Themenbereich
zu erstellen und der Teil ThemenbereichsVerzeichnis
des
Dateinamens durch den Namen des Themenbereichs zu ersetzen.
Ein
Muster, wie die notwendigen Javascript-Dateien in das HTML-Dokument
eingebunden und die Funktion aufgerufen wird, ist in Tutorial:
Gestaltung einer Web-Präsentation – Tätigkeiten bei
Web-Präsentationen in verschiedenen Sprachen
enthalten.
Parameter
parmNewLanguage:
Das
ist der Sprach-Code für jene Sprache, in der das Dokument mit
gleichem Inhalt (wie das gerade angezeigte) angezeigt werden soll.
parmNotTranslatedDocument:
Das
ist der Dateiname jenes Dokuments, das angezeigt werden soll wenn
kein referenziertes Dokument für die gewünschte neue
Sprache im Referenz-Array enthalten ist.
Kurz gesagt: dieses
Dokument soll eine Entschuldigung enthalten die den Anwender darauf
hinweist, dass das angezeigte Dokument noch nicht übersetzt ist.
Zusätzlich
notwendige Javascript-Dateien
TranslationArray_ThemenbereichVerzeichnis.js:
Diese
Datei enthält die variablen Daten für das 'Umschalten' zu
anderen Sprachen.
Um das Array nicht zu groß werden zu
lassen, wird für jeden Themenbereich eine eigene Datei
erstellt.
Zur leichteren Unterscheidung wird empfohlen, den Namen
des Verzeichnisses für den Themenbereich in den Dateinamen zu
integrieren.
Diese
Funktion (in der Datei 'MailCode.js') ruft das Programm zum Senden
von E-Mails auf und platziert im Betreff und im Text der E-Mail den
Dateinamen des angezeigten Dokumentes mit dem Haupt-Inhalt.
Die
E-Mail-Adresse des Empfängers wird in leicht verschlüsselter
Form in einem <INPUT> Feld innerhalb des HTML-Dokuments
definiert.
Durch die Verschlüsselung wird Programmen zum
Sammeln von E-Mail Adressen (Mail-Grabbern) unmöglich gemacht,
Spam zu versenden.
Die
Funktion liest die verschlüsselte E-Mail Adresse, die Sprache
für die Anleitungen an den Anwender und den Namen des
HTML-Frames, in dem das Dokument mit dem Haupt-Inhalt angezeigt wird,
und bereitet eine E-Mail vor.
In diese E-Mail kann der Anwender
Kommentare zum angezeigten Dokument hinzufügen und an die
vorgesehene E-Mail Adresse senden.
Ein
Muster, wie die notwendigen Javascript-Dateien in das HTML-Dokument
eingebunden und die Funktion aufgerufen wird, ist in Tutorial:
Gestaltung einer Web-Präsentation – Adaptieren Ihrer
E-Mail Adresse enthalten.
Darin
wird auch beschrieben, wie die Parameter in Feldern einer <FORM>
des HTML-Dokuments definiert und von der Funktion ausgelesen werden.
Parameter
parmLogoFileName:
Mit
diesem Dateinamen wird geprüft, ob bereits das 'passende'
HTML-Framework angezeigt wird.
Dazu wird der im Parameter
übergebene Dateiname mit dem Dateinamen, der das im 'Logo'-Frame
angezeigte HTML-Dokument enthält, verglichen.
Aus diesem
Grund wird empfohlen, für jede individuelle Web-Präsentation
die Dateinamen so zu benennen, dass die Namen der Dateien den Namen
des Projekts der Web-Präsentation enthalten und möglichst
unverwechselbar sind.
Zusätzlich
notwendige Javascript-Dateien
FrameWorkArray.js:
Diese
Datei enthält die variablen Daten für die
Web-Präsentation.
Das sind
* die Namen der Web-Frames für
das 'Logo'-Dokument und die Dokumente mit Haupt-Inhalt
und
*
die Dateien mit den HTML-Dokumenten, die in den Umgebungs-Frames
angezeigt werden.
|
Dokument |
Inhalt |
|
In
diesem Dokument wird beschrieben, wie das Array mit den
Zuordnungen der Dateien mit den HTML-Dokumenten für die
Umgebungs-Frames aufgebaut ist. |
|
|
In
diesem Dokument wird beschrieben, wie das Array mit den
Zuordnungen von Dokumenten mit gleichem Inhalt in verschiedenen
Sprachen aufgebaut ist. |