summaryrefslogtreecommitdiff
path: root/manual/advanced_topics/viewports/colour-vp-syntax.tex
diff options
context:
space:
mode:
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 @@
1\subsubsection{Viewport Declaration Syntax}
2
3{\config{\%V}}{\textbar}x{\textbar}y{\textbar}[width]{\textbar}[height]{\textbar}[font]{\textbar}[fgcolour]{\textbar}[bgcolour]{\textbar}%
4
5 \begin{itemize}
6 \item 'fgcolour' and 'bgcolour' are 6-digit RGB888 colours - e.g. FF00FF.
7 \item 'font' is a number - '0' is the built-in system font, '1' is the
8 user-selected font.
9 \item Only the coordinates \emph{have} to be specified. Leaving the other
10 definitions blank will set them to their default values.
11 \note{The correct number of {\textbar}s with hyphens in blank fields
12 are still needed in any case.}
13 \end{itemize}
14
15\begin{example}
16 %V|12|20|-|-|1|-|-|
17 %sThis viewport is displayed permanently. It starts 12px from the left and
18 %s20px from the top of the screen, and fills the rest of the screen from
19 %sthat point. The lines will scroll if this text does not fit in the viewport.
20 %sThe user font is used, as are the default foreground/background colours.
21\end{example}
22\begin{rbtabular}{.75\textwidth}{XX}{Viewport definition & Default value}{}{}
23 width/height & remaining part of screen \\
24 font & user defined \\
25 forground/background colours & defined by theme \\
26\end{rbtabular} \ No newline at end of file