GLOSSAIRE - Benutzerhandbuch

Willkommen beim Benutzerhandbuch von plugin Glossaire_XH für CMSimple_XH.

I - Beschreibung

GLOSSAIRE zeigt bei Mouseover eine Erklärung von bestimmten Wörtern in Ihrer Webseite. Diese Erklärung darf mit einem Titel beschrieben und auch illustriert sein.

Sobald die geänderte Konfiguration zum ersten Mal für das jeweils benutzte Template gesichert wurde und dadurch funktioniert, rufen Sie das Plugin im Administrator-Modus auf und geben das erste Wort und dessen Erklärung ein.

Wenn Sie den Text auf der jeweiligen Seite lesen, in dem das vorher erklärte Wort vorhanden ist, erscheint die Erklärung bei einem Mouseover wie ein Tooltip.

• Dieses Wort wird z.B. durch eine gepunktete Linie (konfigurierbar) hervorgehoben .
• Die Anzahl der Ereignisse ist konfigurierbar (es erlaubt z.B. nur eine Erklärung beim ersten Auftauchen von diesem Wort) oder aber beim Auffinden jedes Wortes wird der Tooltip ermöglicht.
• Die angezeigte Erklärung ist für jedes Template konfigurierbar.
• Es funktioniert auch auf multilingualen Seiten.
• Mehrsprachige Seiten (für alle unterstützten Sprachen) werden erkannt.
  
  Der Eingriff in den Text erfolgt auf der Ebene des Inhaltes, ist veränderbar und kurz vor Erscheinen der Webseite. Wörterlisten (eine pro Sprache) und die entsprechenden Erklärungen werden im jeweiligen Textformat im Plugin-Ordner 'data' gespeichert.

II - Sprachen

Das Plugin kann mit all den Sprachen zusammenarbeiten, die durch CMSimple_XH unterstützt werden,

der Sprachen-Detektor (erstellte Wörter werden, auch wenn sie mehrfach vorkommen, erkannt) unterstützt zur Zeit diese Sprachen: Da, De, Fr, It, Ru.

Danish (Dänisch): Erstellen Sie das Wort in der Infinitiv-Form. Daher findet der Detektor sowohl die Singular als auch die Pluralformen, wenn diese nicht voneinander abweichen.
Beispiel für: car = bil, die dänischen Wörter "bilen, biler, bilerne" werden genauso erkannt und markiert.

Die Verwaltung ist für verschiedene Sprachen vorhanden (default ist English):

• French
• English (selbst erstellte Übersetzung aus dem Französischen ins Englische. Bitte teilen Sie mir Fehler, die Sie in der Hilfe-Datei finden, mit).
• Deutsch: Übersetzungen und die Hilfe-Datei wurden nach bestem Wissen übersetzt. (Bitte teilen Sie mir Fehler, die Sie in der Hilfe-Datei finden, mit)

Um eine neue Sprache-Datei (=language-file) zu diesem Plugin hinzuzufügen, sind zwei Bedingungen nötig:

• Übersetzung der Sprachdatei.
• Der Plugin-Autor muss die Voraussetzung zum Erkennen der jeweiligen Sprachdatei noch ins Plugin programmieren.

Wenn Sie für die Nutzung des Plugins eine andere Sprache wünschen und planen, kontakten Sie den Plugin-Autor. Sie könen ihm eine eigene Übersetzung der Sprachdatei übersenden. Herzlichen Dank!

2.1 - Gebrauch in einer Multilingual Seite

Das Plugin Glossaire stimmt mit der Philosophie von CMSimple_XH überein. Das Plugin erscheint in der Sprache, die in der CMSimple_XH-Installation eingestellt wurde (in Übereinstimmung mit der Sprache, die durch das Plugin unterstützt wird, wenn es nicht in Englisch ist) und die Worte und die Erklärungen werden in einem speziellen Daten-Ordner des Plugins erstellt. Wenn Ihre Seite z.B. zwei Sprachen beinhaltet (Englisch und Deutsch), werden die Worte in Englisch und ihre Erklärungen im speziellen Daten-Ordner des Plugins data/en/ abgespeichert. Für Deutsch, es ist die deutsche Datei, die im Daten-Ordner des Plugins data/de/ abgespeichert wird.

III - Installation

Kopieren Sie den Inhalt der ZIP-Datei (jeweils neueste Version) in den Ordner plugins/ in Ihrer CMSimple_XH Installation.).

Achten Sie bitte darauf, dass bei allen Ordnern die Dateiattribute = chmod " 705" (statt 755) und bei allen erforderlichen Dateien die Dateiattribute = chmod "604" (statt 644) geändert und eingestellt sind.

Checken Sie dies mit Ihrem FTP-Programm (z.B. FileZilla).

Nutzung des Plugins: Einfach die erste Konfiguration (in der Konfigurations-Seite) für das ausgewählte und genutzte Template sichern. Die template.htm -Datei des genutzten Templates wird durch ein Hinzufügen von init_Glossaire() modifiziert. Eine Kopie der Original-Datei wird als Datei (template.htm.bak) erstellt und gespeichert.

Entsprechend den Beschränkungen Ihres Host-Anbieters, könnten verschiedene Operationen nicht möglich sein. In diesem Fall müssen Sie die Änderungen manuell am template.htm Ihres Templates vornehmen. Fügen Sie den Code vor ?php echo content();? ein.

<?php init_Glossaire(); ?>

Der Pluginaufruf ist so (mit dem Leerzeichen) absolut richtig! Als automatischen Komfort fügt das Plugin den richtigen Code genau hinter das end tag </head> ein.

In der Konfigurations-Seite des Plugins ist es möglich, das Plugin bei einem bestimmten Template zu deaktivieren. Sie sehen das daran, dass in der Box [Plugin-Zustand für diese Vorlage (Template)] es darunter zwei Möglichkeiten gibt: 1. Für das aktuelle Template steht dort: Deaktiviert (validiert die Konfiguration zum Aktivieren) 2. Für ein neu gewähltes Template aus der Box darüber und nach dem Klick auf den Button Speichern ganz unten, erscheint dann "ACTIVE deaktivieren -> " mit einer Checkbox. Diese Checkbox ist für die Deaktivierung vorgesehen.

3.1 - Updates

GLOSSAIRE ist mit dem Updatecheck Plugin (by Holger Irmler) kompatibel, das dem Webmaster anzeigt, ob Updates vorhanden sind.

IV - Konfiguration

Diese Seite erlaubt Ihnen für jedes Template:

• Ausschalten des Plugins auf ihrer Webseite (unterstrichene Worte und die entsprechenden Erklärungen in einem Tooltip).
  
  
• Die Konfiguration der Nummern des Aufrufs werden in der Webseite entsprechend ersetzt.
  Geben Sie die Nummer ein (z.B. 1, wenn Sie nur den ersten definierten Aufruf des erscheinenden Wortes in der Webseite wünschen). Wenn Sie bei allen Worten die definierte Erklärung wünschen, geben Sie -1 (Minus-Zeichen gefolgt von einer Zahl ohne Leerzeichen) ein. [Geben Sie in dieses Feld nichts anderes ein!]
  
  
• Bestimmen Sie die Weite des Fensters der Toolbox (=Tooltip) für die entsprechende Erklärung. Für eine lange Erklärung (vergessen Sie nicht, dass die Erklärungen am Ende der Webseiten in der Quelldatei hinzugefügt werden), und die vorgegebene Weite des Tooltip-Fensters unzureichend erscheint, wird dieser Rahmen zu groß gezogen.
  
  Zwei Weiten sind konfigurierbar: Die erste vorgegebene Weite des Tooltip-Fensters [default] ist die Weite die für alle Erklärungen gezeigt wird. 20em ist normalerweise ein guter Wert, aber auch diesen können Sie ändern.
  
  Warum "em" und nicht "px"? "em" ist eine relative Einheit, die es erlaubt Text zu skalieren. Die Toolbox für die Erklärung behält ihre Proportionen bei, auch wenn der Besucher den Text im Browser zoomt. Der zweite Wert ist auf 30em [default] voreingestellt. Wenn Sie dies ändern, wird bei der Weite der Toolbox in Verbindung mit den Erklärungen ein Check als Option vorausgesetzt und zum Zeitpunkt der Veröffentlichung durchgeführt.
  
  
• Übereinstimmung im Moment des Auftretens der gezeigten Erklärung. Das Wort wird mit einer einfachen, gestrichelten oder gepunkteten Linie unterstrichen, und Sie können die Farbe wählen.
  
  
• Übereinstimmung im Moment des Auftretens der gezeigten Erklärung. Eine Vorschau im Moment des Auftretens der gezeigten Erklärung erlaubt Ihnen, sofort Ihre gewählten Einstellungen zu betrachten.

Sie werden die Option bemerken und können das Template gegenüber dem voreingestellten Template [default] entsprechend ändern. In diesem Fall wird die Webseite mit dem neu ausgewählten Template geladen. Das erlaubt Ihnen, die Erklärungen für den Tooltip einfacher mit Hilfe einer Vorschau zu vergleichen und ob das die gewünschte und richtige Form ist. (Diese Vorschau zeigt sofort die Einstellungen im Teil AUSSEHEN der DEFINITIONEN im Teil "Konfiguration"). Auch wenn diese Form validiert wurde, ist das Template noch immer auswählbar und wird angezeit. Sie können daher auch ein anderes Template für eine andere Webseite wählen.

Wichtig: So lange die Konfiguration des Templates nicht validiert wurde, wird das Plugin für Besucher nicht arbeiten.

Tipp: Geben Sie aufgrund des Feldes kurze Erklärungen an.

V - Wörter und Erklärungen

Auf dieser Seite werden die Listen zu Wörtern und den mit ihnen verbundenen Erklärungen verwaltet.

5.1 - Die Liste der Wörter

Es zeigt existierende Wörter, Zugang zur Bearbeitung oder Erstellung von Wort und zugehöriger Erklärung, es erlaubt aber ebenso das einfache Entfernen vom Wort und zugehöriger Erklärung.

5.1.1 - Die Filter

Diese kommt in Form einer alphabetischen Liste.
Wenn Sie einen Buchstaben aus dieser Filterliste anklicken, werden aus der Tabelle die speziellen Wörter-Dateien herausgefiltert und in entsprechender alphabeitscher Reihenfolge in der Wörterliste aufgelistet.

5.1.2 - Sortierung

Jede Spalte in der Tabelle hat eine Überschrift (Id oder Worte), die einen Link zur Sortierung besitzen. Sie können die Tabelle nach den Id-Nummern oder nach den von Ihnen vergebenen Worten sortieren lassen. Je nach Sortierung wird dann entweder "Id" oder "Worte" durch einen Unterstrich hervorgehoben. (Die alphabetische Sortierung bzw. Abkürzungen werden zuerst angezeigt). Die Größe der Tabelle ist beschränkt. Wenn die Anzahl der Wörter so zunimmt, dass sie die Tabellenbegrenzungen überschreitet, können Sie trotzdem in der Tabelle sich die einzelnen Zeilen anzeigen lassen, indem sie mit dem Mausrad oder durch Nutzung des Scrollbars an der rechten Seite durch die Liste browsen. Die Nutzung von Filtern reduziert die Anzahl der gezeigten Zeilen.

5.1.3 - Die Liste

Die Liste hat eine Spalte für Id und eine für Wörter. Am Ende der Zeile sehen Sie noch ein Symbol für Löschung/en (Papierkorb mit rotem X). Eine Checkbox am Ende jeder Zeile wird dazu genutzt, um ein oder mehrere Wörter für die Löschung auszuwählen. Wird das erste Häkchen in der Checkbox gesetzt, wird die ausgewählte Zeile rot eingefärbt und gleichzeitig wechselt die letzte Zeile der Tabelle von "Erstelle ein Wort" nun zu "1 gewählt" und "Löschen". Es können auch mehrere Worte gleichzeitig gewählt werden. Es muss dazu immer die Checkbox angeklickt werden. Ein Klick auf den Button "Löschen" bewirkt, dass die ausgewählten Dateien im Plugin-Ordner /data/ gelöscht werden. Löschen eines Wortes zieht auch die Löschung der dazugehörenden Erklärung nach sich.

5.2 - Erstellung von Wort und Erklärung

Am Ende der Liste, klicken Sie auf "Erstelle ein Wort".

Sie sind jetzt auf der Seite "WORT und DEFINITION", wohin Sie das Wort schreiben, den Titel der Erklärung (optional)*, und die Erklärung selbst.

Bezüglich des Titels, ist es der Titel für die Erklärung. *Haben Sie keine Titel-Ärea, lassen Sie das Feld leer.

Eine Id wird oben auf der Seite angezeigt. Diese ist die Nummer, die das Wort und die Erklärung identifiziert. Das Wort, ist nicht editierbar.

Fügen Sie in die Felder WORT und TITEL kein HTML-Code oder anderes hinein. Schreiben Sie die Texte in diesen beiden Feldern mit Ihrer Tastatur. Benutzen Sie z.B. nicht copy/paste. Das ist besonders für Sonderzeichen sehr wichtig.

Anmerkung: Die Untersuchung des einzelnen Webseite durch das Plugin ist nicht "abhängig von Groß-/Kleinschreibung". Also, für Abkürzungen (z.B.: A.B.C.D. oder ABCD) und nur in diesem Fall, wird sich die Suche NUR auf Großbuchstaben beziehen (a.b.c.d. oder abcd werden nicht gefunden werden).

DEFINITION: Der Editor (abhängig von der Wahl die der Admin von CMSimple_XH machte) erlaubt Ihnen die Erklärung zu erstellen. Sie können ein Bild platzieren (beachten Sie die Erklärung, dass es nicht sehr weit dargestellt werden kann. Deshalb benutzen Sie ein kleines Bild, weil es sonst verkleinert gezeigt wird).

Die Farben (Titel, Texte und ihre Hintergründe), Zeichensatz, Randfarben sind in einem weiteren Teil der Konfigurationsseitekonfigurierbar.

Unten, kurz vor dem Speichern-Button, erlaubt eine Checkbox, dass die Weite des Festers definiert werden kann.

Eine andere Option erlaubt Ihnen das Verhalten des Tooltips während des Mouseovers einzustellen. Wenn es ausgewählt ist, wird der Tooltip mit der Erklärung nach dem Mouseover eingefroren bleiben. Ein Wahlbutton befindet sich in der rechten oberen Ecke. (Es wird geschlossen, wenn ein anderer Tooltip gezeigt wird). Ohne diese Option wird der Tooltip sofort geschlossen, wenn der Mauscursor nicht mehr über dem Wort ist.
Dies kann z.B. bei Texten mit Verknüfungen (links) sehr hilfreich sein.

Wenn die Form ausgefüllt ist, klicken Sie auf "Speichern" am Ende der Seite.

Nun sind Sie zurück in der Liste von Worten und es erscheint in dieser Liste das Wort, das Sie gerade erstellt haben.

5.3 - Sound und Video

Zuerst müssen Sie realisieren, dass wenn ein Wort in der Webseite erklärt wird, diese Erklärung zwangsläufig an das Ende der Seite verschoben wird. Sogar wenn ein Wort mit Erklärung nicht im Webseitentext auftaucht, ist der definierte Inhalt trotzdem im Seiten-code enthalten. Im dem Fall, in dem Sie eine Audio- oder Video-Datei in eiem Player abspielen möchten, kommen diese Probleme zu Tage:

• Wie wird das automatische Abspielen gestartet?
• Wie wird es gestoppt, wenn die Erklärung geschlossen wird?

Das Script Glossary kann einen Player steuern, wenn dieser von Javascript kontrolliert wird. Es ruft automatisch zwei Funktionen auf, eine zum Abspielen, wenn der Tooltip auftaucht, die andere zum Stoppen, wenn der Tooltip geschlossen wird. Sie müssen eine Javascript-Datei mit dem Namen erstellen: fonct_util.js und diese kopieren Sie in den js Ordner des Plugins (plugins/glossaire/js/). Es sollte die folgende Funktion beeinhalten und muss auch noch an den benutzten Player angepasst werden:

Für das Playback: demLect(id)
Zum Stoppen: stopLect(id)

dort, wo die Id ist die Id des Objektes beim Player. Es wird eine Id zu Ihrem Objekt-Kennzeichen des Players wie folgt hinzugefügt: vidgpop + the id number des entsprechend gewählten Wortes (die Id ist oberhalb der Form Erstellen/Bearbeiten des Wortes zu finden).

Zum Beispiel, der Tooltip mit der Id Nummer 35, soll <object id="vidgpop35" > sein ...

5.3.1 - Konkretes Beispiel

• 1) Wahl des Vorlesers / der Vorleserin (oder 'Players')
  Diese sind Flash-Player. Der Vorteil ist, dass sie es serverseitig finden (auf Ihrer Webseite, so) und es wird es in nahezu allen Konfigurationen auf dem Bildschirm erscheinen. Für Video ist es der flv player :
  http://flv-player.net/players/maxi/preview/ und für Audio, Flash mp3 player:
  http://flash-mp3-player.net/fr/players/maxi/ Beide wurden vom selben Autor gut dokumentiert, was von Vorteil ist, weil die Javascript Kommandos die selben sind.
  
  
• 2) Installationsdateien
  Downloaden Sie die Player und laden Sie diese in den Ordner userfiles/media/ auf ihrem Serrver.
  
  
• 3) Erstellen Sie die Datei fonct_util.js
  Sie können hierfür einen Editor nutzen, weil dies eine einfache Textdatei ist, erstellt mit dem Windows Notepad.
  Rechts Klick, Neu (new), Textdokument, öffnen Sie es und kopieren Sie mit copy 'n paste den folgenden Code:

  function demLect(id){
  var elt= document.getElementById(id);
  if (elt != null) elt.SetVariable("player:jsPlay", "");
  }
  function stopLect(id){
  var elt= document.getElementById(id);
  if (elt != null) elt.SetVariable("player:jsStop", "");
  }

  
  Sichern Sie die Datei und benennen Sie diese in fonct_util.js um.
  Zum Schluss laden Sie diese Datei in den js Ordner vom Plugin Glossaire (plugins/glossaire/js/)
  
  Das Glossaire-Script ist zur Erkennung der Präsenz einer Datei verantwortlich und nutzt die Functionen demLect und stopLect wenn die die Zeit kommt.
  
  
• 4) Fügen Sie den Video-Player in die Erklärung ein.
  Z.B., ein Wort, desssen id ist 43 (diese Id erscheint in der Liste der Wörter). Eine Video-Datei mit der Dateiendung .flv wird in diesen Tooltip eingefügt. Die Videodatei wird video.flv (in diesem Beispiel) genannt, und wird in den Ordner userfiles/media/ kopiert. m flv -Dateien zu erstellen, gibt es freie Konverter. Hier ist ein Beispiel:
  
  Free FLV Converter on http://www.koyotesoft.com/
  
  Wird in den Tooltip Code mit der Id vidgpop43 eingefügt, ergänzen Sie dies:

  <object id="vidgpop43" type="application/x-shockwave-flash" data="./userfiles/media/player_flv_maxi.swf" width="320" height="240">
   <param name="movie" value="userfiles/media/player_flv_maxi.swf" />
   <param name="FlashVars" value="flv=video.flv" />
   </object> 

  
  Die Pfade können relativ zur Installation auf der Seite und to the root of the site, as above. The path of the flv file, meanwhile, is relative to the location of the player.
  
  Im Fall einer multilingualen Seite: Wenn dies nicht die Primärsprache ist, ergänzen Sie ../ vor userfiles/ dieses:
  

  ".././userfiles/media/player_flv_maxi.swf"

  
  Wichtige Erinnerung: Zum Einfügen in einen Tooltip muss eine Sachmarkierung (tag) hinzugefügt werden, die die gleiche Id hat wie die Id des betroffenen Wortes hat (hier vidgpop43). Dies ist die Id, die die Funktionen demLect und stopLect gezielt aufruft.
  
  
• 5) Einfügen eines mp3-Players
  Kopieren Sie eine mp3-Datei in den Ordner userfiles/media/ (und den Player, wenn dies noch nicht geschah). Dies gilt ebenso für Video-Dateien. Der Auswahl-Code, der für das ausgewählte Wort mit der Id 45 in die der Tooltip eingefügt wird und die zugehörige Id zu diesem Objekt wird zu vidgpop45 (z.B. heißt die mp3-Datei dann eagles.mp3):

  <object id="vidgpop45" type="application/x-shockwave-flash" data="./userfiles/media/player_mp3_maxi.swf" width="200" height="20">
   <param name="movie" value="userfiles/media/player_mp3_maxi.swf" />
   <param name="FlashVars" value="mp3=eagles.mp3" />
   </object>

  Abschließend, kann mit einer Option der Tooltip, in die ein Audio-/Video-Player eingefügt wurde, eingefroren werden (am Ende der Seite [Glossaire - Worte und Definitionen], in der Sie die Wörter und Erklärungen eingeben) Der Button zum Schließen, der in dem Tooltip rechts oben auftaucht, beendet dann das Playback.

VI - Drucken

Wenn Sie eine Webseite drucken, wird jedes hervorgehobene und für das Plugin definierte Wort mit einer Verknüpfung (Link) am Ende der Webseite platziert (die unterschiedliche Unterstreichung erscheint jedoch nicht notwendigerweise in der Vorschau; das hängt mit den Definitionen in CSS des Templates zusammen). Die verschiedenen Erklärungen (zu den unterschiedlichen Wörtern) können dadurch gehäuft unter dem Titel "Glossary" aufgelistet werden. Wurde der Druck als PDF initiert, so sind diese Verknüpfungen (links) immer noch aktiv und fungieren wie eine Sprungmarke (anchor).

Beachten Sie: Eine Webseite beinhaltet auch beim Drucken also alle mit dem Plugin glossary (glossaire) definierten und erklärten Worte. Die Zahl der gedruckten Seiten wird deshalb in Abhängigkeit der Länge der Erklärungen für die Tooltips sein. In solchen Fällen macht es Sinn, sich auf kurze Erklärungen zu beschränken.

Diese Erklärungen werden are trotzdem in zwei Spalten mit einem verkleinerten Zeichensatz dargestellt.

VII - Deinstallieren

Auf der Konfigurationsseite, deaktivieren Sie das Plugin für jedes Template in der Liste.

Das meint das Löschen von init_Glossaire() in der template.htm jedes einzelnen Templates.

Dann löschen Sie alle Dateien des Plugins auf dem Server. Das bedeutet, dass der komplette Ordner "glossaire" im Verzeichnis Plugins zu löschen ist.

VIII - Download

Sie können das Plugin Glossaire_XH für CMSimple_XH hier downloaden.

IX - Lizenz

Glossaire_XH ist eine GPLv3.

Lizenz.

© 2016 Ludovic AMATHIEU

TOP