ec8db029a510618f683fa800cd998697a3845e11
[kugel-rb.git] / manual / advanced_topics / viewports / grayscale-vp-syntax.tex
blobec8db029a510618f683fa800cd998697a3845e11
1 \subsubsection{Viewport Declaration Syntax}
3 {\config{\%V}}{\textbar}x{\textbar}y{\textbar}[width]{\textbar}[height]{\textbar}[font]{\textbar}[fgshade]{\textbar}[bgshade]{\textbar}%
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 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.
12 \note{The correct number of `{\textbar}'s (vertical bars) with hyphens in
13 blank fields are still needed in any case.}
14 \end{itemize}
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}
23 \begin{rbtabular}{.75\textwidth}{XX}{Viewport definition & Default value}{}{}
24 width/height & remaining part of screen \\
25 font & user defined \\
26 shade & black foreground on white background \\
27 \end{rbtabular}