summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorSolomon Peachy <pizza@shaftnet.org>2020-07-19 19:38:45 -0400
committerSolomon Peachy <pizza@shaftnet.org>2020-07-24 21:20:13 +0000
commit0c4f89370d05056faa789aa9cabcccc4e509fb9f (patch)
tree6ddf7fff0a47564db41d39927ea1acbdb03e74ee /manual
parent092c340a2062fa98b7387fc5fd63578ddae7d0b6 (diff)
downloadrockbox-0c4f89370d05056faa789aa9cabcccc4e509fb9f.tar.gz
rockbox-0c4f89370d05056faa789aa9cabcccc4e509fb9f.tar.bz2
rockbox-0c4f89370d05056faa789aa9cabcccc4e509fb9f.zip
[2/4] get rid of HAVE_LCD_CHARCELLS
HAVE_LCD_BITMAP is now redundant. lcd_bitmap is always-on in features.txt so manual and lang strings don't have to change Change-Id: I08eeb20de48099ffc2dc23782711af368c2ec794
Diffstat (limited to 'manual')
-rwxr-xr-xmanual/advanced_topics/main.tex54
-rw-r--r--manual/appendix/wps_tags.tex91
-rw-r--r--manual/plugins/text_viewer.tex2
3 files changed, 69 insertions, 78 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 786c109772..00b1688e11 100755
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -168,32 +168,30 @@ file find the instructions on the Rockbox website:
the \fname{/.rockbox/backdrops} directory.
}%
-\nopt{lcd_charcell}{
- \subsection{UI Viewport}
- By default, the UI is drawn on the whole screen. This can be changed so that
- the UI is confined to a specific area of the screen, by use of a UI
- viewport. This is done by adding the following line to the
- \fname{.cfg} file for a theme:\\*
-
- \nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}}
+\subsection{UI Viewport}
+By default, the UI is drawn on the whole screen. This can be changed so that
+the UI is confined to a specific area of the screen, by use of a UI
+viewport. This is done by adding the following line to the
+\fname{.cfg} file for a theme:\\*
+
+\nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}}
+\nopt{lcd_color}{\opt{lcd_non-mono}{
+ \config{ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
+\opt{lcd_color}{
+ \config{ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
+\\*
+
+\opt{HAVE_REMOTE_LCD}{
+ The dimensions of the menu that is displayed on the remote control of your
+ \dap\ can be set in the same way. The line to be added to the theme
+ \fname{.cfg} is the following:\\*
+
+ \nopt{lcd_non-mono}{\config{remote ui viewport: X,Y,[width],[height],[font]}}
\nopt{lcd_color}{\opt{lcd_non-mono}{
- \config{ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
+ \config{remote ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
\opt{lcd_color}{
- \config{ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
- \\*
-
- \opt{HAVE_REMOTE_LCD}{
- The dimensions of the menu that is displayed on the remote control of your
- \dap\ can be set in the same way. The line to be added to the theme
- \fname{.cfg} is the following:\\*
-
- \nopt{lcd_non-mono}{\config{remote ui viewport: X,Y,[width],[height],[font]}}
- \nopt{lcd_color}{\opt{lcd_non-mono}{
- \config{remote ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}}
- \opt{lcd_color}{
- \config{remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
- \\*
- }
+ \config{remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}}
+\\*
Only the first two parameters \emph{have} to be specified, the others can
be omitted using `$-$' as a placeholder. The syntax is very similar to WPS
@@ -202,7 +200,6 @@ file find the instructions on the Rockbox website:
\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-uivp-syntax.tex}}
\nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-uivp-syntax.tex}}}
\opt{lcd_color}{\input{advanced_topics/viewports/colour-uivp-syntax.tex}}
-}
\section{\label{ref:ConfiguringtheWPS}Configuring the Theme}
@@ -265,7 +262,6 @@ are discussed below.
}
}
-\nopt{lcd_charcell}{
\subsubsection{\label{ref:Viewports}Viewports}
By default, a viewport filling the whole screen contains all the elements
@@ -279,7 +275,7 @@ be defined. A viewport is a rectangular window on the screen%
\opt{lcd_non-mono}{ with its own foreground/background
\opt{lcd_color}{colours}\nopt{lcd_color}{shades}}.
This window also has variable dimensions. To
-define a viewport a line starting \config{{\%V(\dots}} has to be
+define a viewport a line starting \config{{\%V(\dots)}} has to be
present in the theme file. The full syntax will be explained later in
this section. All elements placed before the
line defining a viewport are displayed in the default viewport. Elements
@@ -293,6 +289,7 @@ cannot be layered \emph{transparently} over one another. Subsequent viewports
will be drawn over any other viewports already drawn onto that
area of the screen.
+
\nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-vp-syntax.tex}}
\nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}}
\opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}}
@@ -318,11 +315,10 @@ Mode can be the following:
the end colour\\}
\end{rbtabular}
}
-
\subsubsection{Conditional Viewports}
Any viewport can be displayed either permanently or conditionally.
-Defining a viewport as \config{{\%V(\dots}}
+Defining a viewport as \config{{\%V(\dots)}}
will display it permanently.
\begin{itemize}
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 1aec7bae99..1a0661c008 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -53,61 +53,58 @@ conditionals to show alternate information in preference to assuming.
These tags, when written with a capital ``I'' (e.g. \config{\%Ia} or \config{\%Ic}),
show the information for the next song to be played.
-\nopt{lcd_charcell}{
- \section{Viewports}
- \begin{tagmap}
- \nopt{lcd_non-mono}{%
- \config{\%V(x,y,[width],\tabnlindent[height],[font])}
- & See section \ref{ref:Viewports}\\}
-
- \nopt{lcd_color}{\opt{lcd_non-mono}{%
- \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
- \config{\%Vf([fgshade])}\newline
- \config{\%Vb([bgshade])}
- & See section \ref{ref:Viewports}\\}}
-
- \opt{lcd_color}{%
- \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
- \config{\%Vf([fgcolour])}\newline
- \config{\%Vb([bgcolour])}\newline
- \config{\%Vg(start,end \tabnlindent[,text])}
- & See section \ref{ref:Viewports}\\}
-
- \opt{lcd_non-mono}{%
- \config{\%Vs(mode[,param])}
- & See section \ref{ref:Viewports}\\}
-
- \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later
+\section{Viewports}
+ \begin{tagmap}
+ \nopt{lcd_non-mono}{%
+ \config{\%V(x,y,[width],\tabnlindent[height],[font])}
+ & See section \ref{ref:Viewports}\\}
+
+ \nopt{lcd_color}{\opt{lcd_non-mono}{%
+ \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
+ \config{\%Vf([fgshade])}\newline
+ \config{\%Vb([bgshade])}
+ & See section \ref{ref:Viewports}\\}}
+
+ \opt{lcd_color}{%
+ \config{\%V(x,y,[width],\tabnlindent[height],[font])}\newline
+ \config{\%Vf([fgcolour])}\newline
+ \config{\%Vb([bgcolour])}\newline
+ \config{\%Vg(start,end \tabnlindent[,text])}
+ & See section \ref{ref:Viewports}\\}
+
+ \opt{lcd_non-mono}{%
+ \config{\%Vs(mode[,param])}
+ & See section \ref{ref:Viewports}\\}
+ \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later
display. `identifier' is a single lowercase letter (a-z) and the `\dots'
parameters use the same logic as the \%V tag explained above.\\
- \config{\%Vd('identifier')} & Display the `identifier' viewport. E.g.
- \config{\%?C<\%Vd(a)|\%Vd(b)>}
- will show viewport `a' if album art is found, and `b' if it isn't.\\
+ \config{\%Vd('identifier')} & Display the `identifier' viewport. E.g.
+ \config{\%?C<\%Vd(a)|\%Vd(b)>}
+ will show viewport `a' if album art is found, and `b' if it isn't.\\
- \config{\%Vi('label',\dots)} &
- Declare a Custom UI Viewport. The `\dots' parameters use the same logic as
- the \config{\%V} tag explained above. See section \ref{ref:Viewports}.\\
+ \config{\%Vi('label',\dots)} &
+ Declare a Custom UI Viewport. The `\dots' parameters use the same logic as
+ the \config{\%V} tag explained above. See section \ref{ref:Viewports}.\\
- \config{\%VI('label')} & Set the Info Viewport to use the viewport called
- label, as declared with the previous tag.\\
+ \config{\%VI('label')} & Set the Info Viewport to use the viewport called
+ label, as declared with the previous tag.\\
- \config{\%VB} & Draw this viewport on the backdrop layer.\\
- \end{tagmap}
+ \config{\%VB} & Draw this viewport on the backdrop layer.\\
+ \end{tagmap}
- \section{Additional Fonts}
- \begin{tagmap}
- \config{\%Fl('id',filename)} & See section \ref{ref:multifont}.\\
- \end{tagmap}
+\section{Additional Fonts}
+ \begin{tagmap}
+ \config{\%Fl('id',filename)} & See section \ref{ref:multifont}.\\
+ \end{tagmap}
- \section{Misc Coloring Tags}
- \begin{tagmap}
- \config{\%dr(x,y,width,height,[color1,color2])} & Color a rectangle. \\
- \end{tagmap}
- width and height can be ``$-$'' to fill the viewport. If no color is
- specified the viewports foreground color will be used. If two
- colors are specified it will do a gradient fill.
-}
+\section{Misc Coloring Tags}
+ \begin{tagmap}
+ \config{\%dr(x,y,width,height,[color1,color2])} & Color a rectangle. \\
+ \end{tagmap}
+ width and height can be ``$-$'' to fill the viewport. If no color is
+ specified the viewports foreground color will be used. If two
+ colors are specified it will do a gradient fill.
\section{Power Related Information}
\begin{tagmap}
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex
index 60b38e7a7e..fe369d1c90 100644
--- a/manual/plugins/text_viewer.tex
+++ b/manual/plugins/text_viewer.tex
@@ -196,8 +196,6 @@ by using \emph{Open with} from the \emph{Context Menu}
\item[Viewer Options] Change settings for the current file.
\begin{description}
\item[Encoding] Set the codepage in the text viewer.
-% ToDo: wrap some of the following settings into a \opt{lcd_bitmap} to exlude
-% ones that don't work on charcell - as soon as the plugin itself does
Available settings:
\setting{ISO-8859-1} (Latin 1).
\setting{ISO-8859-7} (Greek),