Manual: add %Vg and %Vs tags. Closes FS#12230.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30332 a1c6a512-1295-4272-9138-f99709370657

5 files changed, 42 insertions, 8 deletions

diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 66da59e..17e72cd 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -263,6 +263,27 @@ area of the screen.
 \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}}
 \opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}}
 
+\opt{lcd_non-mono}{
+\subsubsection{Viewport Line Text Styles}
+  \begin{tagmap}
+    \config{\%Vs(mode[,param])}
+    & Set the viewport text style to `mode' from this point forward\\
+  \end{tagmap}
+
+Mode can be the following:
+
+\begin{rbtabular}{.75\textwidth}{lX}{\textbf{Mode} & \textbf{Description}}{}{}
+  clear & Restore the default style\\
+  invert & Draw lines inverted\\
+  color & Draw the text coloured by the value given in `param'. Functionally
+    equivalent to using the \%Vf() tag\\
+  \opt{lcd_color}{%
+    gradient & Draw the next `param' lines using a gradient as
+    defined by \%Vg. By default the gradient is drawn over 1 line.
+    \%Vs(gradient,2) will use 2 lines to fully change from the start colour to
+    the end colour\\}
+\end{rbtabular}
+}
 
 \subsubsection{Conditional Viewports}
 
diff --git a/manual/advanced_topics/viewports/colour-vp-syntax.tex b/manual/advanced_topics/viewports/colour-vp-syntax.tex
index 2b0e932..d027c3b 100644
--- a/manual/advanced_topics/viewports/colour-vp-syntax.tex
+++ b/manual/advanced_topics/viewports/colour-vp-syntax.tex
@@ -1,9 +1,14 @@
 \subsubsection{Viewport Declaration Syntax}
 
-\config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour])}%
+\config{\%V(x,y,[width],[height],[font]) \%Vf([fgcolour]) \%Vb([bgcolour]) %
+    \%Vg(start, end [,text])}%
 
     \begin{itemize}
+      \item \%Vf and \%Vb set the foreground and background colours respectively.
       \item `fgcolour' and `bgcolour' are 6-digit RGB888 colours, e.g. FF00FF.
+      \item \%Vg defines a gradient fill that can then be used with the \%Vs tag.
+      `start' and `end' set the initial and final colours, and the optional `text'
+      sets the text colour. Colours are 6-digit RGB888, e.g. FF00FF.
       \item `font' is a number: 0 is the built-in system font, 1 is the
       current menu font, and 2-9 are additional skin loaded fonts (see 
       \reference{ref:multifont}).
@@ -12,15 +17,16 @@
     \end{itemize}
 
 \note{The correct number of commas with hyphens in
-      blank fields are still needed in any case.}
+      blank fields are still needed.}
 
 \begin{example}
-    %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF)
+    %V(12,20,-,-,1) %Vf(000000) %Vb(FFFFFF) %Vg(FFC0CB, FF0000, FFFF00)
     %sThis viewport is displayed permanently. It starts 12px from the left and
     %s20px from the top of the screen, and fills the rest of the screen from
     %sthat point. The lines will scroll if this text does not fit in the viewport.
     %sThe user font is used, and the foreground and background are set to black
-    %sand white respectively.
+    %sand white respectively. The line gradient is set to pink to red with yellow
+    %text.
 \end{example}
 \begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{}
   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 32248d2..2bced32 100644
--- a/manual/advanced_topics/viewports/grayscale-vp-syntax.tex
+++ b/manual/advanced_topics/viewports/grayscale-vp-syntax.tex
@@ -3,6 +3,8 @@
 \config{\%V(x,y,[width],[height],[font]) \%Vf([fgshade]) \%Vb([bgshade])}%
 
     \begin{itemize}
+      \item \%Vf and \%Vb set the foreground and background shade of grey
+      respectively.
       \item `fgshade' and `bgshade' are numbers in the range 0 (= black) to 3
       (= white).
       \item `font' is a number: 0 is the built-in system font, 1 is the
@@ -13,7 +15,7 @@
     \end{itemize}
 
 \note{The correct number of commas with hyphens in
-      blank fields are still needed in any case.}
+      blank fields are still needed.}
 
 \begin{example}
     %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 bb8fce6..5bc92c9 100644
--- a/manual/advanced_topics/viewports/mono-vp-syntax.tex
+++ b/manual/advanced_topics/viewports/mono-vp-syntax.tex
@@ -11,7 +11,7 @@
     \end{itemize}
 
 \note{The correct number of commas with hyphens in
-      blank fields are still needed in any case.}
+      blank fields are still needed.}
   
 \begin{example}
     %V(12,20,-,-,1)
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 7752ae9..5b3549d 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.
       \opt{lcd_color}{%
         \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
         \config{\%Vf([fgcolour])}\newline
-        \config{\%Vb([bgcolour])}
+        \config{\%Vb([bgcolour])}\newline
+        \config{\%Vg(start,end \tabnlindent[,text])}
         & See section \ref{ref:Viewports}\\}
-        
+
+      \opt{lcd_non-mono}{%
+        \config{\%Vs(mode[,param])}
+        & See section \ref{ref:Viewports}\\}
+
       \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later
       display. `identifier' is a single lowercase letter (a-z) and the `\dots'
       parameters use the same logic as the \%V tag explained above.\\