[elvystrac] r1789 - uziv dokumentace ke kiosku
- From: elvys@xxxxxxxxxxxxxxxxxxxxxx
- To: elvystrac@xxxxxxxxxxxxx
- Date: Thu, 18 Feb 2010 23:32:39 +0100
Author: EvaV
Date: 2010-02-18 23:32:39 +0100 (Thu, 18 Feb 2010)
New Revision: 1789
Modified:
others/dokumentace/userGuide/client.tex
others/dokumentace/userGuide/userGuide.tex
Log:
uziv dokumentace ke kiosku
Modified: others/dokumentace/userGuide/client.tex
===================================================================
--- others/dokumentace/userGuide/client.tex 2010-02-18 21:20:41 UTC (rev
1788)
+++ others/dokumentace/userGuide/client.tex 2010-02-18 22:32:39 UTC (rev
1789)
@@ -17,21 +17,33 @@
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.
+Data jsou zobrazena v jednotlivých \textit{panelech}, které jsou tématicky
seskupeny do \textit{kategorií}.
+
\section{Výběr pozic}
-Dokument na aktuálně vybrané pozici má zvýrazněný okraj.
+
+\begin{figure}
+\label{selectedPosition}
+\begin{center}
+%\includegraphics[scale=0.8]{imgs/Client/selectedPosition.png}
+\end{center}
+\caption{Zvýrazněná aktuálně vybraná pozice}
+\end{figure}
+
+Dokument na aktuálně vybrané pozici má zvýrazněný okraj jak je vidět na
obrázku \ref{selectedPosition}
Lze vybrat pouze následující typy dokumentů.
\begin{itemize}
\item pdf dokument
+ \item pdf prezentace
\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.
+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.
+
\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
+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
@@ -47,34 +59,28 @@
\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}
+Ve zvětšeném dokumentu se dále pohybuje pomocí šipek. Význam pro jednotlivé
typy dokumentů je popsán v kapitole \ref{clientDocumentTypes}.
+
\paragraph{}
-Mezi kategoriemi se přepíná pomocí
+Mezi panely 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/007_next_cat1.png} - jako aktuální
panel vybere panel nad aktuálně vybraným panelem, pokud je vybrán již nejvyšší
panel, přejde na nejnižší panel
-\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
+\includegraphics[scale=0.1]{imgs/Client/008_prev_cat1.png} - jako aktuální
panel vybere panel pod aktuálně vybraným panelem, pokud je vybrán již nejnižší
panel, přejde na nejvyšší panel
-Kategorie jsou v záložkách po levé straně obrazovky kiosku.
+Panely jsou v záložkách na levé straně obrazovky kiosku.
\paragraph{}
-Pro přepínání mezi taby slouží tyto tlačítka
+Pro přepínání mezi kategoriemi 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/007_next_tab1.png} - jako aktuální
kategorii vybere kategorii vlevo od aktuálně vybrané kategorie, pokud je
vybrána první kategorie, přejde se na poslední kategorii (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)
+\includegraphics[scale=0.1]{imgs/Client/008_prev_tab1.png} - jako aktuální
kategorii vybere kategorii vpravo od aktuálně vybrané kategorie, pokud je
vybrána poslední kategorie, přejde se na první kategorii (pořadí zleva doprava)
-Taby jsou v záložkách na dolní straně obrazovky kiosku.
+Kategorie jsou v záložkách na dolní straně obrazovky kiosku.
@@ -95,19 +101,13 @@
\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
+V rámci panelu se mezi jednotlivými pozicemi pohybuje pomocí klávesových
šipek, stejným způsobem jako u tlačítek na kiosku.
\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.
+Ve zvětšení dokumentu se lze pohybovat pomocí šipek a také kláves
\textbf{pageUp} a \textbf{pageDown}, význam pro jednotlivé typy dokumentů je
blíže popsán v podkapitole \ref{clientDocumentTypes}.
-\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}.
@@ -117,20 +117,12 @@
Instalace klientské aplikace je možná více způsoby
\begin{itemize}
- \item \textbf{instalace z balíku}
+ \item \textbf{instalace z balíku} - ruční instalace deb balíku
-\verb#dpkg#
-
\item \textbf{instalace přes aptitude} - pokud je nastavený repozitář i elvys
server
-Ověření, že jsou máme nastaveny
+V souboru \verb#/etc/apt/sources.list# musí být nastavena cesta k repozitáři:
-\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í
@@ -141,18 +133,18 @@
Nainstaluje se do adresáře \verb#/usr/bin/elvys-client#.
-Strom po nainstalování
+Adresářová struktura po nainstalování je následující
\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.
+ .2 \textbf{appconfig.xml} \DTcomment{konfigurační soubor, jeho obsah je
vysvětlen v následující podkapitole}.
+ .2 \textbf{appconfig.xml.static} \DTcomment{konfigurační soubor, jeho obsah
je vysvětlen v následující podkapitole}.
+ .2 \textbf{data} \DTcomment{adresář, kde jsou datové soubory}.
+ .3 \textbf{elvys.png} \DTcomment{pozadí aplikace - momentálně se nepoužívá,
je možné nastavit v souboru style.css}.
+ .3 \textbf{logo.png} \DTcomment{logo}.
+ .3 \textbf{style.css} \DTcomment{kaskádové styly pro klientskou aplikaci}.
+ .2 \textbf{elvys-client} \DTcomment{samotná aplikace}.
+ .2 \textbf{elvys-restart.sh} - \DTcomment{skript na restartovani aplikace,
funguje i při spuštění přes ssh}
}
@@ -161,24 +153,113 @@
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.
+\subsection{Konfigurační soubor appconfig.xml}
+Soubor \verb#appconfig.xml# obsahuje identifikátor kiosku, adresy a periody
pro stažení dalších konfiguračních souborů a má např. následující podobu
-\section{Zobrazování jednotlivých typů dokumentů}
+\begin{lstlisting}[escapechar=\%]
+ <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+
+ <a:app_config elvysVersion="1.0-b1" xmlns:a="cz/elvys/jaxbgen/app">
+
+ <!--% identifikátor kiosku %-->
+ <a:machine_id>19</a:machine_id>
+ <a:data_url>
+ <a:http_address>
+ http://elvys.farm.particle.xx/dataIntegrationNew/4
+ </a:http_address>
+ </a:data_url>
+
+
+ <a:statistics>
+ <!--% adresa, na které je dostupný konfigurační soubor pro statistiky %-->
+ <a:http_address>
+ http://elvys.farm.particle.xx:8081/dispatcher/statistic
+ </a:http_address>
+
+ <!--% jak často se tento soubor stahuje %-->
+ <a:period>30000</a:period>
+ </a:statistics>
+
+ <a:screenshot>
+ <a:http_address>
+ http://elvys.farm.particle.xx:8081/dispatcher/img
+ </a:http_address>
+
+ <a:period>30000</a:period>
+ </a:screenshot>
+
+ <a:category_config>
+ <a:http_address>
+ http://elvys.farm.particle.xx:8081/dispatcher/categoryConfig
+ </a:http_address>
+
+ <a:period>30000</a:period>
+ </a:category_config>
+
+ <a:document_config>
+ <a:http_address>
+ http://elvys.farm.particle.xx:8081/dispatcher/documentConfig
+ </a:http_address>
+
+ <a:period>30000</a:period>
+ </a:document_config>
+
+ <a:filecache_config>
+ <a:http_address>
+ http://elvys.farm.particle.xx:8081/dispatcher/filecacheConfig
+ </a:http_address>
+
+ <a:period>30000</a:period>
+ </a:filecache_config>
+
+ <a:night_mode enabled="false"/>
+
+ <a:app_config_source>
+ <a:http_address>
+ http://elvys.farm.particle.xx:8081/dispatcher/appConfig
+ </a:http_address>
+ </a:app_config_source>
+ </a:app_config>
+\end{lstlisting}
+
+
+\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}
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.
+Pomocí šipek nebo tlačítek doprava/doleva se lze ve videu posouvat
dopředu/dozadu o 1/10.
Při zvětšení videa není možné přepínat mezi kategoriemi a panely.
Video se po přehrátí automaticky zmenší.
-
+Šipka nahoru posune přehrávání videa na úplný začátek.
\subsection{PDF dokumenty}
@@ -188,12 +269,21 @@
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.
+Pomocí šipek a tlačítek nahoru a dolu se pohybuje v dokumentu.
+Klávesa \textbf{pageUp} posune na předchozí stránku, \textbf{pageDown} na
následující. Zarovná se vždy na vrch stránky.
+Na kiosku se tímto způsobem listuje pomocí tlačítek doleva a doprava.
+Pokud ale není zobrazena celá šířka dokumentu a je viditelný horizontální
scrollbar, slouží tlačítka doleva a doprava pro posun v dokumentu.
+
+
\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.
+Šipka nebo tlačítko nahoru posune na předcházející stranu
+\\ OD JIRKY Z MAILU - NEVIM KTERE SIPKY dalsi dve sipky o jednu stranu doprava
+
\subsection{Statický text}
Statický text je vždy zobrazen v takové velikosti, aby se celý text vešel do
dané pozice.
@@ -204,3 +294,4 @@
+
Modified: others/dokumentace/userGuide/userGuide.tex
===================================================================
--- others/dokumentace/userGuide/userGuide.tex 2010-02-18 21:20:41 UTC (rev
1788)
+++ others/dokumentace/userGuide/userGuide.tex 2010-02-18 22:32:39 UTC (rev
1789)
@@ -8,6 +8,7 @@
\usepackage{graphicx}
\usepackage[bookmarks=true]{hyperref}
\usepackage{dirtree}
+\usepackage{listings}
\usepackage[left=2cm]{geometry}
\pagestyle{fancy}
Other related posts:
- » [elvystrac] r1789 - uziv dokumentace ke kiosku - elvys
