summaryrefslogtreecommitdiff
path: root/manual/advanced_topics/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/advanced_topics/main.tex')
-rw-r--r--manual/advanced_topics/main.tex87
1 files changed, 76 insertions, 11 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 4cea04eb46..34a0e5ada1 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -39,17 +39,82 @@ file find the instructions on the Rockbox website:
39\wikilink{LangFiles} 39\wikilink{LangFiles}
40 40
41\opt{lcd_color}{ 41\opt{lcd_color}{
42 \subsection{Changing Colours} 42 \subsection{Changing Filetype Colours}
43 The colours used in the Rockbox interface can be changed to any combination 43 Rockbox has the capability to modify the \setting{File Browser} to show
44 you like. To do this, go to 44 different filetypes in different colours, depending on the file extension.
45 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Colours}. 45 \subsubsection{Set-up}
46 The colours set here are used in all menus, browsers and in the 46 There are two steps to changing the filetype colours - creating
47 \setting{While Playing Screen}. 47 a file with the extension \fname{.colours} and then activating it using
48 \subsection{Changing Filetype Colours} 48 a config file. The \fname{.colours} files \emph{must} be stored in
49 Rockbox has the capability to modify the \setting{File Browser} 49 the \fname{/.rockbox/themes/} directory.
50 to show different filetypes in different colours depending upon 50 The \fname{.colours} file is just a text file, and can be edited with
51 the file extension. See the \wikilink{CustomFiletypeColours} Wiki 51 your text editor of choice.
52 page for details. 52
53 \subsubsection{Creating the .colours file}
54 The \fname{.colours} file consits of the file extension
55 (or \fname{folder}) followed by a colon and then the colour desired
56 as an RGB value in hexadecimal, as in the following example:\\*
57 \\
58 \config{folder:808080}\\
59 \config{mp3:00FF00}\\
60 \config{ogg:00FF00}\\
61 \config{txt:FF0000}\\
62 \config{???:FFFFFF}\\*
63
64 The permissible extensions are as follows:\\*
65 \\
66 \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa,
67 \firmwareextension{}, %
68 \opt{swcodec}{mp1, }mp2, mp3%
69 \opt{swcodec}{, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc,
70 wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe,
71 spc, ape, mac, sap}%
72 \opt{lcd_bitmap}{\opt{swcodec}{, mpg, mpeg}}%
73 \opt{HAVE_REMOTE_LCD}{, rwps}%
74 \opt{lcd_non-mono}{, bmp}%
75 \opt{radio}{, fmr}%
76 \opt{lcd_bitmap}{, fnt, kbd}}\\*
77 %It'd be ideal to get these from filetypes.c
78
79 All file extensions that are not either specifically listed in the
80 \fname{.colours} files or are not in the list above will be
81 set to the colour given by \config{???}. Extensions that
82 are in the above list but not in the \fname{.colours}
83 file will be set to the foreground colour as normal.
84
85 \subsubsection{Activating}
86 To activate the filetype colours, the \fname{.colours} file needs to be
87 invoked from a \fname{.cfg} configuration file. The easiest way to do
88 this is to create a new text file containing the following single
89 line:\\*
90 \\
91 \config{filetype colours: /.rockbox/themes/filename.colours}\\*
92
93 where filename is replaced by the filename you used when creating the
94 \fname{.colours} file. Save this file as e.g. \fname{colours.cfg} in the
95 \fname{/.rockbox/themes} directory and then activate the config file
96 from the menu as normal
97 (\setting{Settings} $\rightarrow$ \setting{Theme Settings}%
98 $\rightarrow$ \setting{Browse Themes}).
99
100 \subsubsection{Editing}
101 The built-in \setting{Text Editor} (see \reference{sec:text_editor})
102 automatically understands the
103 \fname{.colours} file format, but an external text editor can
104 also be used. To edit the \fname{.colours} file using Rockbox,
105 select it in the \setting{File Browser}. The file will open in
106 the \setting{Text Editor}. Upon selecting a line, the following choices
107 will appear:\\*
108 \\
109 \config{Extension}\\
110 \config{Colour}\\*
111
112 If \config{Extension} is selected, the \setting{virtual keyboard}
113 (see \reference{sec:virtual_keyboard}) appears,
114 allowing the file extension to be modified. If \config{Colour}
115 is selected, the colour selector screen appears. Choose the desired
116 colour, then save the \fname{.colours} file using the standard
117 \setting{Text Editor} controls.
53} 118}
54 119
55\opt{lcd_non-mono}{% 120\opt{lcd_non-mono}{%