diff options
author | Alex Parker <rockbox@aeparker.com> | 2011-08-19 11:43:51 +0000 |
---|---|---|
committer | Alex Parker <rockbox@aeparker.com> | 2011-08-19 11:43:51 +0000 |
commit | 77a78ee8f4927258ae8778435200c61a41a68db2 (patch) | |
tree | e57328ef9406751eb6343edc3356c09dbe470e2d | |
parent | 0aa2fcb3b66b7281dc1dedd954d98b005bd4f1b5 (diff) | |
download | rockbox-77a78ee8f4927258ae8778435200c61a41a68db2.tar.gz rockbox-77a78ee8f4927258ae8778435200c61a41a68db2.zip |
Manual: add %Vg and %Vs tags. Closes FS#12230.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30332 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r-- | manual/advanced_topics/main.tex | 21 | ||||
-rw-r--r-- | manual/advanced_topics/viewports/colour-vp-syntax.tex | 14 | ||||
-rw-r--r-- | manual/advanced_topics/viewports/grayscale-vp-syntax.tex | 4 | ||||
-rw-r--r-- | manual/advanced_topics/viewports/mono-vp-syntax.tex | 2 | ||||
-rw-r--r-- | manual/appendix/wps_tags.tex | 9 |
5 files changed, 42 insertions, 8 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex index 66da59e04b..17e72cd51a 100644 --- a/manual/advanced_topics/main.tex +++ b/manual/advanced_topics/main.tex | |||
@@ -263,6 +263,27 @@ area of the screen. | |||
263 | \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}} | 263 | \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}} |
264 | \opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}} | 264 | \opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}} |
265 | 265 | ||
266 | \opt{lcd_non-mono}{ | ||
267 | \subsubsection{Viewport Line Text Styles} | ||
268 | \begin{tagmap} | ||
269 | \config{\%Vs(mode[,param])} | ||
270 | & Set the viewport text style to `mode' from this point forward\\ | ||
271 | \end{tagmap} | ||
272 | |||
273 | Mode can be the following: | ||
274 | |||
275 | \begin{rbtabular}{.75\textwidth}{lX}{\textbf{Mode} & \textbf{Description}}{}{} | ||
276 | clear & Restore the default style\\ | ||
277 | invert & Draw lines inverted\\ | ||
278 | color & Draw the text coloured by the value given in `param'. Functionally | ||
279 | equivalent to using the \%Vf() tag\\ | ||
280 | \opt{lcd_color}{% | ||
281 | gradient & Draw the next `param' lines using a gradient as | ||
282 | defined by \%Vg. By default the gradient is drawn over 1 line. | ||
283 | \%Vs(gradient,2) will use 2 lines to fully change from the start colour to | ||
284 | the end colour\\} | ||
285 | \end{rbtabular} | ||
286 | } | ||
266 | 287 | ||
267 | \subsubsection{Conditional Viewports} | 288 | \subsubsection{Conditional Viewports} |
268 | 289 | ||
diff --git a/manual/advanced_topics/viewports/colour-vp-syntax.tex b/manual/advanced_topics/viewports/colour-vp-syntax.tex index 2b0e932af7..d027c3b757 100644 --- a/manual/advanced_topics/viewports/colour-vp-syntax.tex +++ b/manual/advanced_topics/viewports/colour-vp-syntax.tex | |||
@@ -1,9 +1,14 @@ | |||
1 | \subsubsection{Viewport Declaration Syntax} | 1 | \subsubsection{Viewport Declaration Syntax} |
2 | 2 | ||
3 | \config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour])}% | 3 | \config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour]) % |
4 | \%Vg(start, end [,text])}% | ||
4 | 5 | ||
5 | \begin{itemize} | 6 | \begin{itemize} |
7 | \item \%Vf and \%Vb set the foreground and background colours respectively. | ||
6 | \item `fgcolour' and `bgcolour' are 6-digit RGB888 colours, e.g. FF00FF. | 8 | \item `fgcolour' and `bgcolour' are 6-digit RGB888 colours, e.g. FF00FF. |
9 | \item \%Vg defines a gradient fill that can then be used with the \%Vs tag. | ||
10 | `start' and `end' set the initial and final colours, and the optional `text' | ||
11 | sets the text colour. Colours are 6-digit RGB888, e.g. FF00FF. | ||
7 | \item `font' is a number: 0 is the built-in system font, 1 is the | 12 | \item `font' is a number: 0 is the built-in system font, 1 is the |
8 | current menu font, and 2-9 are additional skin loaded fonts (see | 13 | current menu font, and 2-9 are additional skin loaded fonts (see |
9 | \reference{ref:multifont}). | 14 | \reference{ref:multifont}). |
@@ -12,15 +17,16 @@ | |||
12 | \end{itemize} | 17 | \end{itemize} |
13 | 18 | ||
14 | \note{The correct number of commas with hyphens in | 19 | \note{The correct number of commas with hyphens in |
15 | blank fields are still needed in any case.} | 20 | blank fields are still needed.} |
16 | 21 | ||
17 | \begin{example} | 22 | \begin{example} |
18 | %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF) | 23 | %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF) %Vg(FFC0CB, FF0000, FFFF00) |
19 | %sThis viewport is displayed permanently. It starts 12px from the left and | 24 | %sThis viewport is displayed permanently. It starts 12px from the left and |
20 | %s20px from the top of the screen, and fills the rest of the screen from | 25 | %s20px from the top of the screen, and fills the rest of the screen from |
21 | %sthat point. The lines will scroll if this text does not fit in the viewport. | 26 | %sthat point. The lines will scroll if this text does not fit in the viewport. |
22 | %sThe user font is used, and the foreground and background are set to black | 27 | %sThe user font is used, and the foreground and background are set to black |
23 | %sand white respectively. | 28 | %sand white respectively. The line gradient is set to pink to red with yellow |
29 | %text. | ||
24 | \end{example} | 30 | \end{example} |
25 | \begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{} | 31 | \begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{} |
26 | width/height & remaining part of screen \\ | 32 | width/height & remaining part of screen \\ |
diff --git a/manual/advanced_topics/viewports/grayscale-vp-syntax.tex b/manual/advanced_topics/viewports/grayscale-vp-syntax.tex index 32248d275e..2bced327d8 100644 --- a/manual/advanced_topics/viewports/grayscale-vp-syntax.tex +++ b/manual/advanced_topics/viewports/grayscale-vp-syntax.tex | |||
@@ -3,6 +3,8 @@ | |||
3 | \config{\%V(x,y,[width],[height],[font]) \%Vf([fgshade]) \%Vb([bgshade])}% | 3 | \config{\%V(x,y,[width],[height],[font]) \%Vf([fgshade]) \%Vb([bgshade])}% |
4 | 4 | ||
5 | \begin{itemize} | 5 | \begin{itemize} |
6 | \item \%Vf and \%Vb set the foreground and background shade of grey | ||
7 | respectively. | ||
6 | \item `fgshade' and `bgshade' are numbers in the range 0 (= black) to 3 | 8 | \item `fgshade' and `bgshade' are numbers in the range 0 (= black) to 3 |
7 | (= white). | 9 | (= white). |
8 | \item `font' is a number: 0 is the built-in system font, 1 is the | 10 | \item `font' is a number: 0 is the built-in system font, 1 is the |
@@ -13,7 +15,7 @@ | |||
13 | \end{itemize} | 15 | \end{itemize} |
14 | 16 | ||
15 | \note{The correct number of commas with hyphens in | 17 | \note{The correct number of commas with hyphens in |
16 | blank fields are still needed in any case.} | 18 | blank fields are still needed.} |
17 | 19 | ||
18 | \begin{example} | 20 | \begin{example} |
19 | %V(12,20,-,-,1) %Vf(0) %Vb(3) | 21 | %V(12,20,-,-,1) %Vf(0) %Vb(3) |
diff --git a/manual/advanced_topics/viewports/mono-vp-syntax.tex b/manual/advanced_topics/viewports/mono-vp-syntax.tex index bb8fce64da..5bc92c9a8d 100644 --- a/manual/advanced_topics/viewports/mono-vp-syntax.tex +++ b/manual/advanced_topics/viewports/mono-vp-syntax.tex | |||
@@ -11,7 +11,7 @@ | |||
11 | \end{itemize} | 11 | \end{itemize} |
12 | 12 | ||
13 | \note{The correct number of commas with hyphens in | 13 | \note{The correct number of commas with hyphens in |
14 | blank fields are still needed in any case.} | 14 | blank fields are still needed.} |
15 | 15 | ||
16 | \begin{example} | 16 | \begin{example} |
17 | %V(12,20,-,-,1) | 17 | %V(12,20,-,-,1) |
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex index 7752ae9ca3..5b3549d2ab 100644 --- a/manual/appendix/wps_tags.tex +++ b/manual/appendix/wps_tags.tex | |||
@@ -69,9 +69,14 @@ show the information for the next song to be played. | |||
69 | \opt{lcd_color}{% | 69 | \opt{lcd_color}{% |
70 | \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline | 70 | \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline |
71 | \config{\%Vf([fgcolour])}\newline | 71 | \config{\%Vf([fgcolour])}\newline |
72 | \config{\%Vb([bgcolour])} | 72 | \config{\%Vb([bgcolour])}\newline |
73 | \config{\%Vg(start,end \tabnlindent[,text])} | ||
73 | & See section \ref{ref:Viewports}\\} | 74 | & See section \ref{ref:Viewports}\\} |
74 | 75 | ||
76 | \opt{lcd_non-mono}{% | ||
77 | \config{\%Vs(mode[,param])} | ||
78 | & See section \ref{ref:Viewports}\\} | ||
79 | |||
75 | \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later | 80 | \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later |
76 | display. `identifier' is a single lowercase letter (a-z) and the `\dots' | 81 | display. `identifier' is a single lowercase letter (a-z) and the `\dots' |
77 | parameters use the same logic as the \%V tag explained above.\\ | 82 | parameters use the same logic as the \%V tag explained above.\\ |