summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
Diffstat (limited to 'manual')
-rwxr-xr-xmanual/advanced_topics/main.tex54
-rw-r--r--manual/appendix/wps_tags.tex91
-rw-r--r--manual/plugins/text_viewer.tex2
3 files changed, 69 insertions, 78 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 786c109772..00b1688e11 100755
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -168,32 +168,30 @@ file find the instructions on the Rockbox website:
168 the \fname{/.rockbox/backdrops} directory. 168 the \fname{/.rockbox/backdrops} directory.
169}% 169}%
170 170
171\nopt{lcd_charcell}{ 171\subsection{UI Viewport}
172 \subsection{UI Viewport} 172By default, the UI is drawn on the whole screen. This can be changed so that
173 By default, the UI is drawn on the whole screen. This can be changed so that 173the UI is confined to a specific area of the screen, by use of a UI
174 the UI is confined to a specific area of the screen, by use of a UI 174viewport. This is done by adding the following line to the
175 viewport. This is done by adding the following line to the 175\fname{.cfg} file for a theme:\\*
176 \fname{.cfg} file for a theme:\\* 176
177 177\nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}}
178 \nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}} 178\nopt{lcd_color}{\opt{lcd_non-mono}{
179 \config{ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
180\opt{lcd_color}{
181 \config{ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
182\\*
183
184\opt{HAVE_REMOTE_LCD}{
185 The dimensions of the menu that is displayed on the remote control of your
186 \dap\ can be set in the same way. The line to be added to the theme
187 \fname{.cfg} is the following:\\*
188
189 \nopt{lcd_non-mono}{\config{remote ui viewport: X,Y,[width],[height],[font]}}
179 \nopt{lcd_color}{\opt{lcd_non-mono}{ 190 \nopt{lcd_color}{\opt{lcd_non-mono}{
180 \config{ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}} 191 \config{remote ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
181 \opt{lcd_color}{ 192 \opt{lcd_color}{
182 \config{ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}} 193 \config{remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
183 \\* 194\\*
184
185 \opt{HAVE_REMOTE_LCD}{
186 The dimensions of the menu that is displayed on the remote control of your
187 \dap\ can be set in the same way. The line to be added to the theme
188 \fname{.cfg} is the following:\\*
189
190 \nopt{lcd_non-mono}{\config{remote ui viewport: X,Y,[width],[height],[font]}}
191 \nopt{lcd_color}{\opt{lcd_non-mono}{
192 \config{remote ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
193 \opt{lcd_color}{
194 \config{remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
195 \\*
196 }
197 195
198 Only the first two parameters \emph{have} to be specified, the others can 196 Only the first two parameters \emph{have} to be specified, the others can
199 be omitted using `$-$' as a placeholder. The syntax is very similar to WPS 197 be omitted using `$-$' as a placeholder. The syntax is very similar to WPS
@@ -202,7 +200,6 @@ file find the instructions on the Rockbox website:
202 \nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-uivp-syntax.tex}} 200 \nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-uivp-syntax.tex}}
203 \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-uivp-syntax.tex}}} 201 \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-uivp-syntax.tex}}}
204 \opt{lcd_color}{\input{advanced_topics/viewports/colour-uivp-syntax.tex}} 202 \opt{lcd_color}{\input{advanced_topics/viewports/colour-uivp-syntax.tex}}
205}
206 203
207\section{\label{ref:ConfiguringtheWPS}Configuring the Theme} 204\section{\label{ref:ConfiguringtheWPS}Configuring the Theme}
208 205
@@ -265,7 +262,6 @@ are discussed below.
265 } 262 }
266} 263}
267 264
268\nopt{lcd_charcell}{
269\subsubsection{\label{ref:Viewports}Viewports} 265\subsubsection{\label{ref:Viewports}Viewports}
270 266
271By default, a viewport filling the whole screen contains all the elements 267By default, a viewport filling the whole screen contains all the elements
@@ -279,7 +275,7 @@ be defined. A viewport is a rectangular window on the screen%
279\opt{lcd_non-mono}{ with its own foreground/background 275\opt{lcd_non-mono}{ with its own foreground/background
280\opt{lcd_color}{colours}\nopt{lcd_color}{shades}}. 276\opt{lcd_color}{colours}\nopt{lcd_color}{shades}}.
281This window also has variable dimensions. To 277This window also has variable dimensions. To
282define a viewport a line starting \config{{\%V(\dots}} has to be 278define a viewport a line starting \config{{\%V(\dots)}} has to be
283present in the theme file. The full syntax will be explained later in 279present in the theme file. The full syntax will be explained later in
284this section. All elements placed before the 280this section. All elements placed before the
285line defining a viewport are displayed in the default viewport. Elements 281line defining a viewport are displayed in the default viewport. Elements
@@ -293,6 +289,7 @@ cannot be layered \emph{transparently} over one another. Subsequent viewports
293will be drawn over any other viewports already drawn onto that 289will be drawn over any other viewports already drawn onto that
294area of the screen. 290area of the screen.
295 291
292
296\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-vp-syntax.tex}} 293\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-vp-syntax.tex}}
297\nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}} 294\nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}}
298\opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}} 295\opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}}
@@ -318,11 +315,10 @@ Mode can be the following:
318 the end colour\\} 315 the end colour\\}
319\end{rbtabular} 316\end{rbtabular}
320} 317}
321
322\subsubsection{Conditional Viewports} 318\subsubsection{Conditional Viewports}
323 319
324Any viewport can be displayed either permanently or conditionally. 320Any viewport can be displayed either permanently or conditionally.
325Defining a viewport as \config{{\%V(\dots}} 321Defining a viewport as \config{{\%V(\dots)}}
326will display it permanently. 322will display it permanently.
327 323
328\begin{itemize} 324\begin{itemize}
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 1aec7bae99..1a0661c008 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -53,61 +53,58 @@ conditionals to show alternate information in preference to assuming.
53These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}), 53These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}),
54show the information for the next song to be played. 54show the information for the next song to be played.
55 55
56\nopt{lcd_charcell}{ 56\section{Viewports}
57 \section{Viewports} 57 \begin{tagmap}
58 \begin{tagmap} 58 \nopt{lcd_non-mono}{%
59 \nopt{lcd_non-mono}{% 59 \config{\%V(x,y,[width],\tabnlindent[height],[font])}
60 \config{\%V(x,y,[width],\tabnlindent[height],[font])} 60 & See section \ref{ref:Viewports}\\}
61 & See section \ref{ref:Viewports}\\} 61
62 62 \nopt{lcd_color}{\opt{lcd_non-mono}{%
63 \nopt{lcd_color}{\opt{lcd_non-mono}{% 63 \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
64 \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline 64 \config{\%Vf([fgshade])}\newline
65 \config{\%Vf([fgshade])}\newline 65 \config{\%Vb([bgshade])}
66 \config{\%Vb([bgshade])} 66 & See section \ref{ref:Viewports}\\}}
67 & See section \ref{ref:Viewports}\\}} 67
68 68 \opt{lcd_color}{%
69 \opt{lcd_color}{% 69 \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
70 \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline 70 \config{\%Vf([fgcolour])}\newline
71 \config{\%Vf([fgcolour])}\newline 71 \config{\%Vb([bgcolour])}\newline
72 \config{\%Vb([bgcolour])}\newline 72 \config{\%Vg(start,end \tabnlindent[,text])}
73 \config{\%Vg(start,end \tabnlindent[,text])} 73 & See section \ref{ref:Viewports}\\}
74 & See section \ref{ref:Viewports}\\} 74
75 75 \opt{lcd_non-mono}{%
76 \opt{lcd_non-mono}{% 76 \config{\%Vs(mode[,param])}
77 \config{\%Vs(mode[,param])} 77 & See section \ref{ref:Viewports}\\}
78 & See section \ref{ref:Viewports}\\} 78 \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later
79
80 \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later
81 display. `identifier' is a single lowercase letter (a-z) and the `\dots' 79 display. `identifier' is a single lowercase letter (a-z) and the `\dots'
82 parameters use the same logic as the \%V tag explained above.\\ 80 parameters use the same logic as the \%V tag explained above.\\
83 81
84 \config{\%Vd('identifier')} & Display the `identifier' viewport. E.g. 82 \config{\%Vd('identifier')} & Display the `identifier' viewport. E.g.
85 \config{\%?C<\%Vd(a)|\%Vd(b)>} 83 \config{\%?C<\%Vd(a)|\%Vd(b)>}
86 will show viewport `a' if album art is found, and `b' if it isn't.\\ 84 will show viewport `a' if album art is found, and `b' if it isn't.\\
87 85
88 \config{\%Vi('label',\dots)} & 86 \config{\%Vi('label',\dots)} &
89 Declare a Custom UI Viewport. The `\dots' parameters use the same logic as 87 Declare a Custom UI Viewport. The `\dots' parameters use the same logic as
90 the \config{\%V} tag explained above. See section \ref{ref:Viewports}.\\ 88 the \config{\%V} tag explained above. See section \ref{ref:Viewports}.\\
91 89
92 \config{\%VI('label')} & Set the Info Viewport to use the viewport called 90 \config{\%VI('label')} & Set the Info Viewport to use the viewport called
93 label, as declared with the previous tag.\\ 91 label, as declared with the previous tag.\\
94 92
95 \config{\%VB} & Draw this viewport on the backdrop layer.\\ 93 \config{\%VB} & Draw this viewport on the backdrop layer.\\
96 \end{tagmap} 94 \end{tagmap}
97 95
98 \section{Additional Fonts} 96\section{Additional Fonts}
99 \begin{tagmap} 97 \begin{tagmap}
100 \config{\%Fl('id',filename)} & See section \ref{ref:multifont}.\\ 98 \config{\%Fl('id',filename)} & See section \ref{ref:multifont}.\\
101 \end{tagmap} 99 \end{tagmap}
102 100
103 \section{Misc Coloring Tags} 101\section{Misc Coloring Tags}
104 \begin{tagmap} 102 \begin{tagmap}
105 \config{\%dr(x,y,width,height,[color1,color2])} & Color a rectangle. \\ 103 \config{\%dr(x,y,width,height,[color1,color2])} & Color a rectangle. \\
106 \end{tagmap} 104 \end{tagmap}
107 width and height can be ``$-$'' to fill the viewport. If no color is 105 width and height can be ``$-$'' to fill the viewport. If no color is
108 specified the viewports foreground color will be used. If two 106 specified the viewports foreground color will be used. If two
109 colors are specified it will do a gradient fill. 107 colors are specified it will do a gradient fill.
110}
111 108
112\section{Power Related Information} 109\section{Power Related Information}
113 \begin{tagmap} 110 \begin{tagmap}
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex
index 60b38e7a7e..fe369d1c90 100644
--- a/manual/plugins/text_viewer.tex
+++ b/manual/plugins/text_viewer.tex
@@ -196,8 +196,6 @@ by using \emph{Open with} from the \emph{Context Menu}
196\item[Viewer Options] Change settings for the current file. 196\item[Viewer Options] Change settings for the current file.
197 \begin{description} 197 \begin{description}
198 \item[Encoding] Set the codepage in the text viewer. 198 \item[Encoding] Set the codepage in the text viewer.
199% ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude
200% ones that don't work on charcell - as soon as the plugin itself does
201 Available settings: 199 Available settings:
202 \setting{ISO-8859-1} (Latin 1). 200 \setting{ISO-8859-1} (Latin 1).
203 \setting{ISO-8859-7} (Greek), 201 \setting{ISO-8859-7} (Greek),