[elvystrac] r1962 - some corrections in user guide (still to be further reviewed)
- From: elvys@xxxxxxxxxxxxxxxxxxxxxx
- To: elvystrac@xxxxxxxxxxxxx
- Date: Mon, 1 Mar 2010 00:18:10 +0100
Author: JirkaH
Date: 2010-03-01 00:18:10 +0100 (Mon, 01 Mar 2010)
New Revision: 1962
Modified:
others/dokumentace/userGuide/adminGuide.tex
others/dokumentace/userGuide/client.tex
others/dokumentace/userGuide/layoutDesigner.tex
others/dokumentace/userGuide/userGuide.tex
Log:
some corrections in user guide (still to be further reviewed)
Modified: others/dokumentace/userGuide/adminGuide.tex
===================================================================
--- others/dokumentace/userGuide/adminGuide.tex 2010-02-28 23:13:28 UTC (rev
1961)
+++ others/dokumentace/userGuide/adminGuide.tex 2010-02-28 23:18:10 UTC (rev
1962)
@@ -1,4 +1,4 @@
-\chapter{Administrátorská příručka}
+\chapter{Administrátorská příručka\label{admin_guide}}
\section{Webový Server}
\subsection{Sestavení řešení (build) a závislosti při sestavování}
Sestavení řešení se provádí pomocí vytvořených ANT skriptů umístěných v
projektech webServer2, resp. dispatcher.
Modified: others/dokumentace/userGuide/client.tex
===================================================================
--- others/dokumentace/userGuide/client.tex 2010-02-28 23:13:28 UTC (rev
1961)
+++ others/dokumentace/userGuide/client.tex 2010-02-28 23:18:10 UTC (rev
1962)
@@ -1,7 +1,7 @@
\chapter{Klientská aplikace}
-\begin{figure}
+\begin{figure}[h]
\label{Client}
\begin{center}
\includegraphics[scale=0.1]{imgs/Client/kiosek.jpg}
@@ -40,11 +40,12 @@
\end{itemize}
U ostatních objektů, které tento systém podporuje, vybírání nemá smysl.
Vybrané pozice je možné přiblížit nebo oddálit a listovat v nich.
-
-
+\newpage
\section{Ovládání pomocí tlačítek na kiosku}
-\begin{figure}
+\paragraph{}
+Na kiosku není k dispozici myš a plná klávesnice, pouze dále popsaná tlačítka.
Rozmístění tlačítek na kiosku je vidět na obrázku \ref{buttons}.
+\begin{figure}[h!]
\label{buttons}
\begin{center}
\includegraphics[scale=0.8]{imgs/Client/buttons.png}
@@ -52,9 +53,6 @@
\caption{Rozmístění tlačítek na kiosku}
\end{figure}
-\paragraph{}
-Na kiosku není k dispozici myš a plná klávesnice, pouze dále popsaná tlačítka.
Rozmístění tlačítek na kiosku je vidět na obrázku \ref{buttons}.
-
V rámci panelu se mezi jednotlivými pozicemi pohybuje pomocí následujících
tlačítek
\includegraphics[scale=0.1]{imgs/Client/001_up.png} - výběr dokumentu na
nejbližší vyšší pozici, která lze vybrat
@@ -142,27 +140,32 @@
\paragraph{}
Celou aplikaci je navíc možné vypnout pomocí klávesy \textbf{q}.
-\section{Instalace}
-
-Instalace klientské aplikace je možná více způsoby
+\section{Instalace}
+Aplikace je v rámci řešení Elvys instalována automaticky pomocí nástroje
Cfengine včetně všech svých závislostí.
+ Ten zajišťuje i její aktualizaci. Nastavení kiosku k používání cfenginu je
pak popsáno v kapitole \ref{admin_guide}, \refname{admin\_guide}.\\
-\begin{itemize}
- \item \textbf{instalace z balíku} - ruční instalace deb balíku
+Pokud je aplikace instalována samostatně, probíhá pomocí připraveného báliku
\verb!elvys-client_1.1_i386.deb!. V něm jsou popsány všechny závislosti.
Vzhledme k tomu, že
+aplikace závisí na nestandartní (není v repozitářích Ubuntu) knihovně
\verb!libqtlockedfile!, je její instalační balíček přibalen ve stejném adresáři.
- \item \textbf{instalace přes aptitude} - pokud je nastavený repozitář i elvys
server
+\subsubsection{Ruční instalace}
+Z \ref{TODO} TODO adresáře je třeba spustit:
+ \verb#dpkg -i libqtlockedfile_2.4.2_i386.deb#
+ \verb#dpkg -i elvys-client_1.1_i386.deb#
+\subsubsection{Instalace pomocí repozitáře}
+Pokud je kiosek provozován v řešení Elvys, je možné aplikaci instalovat ručně
(bez použití Cfenginu) pomocí repozitáře projektu.
V souboru \verb#/etc/apt/sources.list# musí být nastavena cesta k repozitáři:
\verb#deb http://elvysmaster.elvys/repository stable/#
-Příkaz pro nainstalování
+Příkaz pro nainstalování je pak:
-\verb#apt-get install elvys-client#
-
-\end{itemize}
+\verb#apt-get install elvys-client#
-Nainstaluje se do adresáře \verb#/usr/bin/elvys-client#.
+\subsubsection{Adresářová struktura}
+Aplikace se nainstaluje do adresáře \verb#/usr/bin/elvys-client#.
+
Adresářová struktura po nainstalování je následující
\dirtree{%
@@ -181,8 +184,17 @@
\section{Konfigurace}
-Důležité parametry se nastavují v souborech \verb#appconfig.xml# a
\verb#appconfig.xml.static#.
+Aplikace má dva konfigurační soubory, \verb#appconfig.xml.static#, který je
nutný a soubor \verb#appconfig.xml#, který se dle nastavení periodicky stahuje.
+\subsection{Konfigurační soubor appconfig.xml.static}
+
+Pro správnou funkci aplikace musí být alespoň část nastavení staticky uložena,
aby program věděl, kde má stahovat další, detailnější konfiguraci.
+Proto je soubor \verb#appconfig.xml# částečně\footnote{Lze zde však uvést
kompletní konfiguraci a soubor appconfig.xml nepoužívat vůbec, pokud je
stahování konfigurace vypnuté.}
+ duplikován v souboru \verb#appconfig.xml.static#.
+Musí minimálně obsahovat identifikátor kiosku a adresu pro stažení další
konfigurace (souboru \verb#appconfig.xml#).
+
+\lstinputlisting[caption=Ukázka souboru
appConfig.xml.static]{../../../others/xsd/version2/examples/appConfig.xml.static}
+
\subsection{Konfigurační soubor appconfig.xml}
@@ -192,29 +204,6 @@
-\subsection{Konfigurační soubor appconfig.xml.static}
-
-Pro správnou funkci aplikace musí být alespoň část udájů staticky uložena.
-Jinak by program nevěděl, kde má poptávat další konfiguraci.
-Proto je soubor \verb#appconfig.xml# částečně duplikován v souboru
\verb#appconfig.xml.static#.
-Musí minimálně obsahovat identifikátor kiosku a adresu pro stažení souboru
\verb#appconfig.xml#.
-
-\begin{lstlisting}[escapechar=\%]
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<app_config elvysVersion="1.0-b1">
- <!--% identifikátor kiosku %-->
- <machine_id>19</machine_id>
-
- <!--% adresa, na které je dostupný appconfig.xml %-->
- <data_url>
- <http_address>
- http://elvys.farm.particle.cz/dataIntegration/4
- </http_address>
- </data_url>
-
-</app_config>
-\end{lstlisting}
-
\section{Zobrazování jednotlivých typů dokumentů}\label{clientDocumentTypes}
\subsection{Video}
Modified: others/dokumentace/userGuide/layoutDesigner.tex
===================================================================
--- others/dokumentace/userGuide/layoutDesigner.tex 2010-02-28 23:13:28 UTC
(rev 1961)
+++ others/dokumentace/userGuide/layoutDesigner.tex 2010-02-28 23:18:10 UTC
(rev 1962)
@@ -9,7 +9,7 @@
\begin{figure}
\label{LayoutDesigner}
\begin{center}
-\includegraphics[scale=0.4]{imgs/LayoutDesigner/snapshot/applet.png}
+\includegraphics[width=1.0\textwidth]{imgs/LayoutDesigner/snapshot/applet.png}
\end{center}
\caption{Náhled na applet LayoutDesigner}
\end{figure}
@@ -33,7 +33,7 @@
LayoutDesigner má 2 základní režimy - \textbf{navrhovací} a \textbf{vybírací}.
V navrhovacím režimu lze vytvářet a editovat pozice.
\section{Požadavky}
-Pro spuštění LayoutDesigneru je nutné mít nainstalovanou a ve webovém
prohlížeči povolenou Javu. Dále je potřeba povolit vyskakovací okna ve webovém
prohlížečí.
+Pro spuštění LayoutDesigneru je nutné mít nainstalovanou a ve webovém
prohlížeči povolenou Javu. Dále je potřeba povolit automatické otevírání nových
oken ve webovém prohlížečí.
\section{Hlavní menu appletu}
@@ -112,7 +112,7 @@
\begin{figure}
\label{propertiesManager}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/propertiesManager.png}
+\includegraphics[scale=0.6]{imgs/LayoutDesigner/snapshot/propertiesManager.png}
\end{center}
\caption{Panel vlastností}
\end{figure}
@@ -140,14 +140,14 @@
Celý panel vlastností je možné minimalizovat do nástrojové lišty a zpětně opět
otevřít.
-\section{Vyskakovací menu}
+\section{Kontextové menu}
\begin{figure}
\label{popup}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/popup.png}
+\includegraphics[scale=0.7]{imgs/LayoutDesigner/snapshot/popup.png}
\end{center}
-\caption{Vyskakovací menu}
+\caption{Kontextové menu}
\end{figure}
Aktivuje se kliknutím pravým tlačítkem myši, je vidět na obrázku \ref{popup} a
má následující položky
@@ -201,7 +201,7 @@
\begin{figure}
\label{move1}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/move1.png}
+\includegraphics[scale=0.5]{imgs/LayoutDesigner/snapshot/move1.png}
\end{center}
\caption{Pozice před přemístěním}
\end{figure}
@@ -209,7 +209,7 @@
\begin{figure}
\label{move2}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/move2.png}
+\includegraphics[scale=0.5]{imgs/LayoutDesigner/snapshot/move2.png}
\end{center}
\caption{Pozice po přemístění}
\end{figure}
@@ -267,7 +267,7 @@
\begin{figure}
\label{saveAs}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/saveAs.png}
+\includegraphics[scale=0.7]{imgs/LayoutDesigner/snapshot/saveAs.png}
\end{center}
\caption{Dialog Uložit jako}
\end{figure}
@@ -278,7 +278,7 @@
\begin{figure}
\label{resolutionChoice}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/resolutionChoice.png}
+\includegraphics[scale=0.7]{imgs/LayoutDesigner/snapshot/resolutionChoice.png}
\end{center}
\caption{Dialog Výběr rozlišení}
\end{figure}
@@ -289,7 +289,7 @@
\begin{figure}
\label{saveNotSaved}
\begin{center}
-\includegraphics[scale=1]{imgs/LayoutDesigner/snapshot/saveNotSaved.png}
+\includegraphics[scale=0.7]{imgs/LayoutDesigner/snapshot/saveNotSaved.png}
\end{center}
\caption{Dialog Uložit}
\end{figure}
Modified: others/dokumentace/userGuide/userGuide.tex
===================================================================
--- others/dokumentace/userGuide/userGuide.tex 2010-02-28 23:13:28 UTC (rev
1961)
+++ others/dokumentace/userGuide/userGuide.tex 2010-02-28 23:18:10 UTC (rev
1962)
@@ -45,7 +45,7 @@
framerule=1pt,
captionpos=b, % t or b
commentstyle=\color{blue},
-inputencoding=utf8,
+%inputencoding=utf8,
extendedchars=\false,
showstringspaces=false, % underline spaces within strings
showspaces=false, % show spaces within strings with underscores
Other related posts:
- » [elvystrac] r1962 - some corrections in user guide (still to be further reviewed) - elvys
