Mercurial > dive4elements > gnv-client
changeset 924:9d94bf77e442
Finalized documentation with references, unifying tools, adding logos.
doc/trunk@1061 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Hans Plum <hans.plum@intevation.de> |
---|---|
date | Thu, 06 May 2010 06:24:41 +0000 (2010-05-06) |
parents | 95b48f7d0acf |
children | ec28a68b5a87 |
files | doc/ChangeLog doc/admin-manual/figures/bsh_logo.gif doc/admin-manual/installation-admin-manual.tex doc/admin-manual/installation-artefact-server.tex doc/admin-manual/installation-base.tex doc/admin-manual/installation-webclient.tex doc/admin-manual/operating-the-system.tex doc/admin-manual/title.tex |
diffstat | 8 files changed, 68 insertions(+), 39 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog Thu May 06 05:57:12 2010 +0000 +++ b/doc/ChangeLog Thu May 06 06:24:41 2010 +0000 @@ -1,3 +1,21 @@ +2010-05-06 Hans Plum <hans@intevation.de> + + * admin-manual/title.tex, + admin-manual/installation-admin-manual.tex, + admin-manual/figures/bsh_logo.gif, + admin-manual/operating-the-system.tex, + admin-manual/installation-base.tex, + admin-manual/installation-webclient.tex, + admin-manual/installation-artefact-server.tex: + Finalized documentation with references, unifying tools, adding logos. + TODO: Unify the use of artifact. Checking against implementation. + +2010-05-06 Hans Plum <hans@intevation.de> + + * admin-manual/Makefile: + Replaced selfmade Makefile through a specialized one from + http://www.bouncingchairs.net/oss (GPL) + 2010-05-05 Hans Plum <hans@intevation.de> * admin-manual/overview.tex,
--- a/doc/admin-manual/installation-admin-manual.tex Thu May 06 05:57:12 2010 +0000 +++ b/doc/admin-manual/installation-admin-manual.tex Thu May 06 06:24:41 2010 +0000 @@ -32,7 +32,7 @@ %---------------------------------------------- % Document TITLE -\newcommand{\documenttitle}{Generic Viewer -- Installing and running} +\newcommand{\documenttitle}{Generic Viewer -- Installation and Operations} %----------------------------------------------
--- a/doc/admin-manual/installation-artefact-server.tex Thu May 06 05:57:12 2010 +0000 +++ b/doc/admin-manual/installation-artefact-server.tex Thu May 06 06:24:41 2010 +0000 @@ -130,7 +130,7 @@ 3. Artefact-Server ready for communication with client? \begin{lstlisting} - wget -qO- http://localhost:8181/factories + curl "http://localhost:8181/factories" | xmllint --format - \end{lstlisting} Task: Check for a XML-document describing possible expert information
--- a/doc/admin-manual/installation-base.tex Thu May 06 05:57:12 2010 +0000 +++ b/doc/admin-manual/installation-base.tex Thu May 06 06:24:41 2010 +0000 @@ -1,15 +1,13 @@ \section{Installation and Configuration} -This section describes preconditions for the entire system and an -installation on a Debian 5.0.x (Lenny) for the GNV-System without an -running X-Environment. +This section describes preconditions for the entire system and an installation +on a Debian 5.0.x (Lenny) for the GNV-System without an running X-Environment. +Mostly, the debian package management\footnote{Further information at +\url{http://www.debian.org/doc/manuals/debian-reference/ch02.en.html}} +using \verb+ aptitude+ is used in this manual. -For installing and operating the GNV-system access with {\bf root -rights} is needed. If other permissions are needed, there will be a -hint in this manual. - -If existing configurations have to be changed, the following notation will be used: -\verb|+| for adding a line replacing the marked by \verb|-|. +If existing configurations have to be changed, the following notation will be +used: \verb|+| for adding a line replacing the marked by \verb|-|. \subsection{Preconditions} @@ -19,7 +17,7 @@ \item Storage for the delivered software: 100 MB \item Current processor on a 32-bit Architecture (Beginning 2010)\footnote{Running on a 64-bit system should work out of the box - and improve scalibility issues.} + and improve scalibility issues (not tested yet).} \item RAM: 1 GB for production as minimum.\footnote{This value depends mainly on the amount of connected users.} \item Network access to Database Backend @@ -41,7 +39,7 @@ \item ArcS57 -- International Hydrographic Organization (IHO) S-57 for ENC Data Model. - ESRI Data Models. http://support.esri.com/datamodels \item CONTIS -- Federal Maritime and Hydrographic Agency (BSH). Continental - Shelf Information System -- + Shelf Information System -- \\ \url{http://www.bsh.de/en/Marine\_uses/Industry/CONTIS\_maps/index.jsp} \item GNV specific schema MapViewer interface -- Schema for integrating with MapViewer and their WMS services @@ -83,7 +81,8 @@ \subsubsection*{Install Native Components for Java6 (optional)} -This step is optional but recommended. +This step is optional but recommended\footnote{For background +information, c.f. \url{http://tomcat.apache.org/tomcat-5.5-doc/apr.html}}. For a better support of the native server technologies, the package \verb+libtcnative+ can be installed. @@ -101,7 +100,8 @@ globally\footnote{This manual assumes that there are no other packages depending to another Java version.}. -Use \verb+update-alternatives+ mechanism of the Debian system, execute: +Use \verb+update-alternatives+ mechanism of the Debian +system\footnote{Background information: {\tt man update-alternatives}}, execute: \verb+ update-alternatives --list java+ @@ -165,7 +165,8 @@ The Apache Tomcat is integrate with Apache WebServer just via the Apache JServ Protocoll (AJP). To secure the connection, just local connections -are allowed for AJP on Tomcat. +are allowed for AJP on Tomcat\footnote{For background information, c.f. +\url{http://tomcat.apache.org/tomcat-5.5-doc/connectors.html}}. Modify the \verb+ /etc/tomcat5.5/server.xml+: \begin{lstlisting} @@ -224,7 +225,10 @@ \subsubsection*{Configuring mod\_jk} Edit the settings for mod\_jk in -file \verb+ /etc/libapache2-mod-jk/workers.properties+: +file \verb+ /etc/libapache2-mod-jk/workers.properties+. For further +information, there are comments in the configuration file\footnote{Background +information can be found at \\ +\url{http://tomcat.apache.org/connectors-doc/generic\_howto/workers.html}}. \begin{lstlisting} @@ -248,7 +252,8 @@ Depending of the existing configuration of Apache WebServer, the following steps can differ. In this case, a vanilla configuration is -assumed. +assumed\footnote{Background information about Apache WebServer can +be found at \url{http://httpd.apache.org/docs/2.2/}}. Disable default configuration \verb+ a2dissite default+ @@ -269,7 +274,7 @@ You can test the installation by executing the following url: -\verb+ wget http://localhost/gnv/ -O test+ +\verb+ curl "http://localhost/gnv/" -o test+ After a successful installation, the file {test} will contain HTML describing the startpage of the GNV WebClient. @@ -317,9 +322,9 @@ \begin{lstlisting} cd root -wget \ +curl \ "http://localhost/cgi-bin/gnv-wrapper?service=WMS&request=GetCapabilities&version=1.1.1" \ --O mapserver +-o mapserver \end{lstlisting} For a sucessful configuration, the response document \verb+ mapserver+
--- a/doc/admin-manual/installation-webclient.tex Thu May 06 05:57:12 2010 +0000 +++ b/doc/admin-manual/installation-webclient.tex Thu May 06 06:24:41 2010 +0000 @@ -6,7 +6,10 @@ \subsubsection*{Installation} -Make sure, the Apache Tomcat is stopped. Deploying the WAR-file: +Make sure, the Apache Tomcat is stopped. Deploying the +WAR-file\footnote{There are several ways of deployment in Apache Tomcat. +Background information can be found at +\url{http://tomcat.apache.org/tomcat-5.5-doc/deployer-howto.html}}: \begin{lstlisting} cp -i gnv-\$VERSION.war /usr/share/tomcat5.5/webapps/gnv.war # Start Tomcat: @@ -22,8 +25,9 @@ there is nothing to do to considering the execution environment. If the address of the artifact-server has been changed (c.f. -chapter~\ref{}, p.\pageref{}), it can be adapted in the file -\verb+ WEB-INF/web.xml+ for the parameter name +chapter~\ref{ref:artifact-server-install}, +p.\pageref{ref:artifact-server-install}), it can be adapted in the file {\tt +WEB-INF/web.xml} for the parameter name \verb+de.intevation.gnv.artifactdatabase.client.ArtifactDatabase.url.1+. As default log information is written into the file @@ -41,7 +45,7 @@ Testing the installation via Apache WebServer, mod\_jk and Apache Tomcat: \begin{lstlisting} - wget http://localhost/gnv/ -O gnv + curl "http://localhost/gnv/" -o gnv \end{lstlisting} The file \verb+gnv+ includes HTML describing the startpage of the
--- a/doc/admin-manual/operating-the-system.tex Thu May 06 05:57:12 2010 +0000 +++ b/doc/admin-manual/operating-the-system.tex Thu May 06 06:24:41 2010 +0000 @@ -132,7 +132,3 @@ It is recommended to undo the logging configuration, after the relevant part has been found. - -\section{Lists of References} -%% TODO: List of references -
--- a/doc/admin-manual/title.tex Thu May 06 05:57:12 2010 +0000 +++ b/doc/admin-manual/title.tex Thu May 06 06:24:41 2010 +0000 @@ -1,13 +1,19 @@ %----------------------------------- % TITLE PAGE -% FIXME BSH Logo +\begin{figure}[ht] + \begin{minipage}[b]{0.5\linewidth} + \centering + \includegraphics[scale=0.75]{figures/bsh_logo} \\ + {\tt http://www.bsh.de/en}\\[4.0cm] + \end{minipage} + \begin{minipage}[b]{0.5\linewidth} + \centering + \includegraphics[width=0.75\textwidth]{figures/intevation-logo} + {\tt http://intevation.de/geospatial}\\[2.0cm] + \end{minipage} +\end{figure} - { - \makebox[5cm][l]{}\hspace{5cm}\makebox[5cm][l]{\includegraphics[height=3cm]{figures/intevation-logo.eps}}\\ - \makebox[5cm][l]{}\hspace{5cm}\makebox[5cm][l]{\tt http://intevation.de} - } - \vspace{4cm} { @@ -23,7 +29,7 @@ \vspace{1cm} Version \documentversion~-~Date: \documentdate - Revision \documentrevision + %% Revision \documentrevision } \vspace{4cm} @@ -33,13 +39,13 @@ \vfill \begin{flushleft} - Authors:\\ + {\bf Authors}:\\ Tim Englich$<$tim.englich@intevation.de$>$\\ Hans Plum $<$hans.plum@intevation.de$>$\\ Sascha Teichmann $<$sascha.teichmann@intevation.de$>$\\ - Intevation GmbH,\\ + {\bf Intevation GmbH},\\ Neuer Graben 17, 49074 Osnabr�ck, Germany\\ Tel: ++49 541 33 50 83 - 0 \\ - http://www.intevation.net/geospatial + \url{http://www.intevation.net/geospatial} \end{flushleft}