manual/advanced_topics/viewports/grayscale-vp-syntax.tex

   1 \subsubsection{Viewport Declaration Syntax}
   2
   3 \config{\%V{\textbar}x{\textbar}y{\textbar}[width]{\textbar}[height]{\textbar}[font]{\textbar}[fgshade]{\textbar}[bgshade]{\textbar}}%
   4
   5     \begin{itemize}
   6       \item `fgshade' and `bgshade' are numbers in the range 0 (= black) to 3
   7       (= white).
   8       \item `font' is a number: 0 is the built-in system font, 1 is the
   9       current menu font, and 2-9 are additional are skin loaded fonts (see
  10       \reference{ref:multifont}).
  11       \item Only the coordinates \emph{have} to be specified. Leaving the other
  12       definitions blank will set them to their default values.
  13     \end{itemize}
  14
  15 \note{The correct number of `{\textbar}'s (vertical bars) with hyphens in
  16       blank fields are still needed in any case.}
  17
  18 \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}
  25 \begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{}
  26   width/height & remaining part of screen \\
  27   font & user defined \\
  28   shade & black foreground on white background \\
  29 \end{rbtabular}
  30