Add the Lua scripting language plugin to the manual.
[kugel-rb/myfork.git] / manual / configure_rockbox / theme_settings.tex
blob0273fe02ea697a6c2ddaaba58b3406efebb7be81
1 % $Id $ %
2 The \setting{Theme Settings} menu offers options that you can change to
3 customize the visual apperance of Rockbox.
5 \begin{description}
6 \item[Browse Themes.]
7 This option will display all the currently installed themes on the \dap{},
8 press \ActionTreeEnter{} to load the chosen theme and apply it.
10 A theme is a configuration file, stored in a specific directory,
11 that typically changes the WPS
12 \opt{HAVE_REMOTE_LCD}{and remote WPS}, font used and on some platforms
13 additional information such as background image and text colours.
15 There are a number of themes that ship with Rockbox. If none of
16 these suit your needs, many more can be downloaded from
17 \opt{RECORDER_PAD}{\wikilink{WpsArchos}}%
18 \opt{h100}{\wikilink{WpsIriverH100}}%
19 \opt{h300,ipodcolor}{\wikilink{WpsIriverH300}}%
20 \opt{ipodvideo}{\wikilink{WpsIpod5g}}%
21 \opt{ipodnano}{\wikilink{WpsIpodNano}}%
22 \opt{ipodmini}{\wikilink{WpsIpodMini}}%
23 \opt{x5}{\wikilink{WpsIaudioX5}}%
25 Some of the downloads from this website will actually be standalone WPS files,
26 others will be full-blown themes.
28 \note{Themes do not have to be purely visual. It is quite possible to create
29 a theme that switches between audio configurations for use in the car, with
30 headphones and when connected to an external amplifier. See
31 \reference{ref:CreateYourOwnWPS} for more details.}
33 \opt{lcd_bitmap}{
34 \item[Browse Fonts.]
35 Browse the installed fonts on your \dap{}. Selecting one will activate it.
36 See \reference{ref:Loadingfonts} for further details about fonts.
37 } % \nopt{player}
39 \item[Browse WPS files.]
40 Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
41 displays all \fname{.wps} files. Selecting one will activate it, stop will
42 exit back to the menu. For further information about the WPS see
43 \reference{ref:WPS}. For information about editing a .wps file see
44 \reference{ref:ConfiguringtheWPS}.
46 \opt{HAVE_REMOTE_LCD}{
47 \item[Browse RWPS files.]
48 Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
49 displays all \fname{.rwps} files. Selecting one will activate it, stop will
50 exit back to the menu.
51 \note{
52 A \fname{.rwps} file is a special \fname{.wps} file for the remote
53 display.
57 \item[Show Icons.]
58 Rockbox has the ability to display an icon to the left of the file
59 in the \setting{File Browser}. For details of these icons, see
60 \reference{ref:Supportedfileformats}.
61 \opt{lcd_bitmap}{
62 These icons can also be customised. See the \wikilink{IconSets}
63 and \wikilink{CustomIcons} Wiki pages for details.
66 \opt{lcd_non-mono}{%
67 \item[Clear Backdrop:]
68 Rockbox allows you to select bitmap pictures to use as backdrops,
69 see \reference{ref:LoadingBackdrops} for further information.
70 This option allows you to clear the backdrops that you set.
73 \opt{lcd_bitmap}{
74 \item[Line Selector Type.]
75 This option allows you to select which type of line selector to use.
76 \begin{description}
77 \item[Pointer:]
78 A small arrow to the left of the menu text.
79 \item[Bar (inverse):]
80 A bar with inverted foreground and background colour.
81 \opt{lcd_color}{
82 \item[Bar (Solid Colour):]
83 A bar with a solid colour, the colour is set in the \setting{Colours}
84 submenu.
85 \item[Bar (Gradient Colour):]
86 A bar with a colour gradient, the colours are set in the \setting{Colours}
87 submenu.
89 \end{description}
92 \opt{lcd_color}{
93 \item[Colours.]
94 The options in this menu sets the colours for visual elements in Rockbox.
95 \begin{description}
96 \item[Line Selector Colours.]
97 These options sets the colours for the line selector bars.
98 \begin{description}
99 \item[Primary Colour:]
100 Set the primary colour used for the gradient line selector bar and the
101 colour used for the solid color line selector bar.
102 \item[Secondary Colour:]
103 Set the secondary colour used for the gradient line selector bar.
104 \item[Text Colour:]
105 Set the colour of the selected text when using the solid colour or the
106 gradient colour line selection bars.
107 \end{description}
109 \item[Background Colour:]
110 Sets the background colour for the display.
111 \item[Foreground Colour:]
112 Sets the colour used for text and icons.
113 \item[Reset Colours:]
114 Resets the LCD display to Rockbox's default colours.
115 \end{description}
116 }% lcd_color
117 \end{description}