Mercurial > dive4elements > gnv-client

annotate doc/config-manual/general_settings.tex @ 1132:03c404871d50

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ISSUE23: Documentation how to add a language doc/trunk@1242 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 29 Jun 2010 10:28:51 +0000
parents 975bb59bb136
children 411b09d348ca
rev   line source
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
1 \section{Configuring the GNV-Server}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
2
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
3 The configuration of the artifact- and mapserver is been done in the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
4 central configuration directory at {\tt artifact-server/conf/}. The
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
5 central entry point is the file {\tt conf.xml}. All components of the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
6 configuration are linked from this document.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
7
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
8 {\bf Within the configuration the key
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
9 {\verb+${artifacts.config.dir}+} can be used to reference the central
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
10 configuration directory of the artifact-server instance, e.g.
948
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
11 \texttt{/opt/artifact-server/conf}.}
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
12
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
13 The following structure gives an overview of the entire structure
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
14 starting from {\tt conf/}:
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
15
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
16 %% tree /opt/artifact-server/
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
17 \begin{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
18 conf/
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
19 |-- arcsdeconnectionpool.properties # database connection
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
20 |-- charttemplate.xml # general properties for chart generation
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
21 |-- conf.xml # central configuration
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
22 |-- ehcache.xml # configuration of caching system
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
23 |-- log4j.properties # logging of server
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
24 |-- maptemplates # style defintions for rendering maps
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
25 | `-- *.vm
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
26 |-- meshwidth.xml # buffer-size for querying different FIS on
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
27 # meshes
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
28 |-- palette # styling for 2D charts
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
29 | `-- *.xml
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
30 |-- products # configuration of steps in workflows
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
31 | |-- horizontalcrosssection
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
32 | | `-- *.xml
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
33 | |-- horizontalprofile
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
34 | | `-- *.xml
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
35 | |-- layer
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
36 | | `-- *.xml
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
37 | |-- timeseries
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
38 | | |-- *.xml
945
491b8d6cd291 Added content about generating charts
Hans Plum <hans.plum@intevation.de>
parents: 944
diff changeset
39 | | `-- timegap_definition.xml # definition of a gaps as defines in MEDIAN Coded Value Domains section TSIntervalTypes. The meaning of the defined gaps are detailed explained in the file itself.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
40 | |-- verticalcrosssection
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
41 | | `-- *.xml
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
42 | `-- verticalprofile
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
43 | `-- *.xml
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
44 `-- queries.properties # SQL configuration according to products
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
45 \end{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
46
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
47
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
48 The central config-file {\tt conf/conf.xml} is XML-based and contains the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
49 following main elements:
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
50
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
51 \begin{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
52 artifact-database
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
53 |-- geo-backend # pointing to database connection, SQL configuration
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
54 |-- rest-server # port, listen addresses
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
55 |-- database # internal database storing artifacts
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
56 |-- ehcache # pointing to cache configuration
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
57 |-- cleaner # time of cleanups FIXME
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
58 |-- export-secret # signing project files
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
59 |-- factories # list of expert information systems
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
60 |-- artifacts # list of products
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
61 |-- gnv # charts, palettes, interpolation parameters
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
62 |-- mapserver # integration of mapserver
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
63 `-- velocity # templating language used in maptemplates
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
64 \end{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
65
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
66 The documentation of the configuration will be split up in 4 sections
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
67 addressing different tasks:
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
68 \begin{enumerate}
947
9a28846dfb9c Final QS for V1.0
Hans Plum <hans.plum@intevation.de>
parents: 945
diff changeset
69 \item "Configuring and Running Artifact-Server" covering the main elements
9a28846dfb9c Final QS for V1.0
Hans Plum <hans.plum@intevation.de>
parents: 945
diff changeset
70 \texttt{
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
71 geo-backend, rest-server, database, ehcache, cleaner, export-secret}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
72 \item "Generating Charts -- Background and Configuration" covering
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
73 the main element {\tt gnv}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
74 \item "Generating Maps -- Background and Configuration" covering the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
75 main elements {\tt mapserver, velocity}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
76 \item "Configuring FIS, Products, States, Transitions and
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
77 SQL-Statements" covering the main elements {\tt factories,
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
78 artifacts}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents: 937
diff changeset
79 \end{enumerate}
1132
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
80
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
81 \subsection{Adding new Languages}
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
82 The GNV-Server has the possibility to handle different languages.
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
83 It is necessary to configure those languages.
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
84
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
85 The configuration is divided into three steps
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
86
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
87 \begin{enumerate}
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
88 \item Adding the required resource-file to the GNV-Server
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
89 {\tt /gnv-artifacts/src/main/resources/lang }
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
90 \item Adding the required resource-file to the GNV-Web-Client
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
91 {\tt /gnv/src/main/resources}
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
92 \item Publishing the new language to the GNV-Server by adding the
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
93 language-code to the file {\tt /gnv-artifacts/src/main/resources/lang/lang.conf}
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
94 \end{enumerate}
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
95
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
96 To generate the resource-files it might be helpful to copy an existing one and
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
97 translate the content into the desired language.
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
98
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
99 Please not that you have to do an new packaging of the modules gnv and gnv-artifacts
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
100 to publish the new languages to the system.
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
101
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
102 Also note, that the Web-Client currently only provide German an English as languages.
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
103 If you want to provide further languages you have to change the toggle-mechanism for
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
104 switching the language in the web-client.
03c404871d50 ISSUE23: Documentation how to add a language
Tim Englich <tim.englich@intevation.de>
parents: 948
diff changeset
105
http://dive4elements.wald.intevation.org