[Greater-commits] r3813 - in trunk/packaging: . doc
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Fri Oct 14 10:31:47 CEST 2011
Author: aheinecke
Date: 2011-10-14 10:31:47 +0200 (Fri, 14 Oct 2011)
New Revision: 3813
Modified:
trunk/packaging/doc/greater-installation.tex
trunk/packaging/greater-installer.nsi
trunk/packaging/makeinstaller.py
Log:
Update installation documentation spelling
Create documentation shortcuts
Fix typos in makeinstaller
Modified: trunk/packaging/doc/greater-installation.tex
===================================================================
--- trunk/packaging/doc/greater-installation.tex 2011-10-14 08:29:03 UTC (rev 3812)
+++ trunk/packaging/doc/greater-installation.tex 2011-10-14 08:31:47 UTC (rev 3813)
@@ -110,7 +110,7 @@
This document has been designed with \LaTeX{}.
It is available as source code, PDF- and HTML-format.\\
-Version: \documentversion \\
+version: 1.0.0 \\
Date: \documentdate \\
Authors: Andre Heinecke
@@ -130,7 +130,7 @@
\begin{center}Copyright (c) 2011 Intevation GmbH.\end{center}
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2
+under the terms of the GNU Free Documentation License, version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU
@@ -140,26 +140,26 @@
\chapter{Installation on Windows}
\label{chap:installation_windows}
-To Install GREAT-ER on your system it is recommended that you execute
-the Installer with an Administrative account. Or on systems with User
+To install GREAT-ER on your system it is recommended that you execute
+the Installer with an administrative account. Or on systems with User
Account Control allow the GREAT-ER-Installer to make changes to your
-system. The Database setup will fail if greater is not installed with
-an Administrative privileges.
+system. The Database setup will fail if GREAT-ER is not installed with
+administrative privileges.
After starting the installation you will see a welcome screen informing you
-about the Version you are about to install.
+about the version you are about to install.
\begin{center}
\Fig{\includegraphics[scale=\imagescale]{screenshots/setup1.png}}{
- GREAT-ER Installation Welcome screen}
+ GREAT-ER Installation Welcome Screen}
\end{center}
Please follow the instructions on the screen and accept the license.
GREAT-ER is completely Free Software and licensed under
-the GNU General Public License (GPL) Version 2.
+the GNU General Public License (GPL) version 2.
\section{Installation Types}
-GREAT-ER can be installed in three variants. For a normal single user
+GREAT-ER can be installed in several variants. For a normal single user
installation it is recommended to use the "Full Installation" which
will install everything that is necessary to use GREAT-ER on the system.
@@ -169,7 +169,7 @@
\end{center}
\subsection{GREAT-ER Sediment Ext.}
-The GREAT-ER Sediment Extension is a derived Version of the
+The GREAT-ER Sediment Extension is a derived version of the
GREAT-ER Standard Client. Its new features include:
\begin{itemize}
\item Water column concentrations for sorbed/dissolved
@@ -187,23 +187,23 @@
of {\bf C}hemical {\bf E}xposure} project.
\end {itemize}
Since those extensions did not undergo the same review process as
-the components of the GREAT-ER "Standard Version" it has to be viewed
-as an experimental Software. For more details on the Sediment
-Extensions please refer to the GREAT-ER manual.
+the components of the GREAT-ER "Standard version" it's state is currently
+experimental. For more details on the Sediment Extensions please
+refer to the GREAT-ER manual.
\begin{itemize}
\item Full Installation (\textbf{recommended}) \\
Install the GREAT-ER-Desktop client, a
-PostgreSQL Database Server, the Simulation Models and default catchments.
+PostgreSQL database server, the simulation models and default catchments.
\item Client only Installation \\
Install only the GREAT-ER-Desktop client. To
use it for simulations you need to have access to a separate simulation
-Server as well as a Database. This installation type does {\bf not} provide
+server as well as a database. This installation type does {\bf not} provide
a standalone client installation.
\item Server Installation \\
-Install the PostgreSQL Database for GREAT-ER, with the default datasets.
-And the Administration Tool.
+Install the PostgreSQL Database for GREAT-ER, with the default datasets
+and the GREAT-ER administration tool.
\item Custom Installation \\
To install only specific components you can deselect the parts you do
not wish to install by unchecking the checkbox of that component.
@@ -218,19 +218,19 @@
\subsection{Installation location}
The installation Dialog will ask you where it should install the Software.
The default is:
-"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}" all
-Greater Data will be placed into this directory.\\
+"\textbf{c:\textbackslash Program Files\textbackslash GREAT-ER}". All
+GREAT-ER Data will be placed into this directory.\\
-After selecting the Installation location and GREAT-ER Shortcut options
+After selecting the Installation location and GREAT-ER shortcut options
you can start the installation. Depending on the selection of your components
this might take some minutes.
\newpage
\section{Configuration}
\subsection{Firewall access}
-Depending on your Firewall setup you might be asked on the first start
+Depending on your firewall setup you might be asked on the first start
of GREAT-ER to allow firewall access to "pythonw.exe".
-If you allow access other systems in your network will be able to run
+If you allow access, other systems in your network will be able to run
simulations on your system, otherwise you will only be able to run
simulations locally.
@@ -248,7 +248,7 @@
database with the GREAT-ER installer.
To change this behaviour you can edit the greater shortcuts and change the
-command parameters with which the Software is started.
+command parameters that are used to start the Software.
The format for the login information is:
\begin{center}
@@ -263,9 +263,9 @@
\newpage
\section{Server Configuration}
-GREAT-ER has two components that can run on a Server as standalone
+GREAT-ER has two components that can run on a server as standalone
applications. The database and the simulation models. Both are independent
-of each other and also do not need to run on the same System.
+of each other and also do not need to run on the same system.
\subsection{Configure database for remote connections}
The PostgreSQL \footnote{\tt http://www.postgresql.org} database
@@ -285,8 +285,8 @@
\textit{c:\textbackslash Program Files\textbackslash GREAT-ER \textbackslash
postgres9\textbackslash bin\textbackslash pgAdmin3.exe}
-When launching pgAdminIII you will see one Server (localhost:5432)
-to which you can connect by double-clicking on its Icon.
+When launching pgAdminIII you will see one server (localhost:5432)
+to which you can connect by double-clicking on its icon.
The default password for the user \emph{greater} is \textit{greater}.
\begin{center}
@@ -294,7 +294,7 @@
PostgreSQL Connect to Server}
\end{center}
-To change the password to something secure. Use the
+To change the password to something secure, use the
"$File \rightarrow Change Password$" menu option.
To modify the connection settings for your database you can edit the
@@ -308,10 +308,10 @@
Configure PostgreSQL to accept logins on 192.168.0.0/24 }
\end{center}
-There are of course multiple options to configure access rights and connections
+There are, of course, multiple options to configure access rights and connections
with PostgreSQL. Please refer to the PostgreSQL Documentation\footnote{\tt
http://www.postgresql.org/docs/9.0/static} for more information on how
-to administrate your Database.
+to administrate your database.
\subsection{Simulation server setup}
GREAT-ER has the ability to remotely run simulation calculations.
@@ -338,10 +338,10 @@
connections on port 5432 with the ip-address 192.168.0.2
\chapter{Uninstallation on Microsoft Windows}
-To Uninstall GREAT-ER you can either use the Microsoft Windows Software
-(Programs and Functions on Windows Vista/7) Menu or run the "Uninstall.exe"
+To uninstall GREAT-ER you can either use the Microsoft Windows "Software
+Settings" ( Programs and Functions on Windows Vista/7 ) or run the "Uninstall.exe"
located in your Installation Directory.\\
-It will start an Uninstallation Wizard that will allow you to completely
+It will start an uninstallation wizard that will allow you to completely
remove GREAT-ER and all of its components. \\
You can select if you also want to uninstall the PostgreSQL Database.\\
@@ -368,7 +368,7 @@
\hline
\end{tabular}
\end{center}
-
+\newpage
\renewcommand{\documentID}{gnufdl.tex version 1.2}
\include{gnufdl}
\renewcommand{\documentID}{\CVSId}
Modified: trunk/packaging/greater-installer.nsi
===================================================================
--- trunk/packaging/greater-installer.nsi 2011-10-14 08:29:03 UTC (rev 3812)
+++ trunk/packaging/greater-installer.nsi 2011-10-14 08:31:47 UTC (rev 3813)
@@ -199,6 +199,9 @@
# Create new Start menu entries
CreateDirectory "$SMPROGRAMS\${productname}"
CreateShortCut "$SMPROGRAMS\${productname}\GREAT-ER Administration.lnk" '"$INSTDIR\Administration\Administration.exe"'
+ CreateDirectory "$SMPROGRAMS\${productname}\Documentation"
+ CreateShortCut "$SMPROGRAMS\${productname}\Documentation\GREAT-ER Administration.lnk" '"$INSTDIR\Administration\administration.pdf"'
+
no_start_menu:
Return
SectionEnd
@@ -235,6 +238,9 @@
CreateShortCut "$SMPROGRAMS\${productname}\Catchment Preprocessing.lnk" \
"$INSTDIR\python\pythonw.exe" '"$INSTDIR\greater-pre-processing\greater-pre-processing.py"' \
"$INSTDIR\greater-pre-processing\greater.ico"
+
+ CreateDirectory "$SMPROGRAMS\${productname}\Documentation"
+ CreateShortCut "$SMPROGRAMS\${productname}\Documentation\GREAT-ER Preprocessing.lnk" '"$INSTDIR\greater-pre-processing\doc\greater-preprocessing-manual.pdf"'
no_start_menu:
Return
SectionEnd
@@ -324,6 +330,12 @@
CreateShortCut "$SMPROGRAMS\${productname}\${productname_short}.lnk" \
"$INSTDIR\python\pythonw.exe" '"$INSTDIR\GREAT-ER-CEFIC\${executable}" greater/greater at greater' \
"$INSTDIR\GREAT-ER-CEFIC\Resources\greater2.ico"
+
+ CreateDirectory "$SMPROGRAMS\${productname}\Documentation"
+ CreateShortCut "$SMPROGRAMS\${productname}\Documentation\GREAT-ER Manual.lnk" '"$INSTDIR\GREAT-ER-CEFIC\doc\greater-manual.pdf"'
+ CreateShortCut "$SMPROGRAMS\${productname}\Documentation\GREAT-ER Installation.lnk" '"$INSTDIR\GREAT-ER-CEFIC\doc\greater-installation.pdf"'
+ CreateShortCut "$SMPROGRAMS\${productname}\Documentation\GREAT-ER Model.lnk" '"$INSTDIR\GREAT-ER-CEFIC\doc\great-er_model.pdf"'
+ CreateShortCut "$SMPROGRAMS\${productname}\Documentation\GREAT-ER Model Specification.lnk" '"$INSTDIR\GREAT-ER-CEFIC\doc\great-er_model_specification.pdf"'
no_start_menu:
# ** Desktop Icon **
Modified: trunk/packaging/makeinstaller.py
===================================================================
--- trunk/packaging/makeinstaller.py 2011-10-14 08:29:03 UTC (rev 3812)
+++ trunk/packaging/makeinstaller.py 2011-10-14 08:31:47 UTC (rev 3813)
@@ -187,12 +187,12 @@
gpp_files = ["awk"]
cygwin_exectables = ["gawk", "sh", "rm", "sort", "join", "cut",
"paste", "echo", "sed"]
- exta_executables = ["gen2shp", "dbf2txt", "txt2dbf"]
+ extra_executables = ["gen2shp", "dbf2txt", "txt2dbf"]
for exc in [os.path.abspath(os.path.join(CYGWIN_PATH, "%s.exe" % name)) \
for name in cygwin_exectables]:
gpp_files += walk_dependencies(exc)
for exc in [os.path.abspath(os.path.join(ADMINTOOL_PATH, "%s.exe" % name)) \
- for name in extra_exectables]:
+ for name in extra_executables]:
gpp_files += exc
outfiles = generate_files([CYGWIN_PATH], "gpp-dep-in.nsi", "gpp-dep-un.nsi",
More information about the Greater-commits
mailing list