blob: a8460703a992d8dd822520670eb6e2024514aa06 [file] [log] [blame]
Alex Parkerab563da2009-09-20 16:48:45 +00001\subsubsection{Viewport Declaration Syntax}
2
Alexander Levin64bb9a02010-05-18 20:23:22 +00003\config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}[height]{\textbar}[font]{\textbar}[fgshade]{\textbar}[bgshade]{\textbar}}%
Alex Parkerab563da2009-09-20 16:48:45 +00004
5 \begin{itemize}
Alexander Levinb57fe482009-12-23 20:05:29 +00006 \item `fgshade' and `bgshade' are numbers in the range 0 (= black) to 3
Alex Parkerab563da2009-09-20 16:48:45 +00007 (= white).
Alexander Levinb57fe482009-12-23 20:05:29 +00008 \item `font' is a number: 0 is the built-in system font, 1 is the
Alex Parker1b0c77f2010-06-20 12:58:09 +00009 current menu font, and 2-9 are additional are skin loaded fonts (see
10 \reference{ref:multifont}).
Alex Parkerab563da2009-09-20 16:48:45 +000011 \item Only the coordinates \emph{have} to be specified. Leaving the other
12 definitions blank will set them to their default values.
Alex Parkerab563da2009-09-20 16:48:45 +000013 \end{itemize}
14
Alexander Levin64bb9a02010-05-18 20:23:22 +000015\note{The correct number of `{\textbar}'s (vertical bars) with hyphens in
16 blank fields are still needed in any case.}
17
Alex Parkerab563da2009-09-20 16:48:45 +000018\begin{example}
19 %V|12|20|-|-|1|-|-|
20 %sThis viewport is displayed permanently. It starts 12px from the left and
21 %s20px from the top of the screen, and fills the rest of the screen from
22 %sthat point. The lines will scroll if this text does not fit in the viewport.
23 %sThe user font is used, as are the default foreground/background shades.
24\end{example}
Alexander Levin9df56382010-05-12 22:06:18 +000025\begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{}
Alex Parkerab563da2009-09-20 16:48:45 +000026 width/height & remaining part of screen \\
27 font & user defined \\
28 shade & black foreground on white background \\
29\end{rbtabular}
Alexander Levinb57fe482009-12-23 20:05:29 +000030