Update documentation files

Author: benkfra

doc/CoDeSys_Visu_V23_D.pdf

@@ -29,6 +29,16 @@ Aufruf des Release-Skript:
 Daraufhin werden im Verzeichnis /trunk/release die beiden Dateien 
 "WebVisu.html" und "WebVisuPlus.html" neu erzeugt.
 
+Dem Skript "release.sh" kann optional der Parameter "HTMLTITLE=" mitgegeben
+werden. Dieser setzt den Titel des erzeugten HTML-Files auf den übergebenen
+Wert.
+
+Beispiel:
+```bash
+./release.sh HTMLTITLE=WebVisu5
+```
+
+
 ### Ablauf des Releaseprozesses
 Der Releaseprozess läuft intern zwei mal ab. Für jede Ergebnisdatei ein mal.
 Während des Releaseprozess werden zunächst die Dateien mit der Endung "\*.pp.*"
@@ -177,10 +187,10 @@ Durch diesen Mechnismus werden drei Hauptprobleme erschlagen:
   mehr als Klick-Bereich ausgewertet.
 - Klick-Regionen mussten immer rechteckig sein. Kreise oder Polygone werden
   jetzt ausgewertet wie gezeichnet.
-- Bei mehreren Klich-Aktionen pro Element können diese jetzt schneller 
+- Bei mehreren Klick-Aktionen pro Element können diese jetzt schneller 
   ausgewertet werden.
 
-Um die Objekt-ID in einer Farbe kodieren zu kodieren werden die 24 Bit des 
-Farbwertes als 24 Bit Integer verwendet. Die ersten 255 Elemente verwenden 
-entsprechend nur den Blau-Anteil, danach kommt Grün und danach Rot hinzu.
+Um die Objekt-ID in einer Farbe zu kodieren werden die 24 Bit des Farbwertes
+als 24 Bit Integer verwendet. Die ersten 255 Elemente verwenden entsprechend
+nur den Blau-Anteil, danach kommt Grün und danach Rot hinzu.
 Der Farbwert 0xFFFFFF ist dem Hintergrund zugeordnet. 

doc/DEV_GUIDE_DE.md

@@ -1,6 +1,7 @@
-# Developer Guide 
-(English translation from German v0.1 by Aliazzz)
+# Developer Guide (English)
 
+## Credits
+The initial english translation was done by Aliazzz - thanks for your great work!
 
 ## Build WebVisu.html
 To generate WebVisu.html from the source files you will need
@@ -31,6 +32,13 @@ Call the release script:
 After calling the release script both the files 
 "WebVisu.html" and "WebVisuPlus.html" are generated in /trunk/release
 
+The script "release.sh" can optionally be given the parameter "HTMLTITLE=".
+This sets the title of the generated HTML file to the passed value.
+
+Example:
+```bash
+./release.sh HTMLTITLE=WebVisu5
+```
 
 ### Internal working of the Release process
 The Release process internally runs twice. For every result file once.
@@ -86,7 +94,7 @@ or
 - http://[IP_ADDRESS_OF_PLC]/WebVisuDev.html
 
 
-### Test unter Linux
+### Test under Linux
 In directory /trunk/tools a minimalistic Python2 Webserver can be found. 
 Difference with the Python-Documentation example lies in a changes ("Hacks") 
 that ignore smaller and larger abnormalities in the incomming data.
@@ -112,3 +120,70 @@ with "Hallo".
 
 For testing the Firefox-Developpersconsole can be used.
 
+## Arguments in the URL
+The WebVisu can be influenced by arguments in the URL.
+How arguments are encoded in URLs should be clear, here again a Example as a
+reminder:
+
+- http://localhost:8080/src/WebVisuDev.pp.html?firstArg=1&secondArg=2&thirdArg=3
+
+The first argument is separated with a "?", each additional argument with a "&".
+
+- startVisu=...
+
+  Sets the visualization file to be loaded as the beginning.
+  Default: "plc_visu"
+
+- plcDir=...
+
+  Overwrites the automatic recognition of the PLC directory with the 
+  specified value.
+
+- postUrl=...
+
+  Overrides the automatic recognition of the variable connection to the 
+  target.
+
+- logOverlayWriteout
+
+  Activates a mini log window in the upper right corner. For browsers that
+  do not provide a console.
+
+- perfWriteout
+
+  Activates a small performance window in the upper left corner in which the
+  times required for loading and updating the screen or the variables are 
+  displayed.
+
+- useTouchEvents or dontUseTouchEvents
+
+  Overrides the automatic detection of touch events and activates or deactivates
+  them.
+
+- doPerfTest
+
+  Activates a small performance test. However, it is only used for development.
+
+## Click handling (from r84)
+With version r84 the handling of mouse clicks has been completely revised. 
+Previously, click regions were determined on load and each of them was compared
+in the handler functions with the point of the mouse events.
+Since r84, click handling has been object-related and no longer works with 
+coordinates, but with an invisible bitmap. During the graphical output of the
+elements (on the browser) each element is also drawn on this invisible bitmap. 
+The difference is that on the invisible bitmap each element is filled with a
+certain color. This colour corresponds to the object ID.
+During a mouse event, the (invisible) click bitmap now shows the color of the
+point under the mouse and from this color the object ID is recalculated. The
+click handler then knows which element was clicked.
+This mechanism solves three main problems:
+- Invisible elements are not drawn and therefore not detected anymore
+- Click regions must always be rectangular. Circles or polygons become
+  now evaluated correctly.
+- If there are several click actions per element, they can now be evaluated 
+  much faster. 
+
+To encode the object ID in a color, the 24 bits of the color value are used as
+a 24 bit integer. While the first 255 elements only using the blue portion,
+the other elements are using the green and then the red portions.
+The color value 0xFFFFFFFF is assigned to the background. 

doc/DEV_GUIDE_EN.md

@@ -1,10 +1,10 @@
 Mouse vs. Touch
 ----------------
 
-Wie im Blockbeitrag [1] sehr sch�n ausgef�hrt gibt es einen gro�en Unterschied 
+Wie im Blockbeitrag [1] sehr schön ausgeführt gibt es einen großen Unterschied 
 zwischen Mouse-Events und Touch-Events.
 
-Die "nat�rliche" Reihenfolge der Events ist
+Die "natürliche" Reihenfolge der Events ist
 1. touchstart
 2. touchmove
 3. touchend

doc/mouse_vs_touch.txt

@@ -2,16 +2,16 @@ Kommunikation mit dem CoDeSys Webserver
 =======================================
 
 Der CoDeSys Webserver auf der Steuerung lauscht auf POST-Requests auf der URL 
-"/plc/webvisu.htm" und beantwortet diese jeweils abh�ngig von der Anfrage.
+"/plc/webvisu.htm" und beantwortet diese jeweils abhaengig von der Anfrage.
 
 Die POST-Daten werden dabei als Zahlenkolonne, getrennt mit einem Pipe "|" 
-�bertragen. Die Antwort besteht ebenfalls aus Zahlen mit Pipe getrennt.
+uebertragen. Die Antwort besteht ebenfalls aus Zahlen mit Pipe getrennt.
 
 Eine Anfrage zum Lesen besteht aus
 	- Befehl (0)
 	- Anzahl Werte
 	und Anzahl Werte mal
-		- Z�hler (0-based)
+		- Zaehler (0-based)
 		- Adresse
 
 Antworten auf Leseanfragen
@@ -22,7 +22,7 @@ Antworten auf Leseanfragen
 Schreibende Anfragen
 	- Befehl (1)
 	- Anzahl Werte
-		- Z�hler (0-based)
+		- Zaehler (0-based)
 		- Adresse
 		- Wert
 
@@ -47,10 +47,10 @@ die Laufzeit-Interne Adressierung ab. Die Bedeutung ist (glaube ich)
 	RefId, Offset, Size, [unbekannt]
 und ist nur vom Compiler zuordenbar. Es gibt auch Symboldatenbanken,
 jedoch habe ich damit noch nichts gemacht.
-RefId und Offset interessieren uns nicht - die m�ssen wir nur immer 
+RefId und Offset interessieren uns nicht - die muessen wir nur immer 
 dem Webserver geben. Die Size (in Bytes) ist interessanter, da daran die 
-zur�ckgelieferten Werte richtig einkategorisiert werden k�nnen.
-Den letzten Wert beachte ich aktuell nicht; er k�nnte aber den Datentyp
+zurueckgelieferten Werte richtig einkategorisiert werden koennen.
+Den letzten Wert beachte ich aktuell nicht; er koennte aber den Datentyp
 angeben (siehe 3S-Doku Symbolic CDG.pdf, enum TypeClass):
 	0 = TYPE_BOOL
 	1 = TYPE_INT
@@ -84,7 +84,7 @@ Variablen abfragen
 Um Variablenwerte zu erfragen muss man dem Server folgenden Befehl
 senden:
 
-	|0| [Anzahl Werte] | [Z�hler] | [Adresse] | [Z�hler] | [Adresse]
+	|0| [Anzahl Werte] | [Zaehler] | [Adresse] | [Zaehler] | [Adresse]
 
 Beispiel
 
@@ -109,7 +109,7 @@ Will man mehrere Variablen abfragen sieht das z.B. so aus:
 	|5|4|146|2|1	// plc_visu.xml PLC_PRG.counter
 	|
 
-	nat�rlich ohne Kommentare und ohne Zeilenumbr�che:
+	natuerlich ohne Kommentare und ohne Zeilenumbrueche:
 
 	|0|6|0|4|572|4|5|1|4|398|2|1|2|4|272|41|8|3|4|231|41|8...
 
@@ -119,7 +119,7 @@ Variablen setzen
 
 Zum Setzen der Variablen sendet man den Befehl "1":
 
-	|1| [Anzahl Werte] | [Z�hler] | [Adresse] | [Wert] |...
+	|1| [Anzahl Werte] | [Zaehler] | [Adresse] | [Wert] |...
 
 Beispiel