[elvystrac] r1770 - uziv dokumentace ke kiosku
- From: elvys@xxxxxxxxxxxxxxxxxxxxxx
- To: elvystrac@xxxxxxxxxxxxx
- Date: Wed, 17 Feb 2010 22:40:33 +0100
Author: EvaV
Date: 2010-02-17 22:40:33 +0100 (Wed, 17 Feb 2010)
New Revision: 1770
Modified:
others/dokumentace/userGuide/client.tex
others/dokumentace/userGuide/server.tex
others/dokumentace/userGuide/userGuide.tex
Log:
uziv dokumentace ke kiosku
Modified: others/dokumentace/userGuide/client.tex
===================================================================
--- others/dokumentace/userGuide/client.tex 2010-02-17 20:57:59 UTC (rev
1769)
+++ others/dokumentace/userGuide/client.tex 2010-02-17 21:40:33 UTC (rev
1770)
@@ -1 +1,206 @@
\chapter{Klientská aplikace}
+
+
+\begin{figure}
+\label{Client}
+\begin{center}
+%\includegraphics[scale=0.8]{imgs/Client/kiosek.png}
+\end{center}
+\caption{Náhled na kiosek}
+\end{figure}
+
+Klientská aplikace pro systém Elvys lze používat dvěma způsoby
+\begin{itemize}
+ \item z kiosku, kde se ovládá pomocí tlačítek na monitoru kiosku
+ \item jako klientská aplikace na počítači - zde je k dispozici klasicky
klávesnice a myš
+\end{itemize}
+Oba způsoby nabízí v podstatě ty samé funkce. Pro větší přehlednost ale budou
popsány samostatně v následujících podkapitolách.
+
+
+\section{Výběr pozic}
+Dokument na aktuálně vybrané pozici má zvýrazněný okraj.
+Lze vybrat pouze následující typy dokumentů.
+\begin{itemize}
+ \item pdf dokument
+ \item video
+ \item pdf prezentace
+\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.
+
+
+\section{Ovládání pomocí tlačítek na kiosku}
+
+\paragraph{}
+V rámci tabu 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
+
+\includegraphics[scale=0.1]{imgs/Client/002_left.png} - výběr dokumentu na
nejbližší levé pozici, která lze vybrat
+
+\includegraphics[scale=0.1]{imgs/Client/003_right.png} - výběr dokumentu na
nejbližší pravé pozici, která lze vybrat
+
+\includegraphics[scale=0.1]{imgs/Client/004_down.png} - výběr dokumentu na
nejbližší nižší pozici, která lze vybrat
+
+\paragraph{}
+Zvětšit a zmenšit dokument na aktuálně vybrané pozici lze pomocí
+
+\includegraphics[scale=0.1]{imgs/Client/005_zoomIN.png} - zvětšení dokumentu
na aktuálně vybrané pozici, zvětšovat je možné i opakovaně
+
+\includegraphics[scale=0.1]{imgs/Client/006_zoomOUT.png} - zmenšení dokumentu
na aktuálně vybrané pozici
+
+ZEPTAT SE JIRKY ... DODELAT ... JE TAM NECO JAKO PAGE UP A PAGE DOWN ?
+
+Ve zvětšeném dokumentu se pohybuje následujícím způsobem
+\begin{itemize}
+ \item pdf dokument - pomocí šipek
+ \item video - pomocí šipek
+ \item pdf prezentace - pomocí šipek
+\end{itemize}
+
+
+\paragraph{}
+Mezi kategoriemi se přepíná pomocí
+
+\includegraphics[scale=0.1]{imgs/Client/007_next_cat1.png} - jako aktuální
kategorii vybere kategorii nad aktuálně vybranou kategorií, pokud je vybrána
již nejvyšší kategorie, přejde na nejnižší kategorii
+
+\includegraphics[scale=0.1]{imgs/Client/008_prev_cat1.png} - jako aktuální
kategorii vybere kategorii pod aktuálně vybranou kategorií, pokud je vybrána
již nejnižší kategorie, přejde na nejvyšší kategorii
+
+Kategorie jsou v záložkách po levé straně obrazovky kiosku.
+
+\paragraph{}
+Pro přepínání mezi taby slouží tyto tlačítka
+
+\includegraphics[scale=0.1]{imgs/Client/007_next_tab1.png} - jako aktuální tab
vybere tab vlevo od aktuálně vybraného tabu, pokud je vybrán první tab, přejde
se na poslední tab (pořadí zleva doprava)
+
+\includegraphics[scale=0.1]{imgs/Client/008_prev_tab1.png} - jako aktuální tab
vybere tab vpravo od aktuálně vybraného tabu, pokud je vybrán poslední tab,
přejde se na první tab (pořadí zleva doprava)
+
+Taby jsou v záložkách na dolní straně obrazovky kiosku.
+
+
+
+
+\section{Ovládání pomocí klávesnice u počítače}
+
+\paragraph{}
+Pro přepínání mezi taby slouží klávesy
+\begin{itemize}
+ \item \textbf{a} - odpovídá svojí funkcí tlačítku
\includegraphics[scale=0.1]{imgs/Client/002_left.png} na kiosku
+ \item \textbf{d} - odpovídá svojí funkcí tlačítku
\includegraphics[scale=0.1]{imgs/Client/003_right.png} na kiosku
+\end{itemize}
+
+\paragraph{}
+Mezi kategoriemi lze přepínat pomocí kláves
+\begin{itemize}
+ \item \textbf{w} - odpovídá svojí funkcí tlačítku
\includegraphics[scale=0.1]{imgs/Client/001_up.png} na kiosku
+ \item \textbf{s} - odpovídá svojí funkcí tlačítku
\includegraphics[scale=0.1]{imgs/Client/004_down.png} na kiosku
+\end{itemize}
+
+V rámci tabu se mezi jednotlivými pozicemi pohybuje pomocí klávesových šipek,
stejným způsobem
+
+\paragraph{}
+Dále lze každá pozice zvětšit pomocí klávesy \textbf{Enter} nebo pomocí
stisknutí levého tlačítka myši.
+Pro zmenšení pozice se používá klávesa \textbf{Backspace} nebo pravé tlačítko
myši.
+
+\paragraph{}
+Ve zvětšeném dokumentu
+\begin{itemize}
+ \item pdf dokument - pomocí šipek pohyb ve zvětšeném dokumentu, \textbf{pgup}
skočí na předcházející stránku, \textbf{pgdown} na další stránku
+ \item video - pomocí šipek
+ \item pdf prezentace - pomocí šipek
+\end{itemize}
+
+\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
+
+\begin{itemize}
+ \item \textbf{instalace z balíku}
+
+\verb#dpkg#
+
+ \item \textbf{instalace přes aptitude} - pokud je nastavený repozitář i elvys
server
+
+Ověření, že jsou máme nastaveny
+
+\verb#root@elvys:/srv/elvys-client-checkout#
+
+\verb#tail -n 4 /etc/apt/sources.list#
+
+\verb#Our own repository containg elvys binaries#
+
+\verb#deb http://elvysmaster.elvys/repository stable/#
+
+Příkaz pro nainstalování
+
+\verb#apt-get install elvys-client#
+
+\end{itemize}
+
+Nainstaluje se do adresáře \verb#/usr/bin/elvys-client#.
+
+Strom po nainstalování
+
+\dirtree{%
+ .1 /.
+ .2 \textbf{appconfig.xml} - konfigurační soubor, jeho obsah je vysvětlen v
následující podkapitole.
+ .2 \textbf{appconfig.xml.static} - konfigurační soubor, jeho obsah je
vysvětlen v následující podkapitole.
+ .2 \textbf{data} - adresář, kde jsou datové soubory.
+ .3 \textbf{elvys.png} - pozadí aplikace.
+ .3 \textbf{logo.png} - logo.
+ .3 \textbf{style.css} - kaskádové styly pro klientskou aplikaci.
+ .2 \textbf{elvys-client} - binární soubor.
+ .2 \textbf{elvys-restart.sh} - skript na restartovani aplikace, funguje i při
spuštění přes ssh.
+}
+
+
+
+\section{Konfigurace}
+
+Důležité parametry se nastavují v souborech \verb#appconfig.xml# a
\verb#appconfig.xml.static#.
+
+%V \verb#appconfig.xml# je uvedeno ID kiosku a adresy a periody pro stažení
dalších konfiguračních souborů. Je zřejmé, že 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 tento soubor částečně duplikován. Soubor
\verb!appconfig.xml.static! může obsahovat všechny
+% informace povolené v appConfigu, musí však minimálně obsahovat informaci
o ID kiosku a adrese pro stažení kompletního AppConfigu. Do souboru
\verb!appconfig.xml! se pak ukládá kompletní
+% stažená konfigurace.
+
+
+
+\section{Zobrazování jednotlivých typů dokumentů}
+
+\subsection{Video}
+
+Podle nastavení může být video v náhledu přehráváno, nebo je zobrazen pouze
daný snímek.
+Pokud je video přehráváno, je zobrazen i posuvník značící konkrétní pozici
videa.
+Videa je možné zvětšit. Po zvětšení se video začne přehrávat.
+Pomocí šipek nebo tlačítek se lze ve videu posouvat dopředu a dozadu.
+Při zvětšení videa není možné přepínat mezi kategoriemi a panely.
+Video se po přehrátí automaticky zmenší.
+
+
+\subsection{PDF dokumenty}
+
+PDF dokumenty jsou ve výchozím zobrazení zobrazeny jako náhledy zvolených
stran.
+Zvětšovat dokument lze vícekrát, po každém zvětšení se rozměry stran zvětší o
danou konstantu. Velikost okna prohlížeče PDF se však již nemění.
+Zvětšení je limitováno na max. 5 iterací.
+Pokud uživatel nestiskne libovolnou klávesu nebo tlačítko po 60s, je dokument
zmenšen.
+Ve zvěšeném módu nelze přepínat mezi panely ani kategoriemi.
+
+\subsection{PDF prezentace}
+
+Nezvětšené PDF prezentace rotují s intervalem, který lze nastavit.
+Po zvětšení rotování přestane a zobrazí se aktuální strana.
+Zvětšit lze pouze jednou.
+
+\subsection{Statický text}
+
+Statický text je vždy zobrazen v takové velikosti, aby se celý text vešel do
dané pozice.
+
+\subsection{Dynamický text}
+
+Text se pohybuje zprava doleva a stále se opakuje.
+
+
+
Modified: others/dokumentace/userGuide/server.tex
===================================================================
--- others/dokumentace/userGuide/server.tex 2010-02-17 20:57:59 UTC (rev
1769)
+++ others/dokumentace/userGuide/server.tex 2010-02-17 21:40:33 UTC (rev
1770)
@@ -147,19 +147,15 @@
\section{Vytváření a editace společností}
-\paragraph{}
-\textbf{Seznam společností}
+\subsection{Seznam společností}
-\paragraph{}
-\textbf{Vytvoření společnosti}
+\subsection{Vytvoření společnosti}
-\paragraph{}
-\textbf{Editace společnosti}
+\subsection{Editace společnosti}
\section{Práce s uživateli}
-\paragraph{}
-\textbf{Seznam uživatelů}
+\subsection{Seznam uživatelů}
Seznam uživatelů se zobrazí po zvolení \textbf{Uživatel } $\rightarrow$
\textbf{ Seznam uživatelů} a má následující položky
\begin{itemize}
@@ -183,7 +179,7 @@
\end{figure}
Příklad je vidět na obrázku \ref{userList}.
-\paragraph{Vytvoření nového uživatele}
+\subsection{Vytvoření nového uživatele}
\begin{figure}
\label{createUser}
\begin{center}
@@ -205,9 +201,8 @@
Všechny položky jsou povinné, pokud není některá z nich vyplněná, zobrazí se
upozornění \textbf{Hodnota pro pole je povinná}
V případě, že si heslo a znovu zadané heslo neodpovídají, je uživatel
upozorněn hlášením \textbf{Špatně zopakované heslo}.
-\textbf{Editace uživatele}
+\subsection{Editace uživatele}
-\paragraph{}
\begin{figure}
\label{editUser}
\begin{center}
@@ -234,7 +229,7 @@
\section{Kategorie}
-\textbf{Seznam kategorií}
+\subsection{Seznam kategorií}
\begin{itemize}
\item Jméno kategorie - jméno dané kategorie
@@ -248,11 +243,11 @@
\end{itemize}
-\textbf{Vytvoření nové kategorie a její editace}
+\subsection{Vytvoření nové kategorie a její editace}
\section{Práce s kiosky}
-\textbf{Seznam kiosků}
+\subsection{Seznam kiosků}
Seznam kiosků se zobrazí zvolením \textbf{Kiosek} $\rightarrow$
\textbf{Seznam} v menu a obsahuje následující položky
@@ -268,7 +263,7 @@
Plánování je detailněji popsáno v následující kapitole.
-\textbf{Vytvoření nového kiosku}
+\subsection{Vytvoření nového kiosku}
\section{Plánování dokumentů}
Modified: others/dokumentace/userGuide/userGuide.tex
===================================================================
--- others/dokumentace/userGuide/userGuide.tex 2010-02-17 20:57:59 UTC (rev
1769)
+++ others/dokumentace/userGuide/userGuide.tex 2010-02-17 21:40:33 UTC (rev
1770)
@@ -1,3 +1,4 @@
+
\documentclass{book}
\usepackage{fancyhdr}
@@ -6,6 +7,7 @@
\usepackage{a4wide}
\usepackage{graphicx}
\usepackage[bookmarks=true]{hyperref}
+\usepackage{dirtree}
\usepackage[left=2cm]{geometry}
\pagestyle{fancy}
@@ -24,11 +26,8 @@
\frenchspacing
-
-
\begin{document}
-
\begin{titlepage}
\begin{center} {\LARGE Elektronický vývěskový systém ELVYS} \\ \end{center}
\begin{center} {\Large Uživatelská příručka} \\ \end{center}
Other related posts:
- » [elvystrac] r1770 - uziv dokumentace ke kiosku - elvys
