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