[elvystrac] r1940 - some changes in documentation styling
- From: elvys@xxxxxxxxxxxxxxxxxxxxxx
- To: elvystrac@xxxxxxxxxxxxx
- Date: Sun, 28 Feb 2010 15:21:24 +0100
Author: JirkaH
Date: 2010-02-28 15:21:24 +0100 (Sun, 28 Feb 2010)
New Revision: 1940
Modified:
others/dokumentace/technicalGuide/analysis/0analysis.tex
others/dokumentace/technicalGuide/architecture/0architecture.tex
others/dokumentace/technicalGuide/architecture/6clientapp.tex
others/dokumentace/userGuide/client.tex
others/dokumentace/userGuide/server.tex
others/dokumentace/userGuide/userGuide.tex
Log:
some changes in documentation styling
Modified: others/dokumentace/technicalGuide/analysis/0analysis.tex
===================================================================
--- others/dokumentace/technicalGuide/analysis/0analysis.tex 2010-02-28
12:09:30 UTC (rev 1939)
+++ others/dokumentace/technicalGuide/analysis/0analysis.tex 2010-02-28
14:21:24 UTC (rev 1940)
@@ -14,13 +14,12 @@
\usepackage[czech]{babel}
\usepackage[left=2cm]{geometry}
\usepackage{listings}
+\renewcommand*\lstlistingname{Kód}
\usepackage{float}
\usepackage{color}
\definecolor{zelena}{rgb}{0.92,1,0.92}
-\newfloat{program}{thp}{lop}
-\floatname{program}{Kód}
\pagestyle{fancy}
@@ -44,8 +43,25 @@
\begin{document}
+\lstset{
+language=XML, % choose the language of the code
+basicstyle=\footnotesize\ttfamily, % code font size
+numbers=left, % where to put the line-numbers
+numberstyle=\footnotesize, % line number font size
+stepnumber=0, % the step between two line-numbers.
+backgroundcolor=\color{zelena}, % choose the background color
+frame=single,
+framerule=1pt,
+captionpos=b, % t or b
+commentstyle=\color{blue},
+inputencoding=utf8,
+extendedchars=\false,
+showstringspaces=false, % underline spaces within strings
+showspaces=false, % show spaces within strings with underscores
+showtabs=false, % show tabs within strings with underscores
+breaklines=true % Break long lines of code
+}
-
\begin{titlepage}
\begin{center}
Modified: others/dokumentace/technicalGuide/architecture/0architecture.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/0architecture.tex
2010-02-28 12:09:30 UTC (rev 1939)
+++ others/dokumentace/technicalGuide/architecture/0architecture.tex
2010-02-28 14:21:24 UTC (rev 1940)
@@ -14,13 +14,14 @@
\usepackage[czech]{babel}
\usepackage[left=2cm]{geometry}
\usepackage{listings}
+\renewcommand*\lstlistingname{Kód}
\usepackage{float}
\usepackage{color}
\definecolor{zelena}{rgb}{0.92,1,0.92}
-\newfloat{program}{thp}{lop}
-\floatname{program}{Kód}
+
+
\pagestyle{fancy}
% with this we ensure that the chapter and section
% headings are in lowercase
@@ -44,15 +45,18 @@
\begin{document}
\lstset{
-language=C, % choose the language of the code
+language=XML, % choose the language of the code
basicstyle=\footnotesize\ttfamily, % code font size
numbers=left, % where to put the line-numbers
numberstyle=\footnotesize, % line number font size
stepnumber=0, % the step between two line-numbers.
backgroundcolor=\color{zelena}, % choose the background color
frame=single,
-framerule=0pt,
+framerule=1pt,
captionpos=b, % t or b
+commentstyle=\color{blue},
+inputencoding=utf8,
+extendedchars=\false,
showstringspaces=false, % underline spaces within strings
showspaces=false, % show spaces within strings with underscores
showtabs=false, % show tabs within strings with underscores
Modified: others/dokumentace/technicalGuide/architecture/6clientapp.tex
===================================================================
--- others/dokumentace/technicalGuide/architecture/6clientapp.tex
2010-02-28 12:09:30 UTC (rev 1939)
+++ others/dokumentace/technicalGuide/architecture/6clientapp.tex
2010-02-28 14:21:24 UTC (rev 1940)
@@ -239,8 +239,7 @@
Je nutné však poznamenat, že k datu odevzdání projektu nebylo používání stylů
zdaleka bezchybné a ne všechny operace, které by dle dokumentace měly fungovat,
v reálu
opravdu měnily požadovaný vzhled.
-\begin{program}
-\begin{lstlisting}[language=HTML]
+\begin{lstlisting}[language=HTML,caption=Ukázka nastavení vzhledu aplikace]
QTabBar::tab:bottom {
min-width: 15ex;
min-height: 25px;
@@ -253,8 +252,6 @@
margin-bottom: -4px;
}
\end{lstlisting}
-\caption{Ukázka nastavení vzhledu aplikace}
-\end{program}
\section{Snímky obrazovky}
Modified: others/dokumentace/userGuide/client.tex
===================================================================
--- others/dokumentace/userGuide/client.tex 2010-02-28 12:09:30 UTC (rev
1939)
+++ others/dokumentace/userGuide/client.tex 2010-02-28 14:21:24 UTC (rev
1940)
@@ -174,7 +174,7 @@
.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}
+ .2 \textbf{elvys-restart.sh} - \DTcomment{skript na restartovani aplikace,
funguje i při spuštění přes ssh}.
}
@@ -186,76 +186,12 @@
\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
+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:
-\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>
+\lstinputlisting[caption=Ukázka souboru
appConfig.xml]{../../../others/xsd/version2/examples/appConfig.xml}
- <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.
@@ -307,12 +243,11 @@
\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.
+Nezvětšené PDF prezentace rotují s intervalem, který lze nastavit ve webové
aplikaci.
+Při zvětšení dokumetu je automatické rotování zastaveno 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
+Šipkami nahoru a doleva se lze přesouvat na předchozí stranu, šipkami doprava
a dolů pak na stranu následující. Na kiosku se listuje podobně pomocí
příslušných tlačítek ve tvaru šipky.
\subsection{Statický text}
Modified: others/dokumentace/userGuide/server.tex
===================================================================
--- others/dokumentace/userGuide/server.tex 2010-02-28 12:09:30 UTC (rev
1939)
+++ others/dokumentace/userGuide/server.tex 2010-02-28 14:21:24 UTC (rev
1940)
@@ -458,7 +458,7 @@
\end{itemize}
V seznamu lze vyhledávat zadáním textu do pole \textbf{Vyhledat:} a kliknutím
na ikonu \includegraphics[scale=0.6]{imgs/WebServer/icons/detail.png} se spustí
LayoutDesigner pro tvorbu nového rozvržení.
-Seznam je možné třídit podle sloupců \textbf{Název}, \textbf{Pozice},
\texbf{tModifikováno}, \textbf{Revize} a \textbf{Vytvořeno}.
+Seznam je možné třídit podle sloupců \textbf{Název}, \textbf{Pozice},
\textbf{Modifikováno}, \textbf{Revize} a \textbf{Vytvořeno}.
\section{Kategorie}
@@ -468,7 +468,7 @@
\item \textbf{Jméno kategorie} - jméno dané kategorie
\item \textbf{Vytvořeno} - datum, kdy byla kategorie vytvořena
\item \textbf{Jméno rozvržení} - jméno použitého rozvržení
- \item \textbf{#Přiřazení} - na kolika kioscích je tato kategorie použita, po
kliknut
+ \item \textbf{\#Přiřazení} - na kolika kioscích je tato kategorie použita, po
kliknutí se zobrazí seznam příslušných kiosků
\item \textbf{Akce}
\begin{itemize}
\item \textbf{Zobrazit náhled rozvržení obrazovky}
\includegraphics[scale=0.6]{imgs/WebServer/icons/detail.png} - ukáže
schematický nákres rozvržení, které je použito pro tuto kategorii
@@ -486,7 +486,7 @@
\caption{Seznam kategorií}
\end{figure}
-Dále lze vytvořit novou kategorii kliknutím na ikonu
\includegraphics[scale=0.6]{imgs/WebServer/icons/create.png}, vyhledávat v
seznamu zadáním textu do pole \textbf{Vyhledávat:} a třídit záznamy podle
položek \textbf{Jméno kategorie}, \textbf{Vytvořeno}, \textbf{Jméno rozvržení}
a \textbf{#Přiřazení}.
+Dále lze vytvořit novou kategorii kliknutím na ikonu
\includegraphics[scale=0.6]{imgs/WebServer/icons/create.png}, vyhledávat v
seznamu zadáním textu do pole \textbf{Vyhledávat:} a třídit záznamy podle
položek \textbf{Jméno kategorie}, \textbf{Vytvořeno}, \textbf{Jméno rozvržení}
a \textbf{\#Přiřazení}.
Seznam je vidět na obrázku \ref{categoryList}.
\subsection{Vytvoření nové kategorie a její editace}
@@ -502,7 +502,7 @@
Formulář pro vytvoření nové kategorie je vidět na obrázku \ref{createCategory}
a má následující položky
\begin{itemize}
\item \textbf{Jméno} - název kategorie, to musí být v rámci společnosti
přihlášeného uživatele jednoznačné
- \item \tetbf{Rozvržení obrazovky} - uživatel vybere ze seznamu rozvržení
+ \item \textbf{Rozvržení obrazovky} - uživatel vybere ze seznamu rozvržení
\end{itemize}
Modified: others/dokumentace/userGuide/userGuide.tex
===================================================================
--- others/dokumentace/userGuide/userGuide.tex 2010-02-28 12:09:30 UTC (rev
1939)
+++ others/dokumentace/userGuide/userGuide.tex 2010-02-28 14:21:24 UTC (rev
1940)
@@ -10,14 +10,12 @@
\usepackage[bookmarks=true]{hyperref}
\usepackage{dirtree}
\usepackage{listings}
+\renewcommand*\lstlistingname{Kód}
\usepackage{float}
\usepackage{color}
\definecolor{zelena}{rgb}{0.92,1,0.92}
-\newfloat{program}{thp}{lop}
-\floatname{program}{Kód}
-
\usepackage[left=2cm]{geometry}
\pagestyle{fancy}
% with this we ensure that the chapter and section
@@ -36,6 +34,24 @@
\frenchspacing
\begin{document}
+\lstset{
+language=XML, % choose the language of the code
+basicstyle=\footnotesize\ttfamily, % code font size
+numbers=left, % where to put the line-numbers
+numberstyle=\footnotesize, % line number font size
+stepnumber=0, % the step between two line-numbers.
+backgroundcolor=\color{zelena}, % choose the background color
+frame=single,
+framerule=1pt,
+captionpos=b, % t or b
+commentstyle=\color{blue},
+inputencoding=utf8,
+extendedchars=\false,
+showstringspaces=false, % underline spaces within strings
+showspaces=false, % show spaces within strings with underscores
+showtabs=false, % show tabs within strings with underscores
+breaklines=true % Break long lines of code
+}
\begin{titlepage}
\begin{center} {\LARGE Elektronický vývěskový systém ELVYS} \\ \end{center}
Other related posts:
- » [elvystrac] r1940 - some changes in documentation styling - elvys
