[Lada-commits] [PATCH 1 of 2] Moved README to a markdown file, fixed typos in INSTALL.markdown
Wald Commits
scm-commit at wald.intevation.org
Fri Jul 24 11:10:48 CEST 2015
# HG changeset patch
# User Dustin Demuth <dustin at intevation.de>
# Date 1437728680 -7200
# Node ID 44e970cec920ee0dc3fe0974ad8962172c7fa303
# Parent 237bca579fc7d4808895f39039a90106e12d3462
Moved README to a markdown file, fixed typos in INSTALL.markdown
diff -r 237bca579fc7 -r 44e970cec920 INSTALL.markdown
--- a/INSTALL.markdown Thu Jul 23 17:43:06 2015 +0200
+++ b/INSTALL.markdown Fri Jul 24 11:04:40 2015 +0200
@@ -11,19 +11,19 @@
Hinweis: Für den Betrieb einer vollständigen Installation ist neben dem
Klienten auch die Installation eines Servers und entsprechender Datenbank
notwendig. Für die Installation des Servers folgen Sie bitte den Hinweisen in
-der README Datei des Server-Pakets. Siehe Projektwebseite. Optional: Die
-Authentifizierung kann gegen einen LDAP-Server durchgeführt werden. Beispiele
-finde sich in dem Installationbeispiel.
+der README Datei des Server-Pakets.
+Weitere Information finden Sie auf der Projektwebseite:
+http://wald.intevation.org/projects/lada
Die folgenden Hinweise beziehen sich auf die Installation und Einrichtung auf
Basis eines Oracle-RedHat Linux Systems.
-Der Lada-Client ist eine Anwendung die auf dem Framework extJs 4.2.1 basiert,
-Damit der Client funktiniert müssen Sie dieses Framework herunterladen und
+Der Lada-Client ist eine Anwendung die auf dem Framework ExtJs 4.2.1 basiert,
+Damit der Client funktioniert müssen Sie dieses Framework herunterladen und
entpacken. Dies kann direkt in das root-Verzeichnis des Lada-Clients geschehen.
Für Applikationen die ebenfalls unter der GPL lizenziert wird - so wie der Lada
-Client - kann extJs als [GPL Version heruntergeladen](http://cdn.sencha.com/ext/gpl/ext-4.2.1-gpl.zip)
+Client - kann ExtJs als [GPL Version heruntergeladen](http://cdn.sencha.com/ext/gpl/ext-4.2.1-gpl.zip)
werden.
Legen Sie nach dem Entpacken einen Symlink auf dieses Verzeichnis an:
@@ -36,7 +36,8 @@
Zum Kompilieren der Anwendung kommt das Tool Sencha Cmd 4.0.x zum Einsatz.
Mit Hilfe dieses Tools kann der Quellcode in eine einzelne Datei zusammengefasst
-und minifiziert werden. Dies beschleunigt das Laden der Anwendung im Browser erheblich
+und minifiziert werden. Dies beschleunigt das Laden der Anwendung im Browser
+erheblich
Sencha bietet Sencha Cmd zum [Download](https://www.sencha.com/products/extjs/cmd-download/)
an. Beachten Sie: Sencha Cmd ist keine freie Software.
@@ -59,7 +60,7 @@
```
Ersetzen Sie heirbei `$PATHTOSENCHACMD` mit dem Pfad zu Ihrer Installation von
-Sencha Cmd. $PATHTOEXTJS gibt den Pfad an, an dem sich Ihre Kopie von extJs
+Sencha Cmd. $PATHTOEXTJS gibt den Pfad an, an dem sich Ihre Kopie von ExtJs
befindet.
@@ -79,8 +80,9 @@
| resources/lib/* (alles ausser ext Ordner) | build/resources/lib |
-Um OpenLayers als "Single File" Version bereit zu haben, gehen Sie in das Verzeichnis
-`build/resources/lib/OpenLayers` und führen Sie den folgenden Befehl aus:
+Um OpenLayers als "Single File" Version bereit zu haben, gehen Sie in das
+Verzeichnis `build/resources/lib/OpenLayers` und führen Sie den folgenden Befehl
+aus:
```
python build.py
@@ -104,7 +106,7 @@
der Option `LoadModule` angegeben. Folgende Module werden benötigt:
* headers_module: Setzten der Header nach der Authentifizierung
- * proxy_module: Reverse Proxy des Apache zum Jboss-Server
+ * proxy_module: Reverse Proxy des Apache zum Lada-Server
### Einrichtung der Anwendung
@@ -153,15 +155,18 @@
CustomLog logs/lada-access_log common
# Set multiple Proxys
- ProxyPass /lada/server http://localhost:8080/lada
- ProxyPassReverse /lada/server http://localhost:8080/lada
+ ProxyPass /lada/server http://LADASERVER/lada
+ ProxyPassReverse /lada/server http://LADASERVER/lada
</VirtualHost>
```
-Alle Anfragen an die Adresse `/lada/service`, werden nun an den Server weitergeleitet.
+Alle Anfragen an die Adresse `/lada/service`, werden nun an den Server
+weitergeleitet.
### Authentifizierung
-Die Authentifizierung geschieht gegen einen OpenID-Server.
+Die Authentifizierung geschieht derzeit gegen einen OpenID-Server.
+Früher Ansätze nutzten LDAP, in Zukunft soll auch Authentifizierung via SAML2
+möglich sein.
Der Lada-Client leitet in Zusammenarbeit mit dem Server automatisch an diesen weiter.
@@ -202,7 +207,7 @@
Die aufgeführten Bibliotheken können über den Link zu Github als zip-Datei
heruntergeladen werden.
-Dabei ist auf die korrekte Versionnummer zu achten, falls dies in der Liste
+Dabei ist auf die korrekte Versionsnummer zu achten, falls dies in der Liste
oben angegeben wurde.
```
@@ -233,7 +238,7 @@
```
Zum einfacheren Zugriff auf die Bibliothek, symbolische Links erstellen.
-Dies is praktisch wenn die Bibliothek ausgetauscht wird,
+Dies ist praktisch wenn die Bibliothek ausgetauscht wird,
dann müssen die Quelltexte nicht angepasst werden
```
diff -r 237bca579fc7 -r 44e970cec920 README
--- a/README Thu Jul 23 17:43:06 2015 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,99 +0,0 @@
-Lada-Client
-===========
-Dies ist die Prototypversion eines EXTJS basierten Klienten für die
-Verarbeitung von Labordaten (Lada) zur Überwachung der Umweltradioaktivität.
-
-Die Software bietet grundlegende Funktionalität zur Erfassung und Bearbeitung
-von Messdaten. Weitere Informationen finden sich auf der Projektwebseite unter
-der Adresse:
-
- https://wald.intevation.org/projects/lada/
-
-Die Software entstand im Rahmen einer Software Entwicklung durch die
-Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz im Jahre 2013.
-
-Kontakt
--------
-Bundesamt für Strahlenschutz
-SW2 Notfallschutz, Zentralstelle des Bundes (ZdB)
-Willy-Brandt-Strasse 5
-38226 Salzgitter
-info at bfs.de
-
-Lizenz
-------
-Die Software unter der GNU GPL v>=3 Lizenz verfügbar. Details siehe die Datei
-COPYING.
-
-Quelltext
----------
-Die Quelldateien lassen sich wie folgt auschecken:
-hg clone https://scm.wald.intevation.org/hg/lada/lada-client
-
-Dokumentation
--------------
-Die Dokumentation wird mit dem Tool JSDuck erzeugt.
-Im Wurzelordner lässt sich nach der Installation von JSDuck dann mit dem
-Befehl "jsduck" die Dokumentation für den Lada-Clienten erzeugen.
-Die Dokumentation findet sich nach der Generierung in dem Order "doc".
-Einstiegseite ist die Seite template.html.
-
-JSDuck ist unter der Adresse
-
-https://github.com/senchalabs/jsduck
-
-zu finden und muss installiert werden.
-
-Einstellung bezüglich der Generierung der Dokumentation ist in der Datei
-jsduck.json hinterlegt.
-
-Entwicklung
------------
-Für die Entwicklung ist es notwenig in dem Wurzelordner die ExtJS-Bibliothek
-in der Version >=4.2.0 unter dem Namen "extjs" zur Verfügung zu stellen.
-
-Diese lässt sich unter der folgenden URL herunterladen:
-http://cdn.sencha.com/ext/gpl/ext-4.2.0-gpl.zip
-
-SHA1 Checksum: 2ce990d9e90c48a76078e8533c72b5452f9ed809
-
-Beispiel:
-curl -O http://cdn.sencha.com/ext/gpl/ext-4.2.0-gpl.zip
-unzip ext-4.2.0-gpl.zip
-ln -s ext-4.2.0-gpl extjs
-
-Zusätzlich wird für diese Anwendung eine Bibliothek zur Internationalisierung
-verwendet, die unter der URL
-
-https://github.com/elmasse/Ext.i18n.Bundle
-
-verfügbar ist, verwendet.
-Der darin enthaltene Ordner 'i18n' muss in dem Ordner 'resources' der Anwendung
-eingebunden werden. Dazu wird der Ordner 'i18n' in den Ordner 'resources' kopiert
-oder verlinkt.
-
-Build
------
-Die Anwendung wird mit Hilfe des von Sencha bereitgestellten Tools 'Sencha Cmd'
-compiliert und minifiziert. Vorbedingung für den Compilevorgang ist die unter
-Entwicklung beschriebene Verzeichnisstruktur.
-
-Sencha Cmd kann unter der URL
-
-http://www.sencha.com/products/sencha-cmd/download
-
-heruntergeladen und dann installiert werden.
-
-Mit dem folgenden Befehl kann dann der Lada-Client compiliert und minifiziert werden:
-
-sencha -sdk /path/to/extjs compile \
- -classpath=app,app/view/widgets/resources/datetime page -yui \
- -in index.html -out build/index.html
-
-Dies erzeugt in dem Ordner 'build' die minifizierte Version der Anwendung, die
-alle benötigten Klassen der ExtJS Bibliothek beinhaltet und eine entsprechende
-index.html, die zur Auslieferung in einem Webserver verwendet werden kann.
-
-Installation
-------------
-Für Informationen zur Installation schauen Sie in die INSTALL Datei.
diff -r 237bca579fc7 -r 44e970cec920 README.markdown
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown Fri Jul 24 11:04:40 2015 +0200
@@ -0,0 +1,79 @@
+Lada-Client
+===========
+Dies ist eine Kopie des ExtJS basierten Klienten für die
+Verarbeitung von Labordaten (Lada) zur Überwachung der Umweltradioaktivität.
+
+Die Software bietet Funktionalität zur Erfassung und Bearbeitung
+von Messdaten. Sowie der Planung der Messungen.
+
+Weitere Informationen finden sich auf der Projektwebseite unter
+der Adresse: https://wald.intevation.org/projects/lada/
+
+Die Software entstand im Rahmen einer Software Entwicklung durch die
+Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz in den Jahren 2013
+bis 2015.
+
+Kontakt
+-------
+Bundesamt für Strahlenschutz
+SW2 Notfallschutz, Zentralstelle des Bundes (ZdB)
+Willy-Brandt-Strasse 5
+38226 Salzgitter
+info at bfs.de
+
+Lizenz
+------
+Die Software ist unter der GNU GPL v>=3 Lizenz verfügbar.
+Details siehe die Datei `COPYING`.
+
+Quelltext
+---------
+Die Quelldateien lassen sich wie folgt auschecken:
+```
+hg clone https://scm.wald.intevation.org/hg/lada/lada-client
+```
+
+Dokumentation
+-------------
+Die Dokumentation wird mit dem Tool JSDuck erzeugt.
+Im Wurzelordner lässt sich nach der Installation von JSDuck dann mit dem
+Befehl `jsduck` die Dokumentation für den Lada-Klienten erzeugen.
+Die Dokumentation findet sich nach der Generierung in dem Order `doc`.
+Einstiegsseite ist die Seite `template.html`.
+Sollte die Dokumentation mit einem Webserver ausgeliefert werden auf dem
+PHP installiert ist, kann auch die `index.php` verwendet werden.
+
+JSDuck ist unter der Adresse https://github.com/senchalabs/jsduck
+zu finden und muss installiert werden.
+
+Einstellungen bezüglich der Generierung der Dokumentation sind in der Datei
+`jsduck.json` hinterlegt.
+
+Entwicklung
+-----------
+Für die Entwicklung ist es notwendig in dem Wurzelordner die ExtJS-Bibliothek
+in der Version >=4.2.0 unter dem Namen "extjs" zur Verfügung zu stellen.
+
+Näheres dazu in der Datei `INSTALL.markdown`.
+
+Zusätzlich werden für diese Anwendung weitere externe Bibliotheken, bspw. zur
+Internationalisierung verwendet. Auch diese und deren Installation
+sind in der o.g. Datei beschrieben.
+
+
+Build
+-----
+Die Anwendung wird mit Hilfe des von Sencha bereitgestellten Tools 'Sencha Cmd'
+kompiliert und minifiziert. Vorbedingung für den Compilevorgang ist die in der
+Datei `INSTALL.markdown` beschriebene Verzeichnisstruktur.
+
+Der Build erzeugt in dem Ordner 'build' die minifizierte Version der Anwendung,
+welche alle benötigten Klassen der ExtJS Bibliothek beinhaltet, sowie eine
+entsprechende index.html, die zur Auslieferung in einem Webserver verwendet
+werden kann. Externe Bibliotheken, Grafiken und CSS Dateien sind jedoch nicht
+inkludiert und müssen händisch hinzugefügt werden. Auch diese sind in der Datei
+`INSTALL.markdown` beschrieben.
+
+Installation
+------------
+Für Informationen zur Installation schauen Sie in die `INSTALL.markdown` Datei.
More information about the Lada-commits
mailing list