diff options
Diffstat (limited to 'manual/advanced_topics/viewports')
9 files changed, 158 insertions, 0 deletions
diff --git a/manual/advanced_topics/viewports/colour-conditional.tex b/manual/advanced_topics/viewports/colour-conditional.tex new file mode 100644 index 0000000000..bcef715263 --- /dev/null +++ b/manual/advanced_topics/viewports/colour-conditional.tex | |||
@@ -0,0 +1,15 @@ | |||
1 | \begin{example} | ||
2 | %?C<%Vda|%Vdb> | ||
3 | %Vl|a|10|10|50|50|-|-|-| | ||
4 | %Cl|0|0|50|50| | ||
5 | %C | ||
6 | %Vl|a|0|70|70|14|1|-|-| | ||
7 | %s%acThere you have it: Album art. | ||
8 | %Vl|b|20|14|50|14|1|ff0000|ffffff| | ||
9 | %t1%acWarning:;%t.1 | ||
10 | %Vl|b|20|30|50|50|1|000000|ffffff| | ||
11 | %sNo album art found | ||
12 | %scheck your filenames. | ||
13 | \end{example} | ||
14 | This example checks for album art. Album art will be displayed in viewport 'a', if | ||
15 | it is found. Otherwise a red flashing warning will be displayed in viewport 'b'. | ||
diff --git a/manual/advanced_topics/viewports/colour-uivp-syntax.tex b/manual/advanced_topics/viewports/colour-uivp-syntax.tex new file mode 100644 index 0000000000..e681f45fc8 --- /dev/null +++ b/manual/advanced_topics/viewports/colour-uivp-syntax.tex | |||
@@ -0,0 +1,13 @@ | |||
1 | \begin{itemize} | ||
2 | \item 'fgcolour' and 'bgcolour' are 6-digit RGB888 colours - e.g. FF00FF. | ||
3 | \item 'font' is a number - '0' is the built-in system font, '1' is the | ||
4 | user-selected font. | ||
5 | \end{itemize} | ||
6 | |||
7 | \begin{example} | ||
8 | \config{ui viewport: 15,20,100,150,-,-,-} | ||
9 | \end{example} | ||
10 | This displays the menu starting at 15px from the left of the screen and 20px | ||
11 | from the top of the screen. It is 100px wide and 150px high. | ||
12 | The font and the foreground/background colours are defined in the theme | ||
13 | \fname{.cfg} file or in the \setting{Theme Settings} menu. | ||
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 | ||
diff --git a/manual/advanced_topics/viewports/grayscale-conditional.tex b/manual/advanced_topics/viewports/grayscale-conditional.tex new file mode 100644 index 0000000000..390a043f49 --- /dev/null +++ b/manual/advanced_topics/viewports/grayscale-conditional.tex | |||
@@ -0,0 +1,15 @@ | |||
1 | \begin{example} | ||
2 | %?C<%Vda|%Vdb> | ||
3 | %Vl|a|10|10|50|50|-|-|-| | ||
4 | %Cl|0|0|50|50| | ||
5 | %C | ||
6 | %Vl|a|0|70|70|14|1|-|-| | ||
7 | %s%acThere you have it: Album art. | ||
8 | %Vl|b|20|14|50|14|1|2|-| | ||
9 | %t1%acWarning:;%t.1 | ||
10 | %Vl|b|20|30|50|50|1|-|-| | ||
11 | %sNo album art found | ||
12 | %scheck your filenames. | ||
13 | \end{example} | ||
14 | This example checks for album art. Album art will be displayed in viewport 'a', if | ||
15 | it is found. Otherwise a flashing warning will be displayed in viewport 'b'. | ||
diff --git a/manual/advanced_topics/viewports/grayscale-uivp-syntax.tex b/manual/advanced_topics/viewports/grayscale-uivp-syntax.tex new file mode 100644 index 0000000000..3b420ce7d5 --- /dev/null +++ b/manual/advanced_topics/viewports/grayscale-uivp-syntax.tex | |||
@@ -0,0 +1,14 @@ | |||
1 | \begin{itemize} | ||
2 | \item 'fgshade' and bgshade are numbers in the range '0' (= black) to '3' | ||
3 | (= white). | ||
4 | \item 'font' is a number - '0' is the built-in system font, '1' is the | ||
5 | user-selected font. | ||
6 | \end{itemize} | ||
7 | |||
8 | \begin{example} | ||
9 | \config{ui viewport: 15,20,100,150,-,-,-} | ||
10 | \end{example} | ||
11 | his displays the menu starting at 15px from the left of the screen and 20px | ||
12 | from the top of the screen. It is 100px wide and 150px high. | ||
13 | The font and the foreground/background shades are defined in the theme | ||
14 | \fname{.cfg} file or in the \setting{Theme Settings} menu. | ||
diff --git a/manual/advanced_topics/viewports/grayscale-vp-syntax.tex b/manual/advanced_topics/viewports/grayscale-vp-syntax.tex new file mode 100644 index 0000000000..9f15b514b2 --- /dev/null +++ b/manual/advanced_topics/viewports/grayscale-vp-syntax.tex | |||
@@ -0,0 +1,27 @@ | |||
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 | 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 with hyphens in blank fields | ||
13 | are still needed in any case.} | ||
14 | \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} | ||
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} | ||
diff --git a/manual/advanced_topics/viewports/mono-conditional.tex b/manual/advanced_topics/viewports/mono-conditional.tex new file mode 100644 index 0000000000..fef1488ba7 --- /dev/null +++ b/manual/advanced_topics/viewports/mono-conditional.tex | |||
@@ -0,0 +1,13 @@ | |||
1 | \begin{example} | ||
2 | %?mh<%Vda|%Vdb> | ||
3 | %Vl|a|10|10|50|50|-| | ||
4 | %sYou could now show a hold icon using the %%xl and %%xd tags. | ||
5 | %Vl|a|0|70|70|14|1| | ||
6 | %s%acYour DAP is locked. | ||
7 | %Vl|b|20|14|50|14|1| | ||
8 | %t1%acWarning:;%t.1 | ||
9 | %Vl|b|20|30|50|50|0| | ||
10 | %sYou've unlocked your player. | ||
11 | \end{example} | ||
12 | This example checks for hold. Viewport 'a' will be displayed if it is on, | ||
13 | otherwise viewport 'b' will display a flashing warning. | ||
diff --git a/manual/advanced_topics/viewports/mono-uivp-syntax.tex b/manual/advanced_topics/viewports/mono-uivp-syntax.tex new file mode 100644 index 0000000000..bdf0a28eaa --- /dev/null +++ b/manual/advanced_topics/viewports/mono-uivp-syntax.tex | |||
@@ -0,0 +1,11 @@ | |||
1 | \begin{itemize} | ||
2 | \item 'font' is a number - '0' is the built-in system font, '1' is the | ||
3 | user-selected font. | ||
4 | \end{itemize} | ||
5 | |||
6 | \begin{example} | ||
7 | \config{ui viewport: 15,20,100,150,-} | ||
8 | \end{example} | ||
9 | This displays the menu starting at 15px from the left of the screen and 20px | ||
10 | from the top of the screen. It is 100px wide and 150px high. The font is | ||
11 | defined in the theme \fname{.cfg} file or in the \setting{Theme Settings} menu. | ||
diff --git a/manual/advanced_topics/viewports/mono-vp-syntax.tex b/manual/advanced_topics/viewports/mono-vp-syntax.tex new file mode 100644 index 0000000000..3126d81a10 --- /dev/null +++ b/manual/advanced_topics/viewports/mono-vp-syntax.tex | |||
@@ -0,0 +1,24 @@ | |||
1 | \subsubsection{Viewport Declaration Syntax} | ||
2 | |||
3 | {\config{\%V}}{\textbar}x{\textbar}y{\textbar}[width]{\textbar}[height]{\textbar}[font]{\textbar}% | ||
4 | |||
5 | \begin{itemize} | ||
6 | \item 'font' is a number - '0' is the built-in system font, '1' is the | ||
7 | user-selected font. | ||
8 | \item Only the coordinates \emph{have} to be specified. Leaving the other | ||
9 | definitions blank will set them to their default values. | ||
10 | \note{The correct number of {\textbar}s with hyphens in blank fields | ||
11 | are still needed in any case.} | ||
12 | \end{itemize} | ||
13 | |||
14 | \begin{example} | ||
15 | %V|12|20|-|-|1| | ||
16 | %sThis viewport is displayed permanently. It starts 12px from the left and | ||
17 | %s20px from the top of the screen, and fills the rest of the screen from | ||
18 | %sthat point. The lines will scroll if this text does not fit in the viewport. | ||
19 | %sThe user font is used. | ||
20 | \end{example} | ||
21 | \begin{rbtabular}{.75\textwidth}{XX}{Viewport definition & Default value}{}{} | ||
22 | width/height & remaining part of screen \\ | ||
23 | font & user defined \\ | ||
24 | \end{rbtabular} | ||