summaryrefslogtreecommitdiffstats
path: root/manual/advanced_topics/viewports/colour-vp-syntax.tex
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2009-09-20 16:48:45 +0000
committerAlex Parker <rockbox@aeparker.com>2009-09-20 16:48:45 +0000
commitab563da17585992e9b8d54db1d4e36ba50d65d43 (patch)
treee9fdbdcbafe23a04fd9bee7c381b031b1a0f7a1e /manual/advanced_topics/viewports/colour-vp-syntax.tex
parent16cb628eb7d86e64dc7cab739ebb8dfc6e9900c2 (diff)
downloadrockbox-ab563da17585992e9b8d54db1d4e36ba50d65d43.tar.gz
rockbox-ab563da17585992e9b8d54db1d4e36ba50d65d43.zip
Add viewports to the manual. Adapted from FS#9934 by Jonas Häggqvist and FS#10553 by David Kauffmann
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22756 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/advanced_topics/viewports/colour-vp-syntax.tex')
-rw-r--r--manual/advanced_topics/viewports/colour-vp-syntax.tex26
1 files changed, 26 insertions, 0 deletions
diff --git a/manual/advanced_topics/viewports/colour-vp-syntax.tex b/manual/advanced_topics/viewports/colour-vp-syntax.tex
new file mode 100644
index 0000000000..c88451724c
--- /dev/null
+++ b/manual/advanced_topics/viewports/colour-vp-syntax.tex
@@ -0,0 +1,26 @@
+\subsubsection{Viewport Declaration Syntax}
+
+{\config{\%V}}{\textbar}x{\textbar}y{\textbar}[width]{\textbar}[height]{\textbar}[font]{\textbar}[fgcolour]{\textbar}[bgcolour]{\textbar}%
+
+ \begin{itemize}
+ \item 'fgcolour' and 'bgcolour' are 6-digit RGB888 colours - e.g. FF00FF.
+ \item 'font' is a number - '0' is the built-in system font, '1' is the
+ user-selected font.
+ \item Only the coordinates \emph{have} to be specified. Leaving the other
+ definitions blank will set them to their default values.
+ \note{The correct number of {\textbar}s with hyphens in blank fields
+ are still needed in any case.}
+ \end{itemize}
+
+\begin{example}
+ %V|12|20|-|-|1|-|-|
+ %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, as are the default foreground/background colours.
+\end{example}
+\begin{rbtabular}{.75\textwidth}{XX}{Viewport definition & Default value}{}{}
+ width/height & remaining part of screen \\
+ font & user defined \\
+ forground/background colours & defined by theme \\
+\end{rbtabular} \ No newline at end of file