annotate README @ 895:2b7bcb778f0a

Jsduck debug
author Dustin Demuth <dustin@intevation.de>
date Thu, 23 Jul 2015 17:14:05 +0200
parents 10959fe61092
children
rev   line source
436
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
1 Lada-Client
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
2 ===========
469
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
3 Dies ist die Prototypversion eines EXTJS basierten Klienten für die
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
4 Verarbeitung von Labordaten (Lada) zur Überwachung der Umweltradioaktivität.
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
5
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
6 Die Software bietet grundlegende Funktionalität zur Erfassung und Bearbeitung
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
7 von Messdaten. Weitere Informationen finden sich auf der Projektwebseite unter
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
8 der Adresse:
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
9
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
10 https://wald.intevation.org/projects/lada/
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
11
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
12 Die Software entstand im Rahmen einer Software Entwicklung durch die
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
13 Intevation GmbH im Auftrag des Bundesamt für Strahlenschutz im Jahre 2013.
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
14
476
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
15 Kontakt
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
16 -------
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
17 Bundesamt für Strahlenschutz
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
18 SW2 Notfallschutz, Zentralstelle des Bundes (ZdB)
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
19 Willy-Brandt-Strasse 5
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
20 38226 Salzgitter
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
21 info@bfs.de
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
22
469
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
23 Lizenz
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
24 ------
475
8419950cb3ea Anpasung der README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 471
diff changeset
25 Die Software unter der GNU GPL v>=3 Lizenz verfügbar. Details siehe die Datei
8419950cb3ea Anpasung der README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 471
diff changeset
26 COPYING.
469
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
27
475
8419950cb3ea Anpasung der README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 471
diff changeset
28 Quelltext
8419950cb3ea Anpasung der README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 471
diff changeset
29 ---------
469
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
30 Die Quelldateien lassen sich wie folgt auschecken:
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
31 hg clone https://scm.wald.intevation.org/hg/lada/lada-client
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
32
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
33 Dokumentation
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
34 -------------
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
35 Die Dokumentation wird mit dem Tool JSDuck erzeugt.
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
36 Im Wurzelordner lässt sich nach der Installation von JSDuck dann mit dem
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
37 Befehl "jsduck" die Dokumentation für den Lada-Clienten erzeugen.
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
38 Die Dokumentation findet sich nach der Generierung in dem Order "doc".
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
39 Einstiegseite ist die Seite template.html.
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
40
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
41 JSDuck ist unter der Adresse
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
42
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
43 https://github.com/senchalabs/jsduck
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
44
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
45 zu finden und muss installiert werden.
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
46
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
47 Einstellung bezüglich der Generierung der Dokumentation ist in der Datei
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
48 jsduck.json hinterlegt.
436
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
49
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
50 Entwicklung
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
51 -----------
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
52 Für die Entwicklung ist es notwenig in dem Wurzelordner die ExtJS-Bibliothek
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
53 in der Version >=4.2.0 unter dem Namen "extjs" zur Verfügung zu stellen.
27
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
54
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
55 Diese lässt sich unter der folgenden URL herunterladen:
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
56 http://cdn.sencha.com/ext/gpl/ext-4.2.0-gpl.zip
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
57
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
58 SHA1 Checksum: 2ce990d9e90c48a76078e8533c72b5452f9ed809
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
59
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
60 Beispiel:
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
61 curl -O http://cdn.sencha.com/ext/gpl/ext-4.2.0-gpl.zip
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
62 unzip ext-4.2.0-gpl.zip
e02d07abc4fe Added notes to the README
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 26
diff changeset
63 ln -s ext-4.2.0-gpl extjs
340
7cddca668d21 Hinweise zur Dokumentation eingefügt.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 27
diff changeset
64
436
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
65 Zusätzlich wird für diese Anwendung eine Bibliothek zur Internationalisierung
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
66 verwendet, die unter der URL
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
67
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
68 https://github.com/elmasse/Ext.i18n.Bundle
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
69
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
70 verfügbar ist, verwendet.
501
10959fe61092 Updated dependencies and documentation.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 476
diff changeset
71 Der darin enthaltene Ordner 'i18n' muss in dem Ordner 'resources' der Anwendung
10959fe61092 Updated dependencies and documentation.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 476
diff changeset
72 eingebunden werden. Dazu wird der Ordner 'i18n' in den Ordner 'resources' kopiert
436
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
73 oder verlinkt.
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
74
469
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
75 Build
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
76 -----
436
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
77 Die Anwendung wird mit Hilfe des von Sencha bereitgestellten Tools 'Sencha Cmd'
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
78 compiliert und minifiziert. Vorbedingung für den Compilevorgang ist die unter
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
79 Entwicklung beschriebene Verzeichnisstruktur.
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
80
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
81 Sencha Cmd kann unter der URL
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
82
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
83 http://www.sencha.com/products/sencha-cmd/download
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
84
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
85 heruntergeladen und dann installiert werden.
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
86
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
87 Mit dem folgenden Befehl kann dann der Lada-Client compiliert und minifiziert werden:
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
88
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
89 sencha -sdk /path/to/extjs compile \
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
90 -classpath=app,app/view/widgets/resources/datetime page -yui \
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
91 -in index.html -out build/index.html
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
92
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
93 Dies erzeugt in dem Ordner 'build' die minifizierte Version der Anwendung, die
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
94 alle benötigten Klassen der ExtJS Bibliothek beinhaltet und eine entsprechende
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
95 index.html, die zur Auslieferung in einem Webserver verwendet werden kann.
067ecffac15d Updated Readme: Added section with hints to minify the app with Sencha cmd.
Raimund Renkert <rrenkert@intevation.de>
parents: 399
diff changeset
96
469
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
97 Installation
9ba41a46f6e5 README added hints for installation, license etc.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 436
diff changeset
98 ------------
476
584003637a6b Texte zwischen README und INSTALL verschoben
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 475
diff changeset
99 Für Informationen zur Installation schauen Sie in die INSTALL Datei.

http://lada.wald.intevation.org