blob: d2c290747d57ee20544ea9ce196a8b4fae9c7dd1 [file] [log] [blame]
Alex Parkerab563da2009-09-20 16:48:45 +00001\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}
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 Parkerab563da2009-09-20 16:48:45 +00009 user-selected font.
10 \item Only the coordinates \emph{have} to be specified. Leaving the other
11 definitions blank will set them to their default values.
Alexander Levinb57fe482009-12-23 20:05:29 +000012 \note{The correct number of `{\textbar}'s (vertical bars) with hyphens in
13 blank fields are still needed in any case.}
Alex Parkerab563da2009-09-20 16:48:45 +000014 \end{itemize}
15
16\begin{example}
17 %V|12|20|-|-|1|-|-|
18 %sThis viewport is displayed permanently. It starts 12px from the left and
19 %s20px from the top of the screen, and fills the rest of the screen from
20 %sthat point. The lines will scroll if this text does not fit in the viewport.
21 %sThe user font is used, as are the default foreground/background shades.
22\end{example}
Alexander Levin9df56382010-05-12 22:06:18 +000023\begin{rbtabular}{.75\textwidth}{XX}{\textbf{Viewport definition} & \textbf{Default value}}{}{}
Alex Parkerab563da2009-09-20 16:48:45 +000024 width/height & remaining part of screen \\
25 font & user defined \\
26 shade & black foreground on white background \\
27\end{rbtabular}
Alexander Levinb57fe482009-12-23 20:05:29 +000028