From 8a1938a500d1b67451b853adff235a0b86ab38bf Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 18 Mar 2009 14:24:28 +0000 Subject: [PATCH] Add filetype colours to the manual. Also add a macro to give the file extension of the main binary. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20348 a1c6a512-1295-4272-9138-f99709370657 --- manual/advanced_topics/main.tex | 87 +++++++++++++++++++++++++++++++++++----- manual/platform/c200.tex | 1 + manual/platform/clip.tex | 1 + manual/platform/e200.tex | 1 + manual/platform/gigabeatf.tex | 1 + manual/platform/gigabeats.tex | 1 + manual/platform/h10.tex | 1 + manual/platform/h100.tex | 1 + manual/platform/h10_5gb.tex | 1 + manual/platform/h300.tex | 1 + manual/platform/ipod1g2g.tex | 1 + manual/platform/ipod3g.tex | 1 + manual/platform/ipod4g.tex | 1 + manual/platform/ipodcolor.tex | 1 + manual/platform/ipodmini.tex | 1 + manual/platform/ipodnano.tex | 1 + manual/platform/ipodvideo.tex | 1 + manual/platform/m5.tex | 1 + manual/platform/mrobe100.tex | 1 + manual/platform/ondiofm.tex | 1 + manual/platform/ondiosp.tex | 1 + manual/platform/player.tex | 1 + manual/platform/recorder.tex | 1 + manual/platform/recorderv2fm.tex | 1 + manual/platform/x5.tex | 1 + manual/plugins/text_editor.tex | 2 +- 26 files changed, 101 insertions(+), 12 deletions(-) diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex index 4cea04eb4..34a0e5ada 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: \wikilink{LangFiles} \opt{lcd_color}{ - \subsection{Changing Colours} - The colours used in the Rockbox interface can be changed to any combination - you like. To do this, go to - \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Colours}. - The colours set here are used in all menus, browsers and in the - \setting{While Playing Screen}. - \subsection{Changing Filetype Colours} - Rockbox has the capability to modify the \setting{File Browser} - to show different filetypes in different colours depending upon - the file extension. See the \wikilink{CustomFiletypeColours} Wiki - page for details. + \subsection{Changing Filetype Colours} + Rockbox has the capability to modify the \setting{File Browser} to show + different filetypes in different colours, depending on the file extension. + \subsubsection{Set-up} + There are two steps to changing the filetype colours - creating + a file with the extension \fname{.colours} and then activating it using + a config file. The \fname{.colours} files \emph{must} be stored in + the \fname{/.rockbox/themes/} directory. + The \fname{.colours} file is just a text file, and can be edited with + your text editor of choice. + + \subsubsection{Creating the .colours file} + The \fname{.colours} file consits of the file extension + (or \fname{folder}) followed by a colon and then the colour desired + as an RGB value in hexadecimal, as in the following example:\\* + \\ + \config{folder:808080}\\ + \config{mp3:00FF00}\\ + \config{ogg:00FF00}\\ + \config{txt:FF0000}\\ + \config{???:FFFFFF}\\* + + The permissible extensions are as follows:\\* + \\ + \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa, + \firmwareextension{}, % + \opt{swcodec}{mp1, }mp2, mp3% + \opt{swcodec}{, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, + wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, + spc, ape, mac, sap}% + \opt{lcd_bitmap}{\opt{swcodec}{, mpg, mpeg}}% + \opt{HAVE_REMOTE_LCD}{, rwps}% + \opt{lcd_non-mono}{, bmp}% + \opt{radio}{, fmr}% + \opt{lcd_bitmap}{, fnt, kbd}}\\* + %It'd be ideal to get these from filetypes.c + + All file extensions that are not either specifically listed in the + \fname{.colours} files or are not in the list above will be + set to the colour given by \config{???}. Extensions that + are in the above list but not in the \fname{.colours} + file will be set to the foreground colour as normal. + + \subsubsection{Activating} + To activate the filetype colours, the \fname{.colours} file needs to be + invoked from a \fname{.cfg} configuration file. The easiest way to do + this is to create a new text file containing the following single + line:\\* + \\ + \config{filetype colours: /.rockbox/themes/filename.colours}\\* + + where filename is replaced by the filename you used when creating the + \fname{.colours} file. Save this file as e.g. \fname{colours.cfg} in the + \fname{/.rockbox/themes} directory and then activate the config file + from the menu as normal + (\setting{Settings} $\rightarrow$ \setting{Theme Settings}% + $\rightarrow$ \setting{Browse Themes}). + + \subsubsection{Editing} + The built-in \setting{Text Editor} (see \reference{sec:text_editor}) + automatically understands the + \fname{.colours} file format, but an external text editor can + also be used. To edit the \fname{.colours} file using Rockbox, + select it in the \setting{File Browser}. The file will open in + the \setting{Text Editor}. Upon selecting a line, the following choices + will appear:\\* + \\ + \config{Extension}\\ + \config{Colour}\\* + + If \config{Extension} is selected, the \setting{virtual keyboard} + (see \reference{sec:virtual_keyboard}) appears, + allowing the file extension to be modified. If \config{Colour} + is selected, the colour selector screen appears. Choose the desired + colour, then save the \fname{.colours} file using the standard + \setting{Text Editor} controls. } \opt{lcd_non-mono}{% diff --git a/manual/platform/c200.tex b/manual/platform/c200.tex index 658affc56..0c7473ee1 100644 --- a/manual/platform/c200.tex +++ b/manual/platform/c200.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.mi4}} +\newcommand{\firmwareextension}{\fname{mi4}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{flash storage} diff --git a/manual/platform/clip.tex b/manual/platform/clip.tex index 0f2192c92..e342e00ca 100644 --- a/manual/platform/clip.tex +++ b/manual/platform/clip.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity... \newcommand{\daps}{player's} \newcommand{firmwarefilename}{\fname{rockbox.sansa}} +\newcommand{\firmwareextension}{\fname{sansa}} \newcommand{\screenshotsize}{3cm} \newcommand{\disk}{flash storage} diff --git a/manual/platform/e200.tex b/manual/platform/e200.tex index 038b961c3..d20d34f2d 100644 --- a/manual/platform/e200.tex +++ b/manual/platform/e200.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.mi4}} +\newcommand{\firmwareextension}{\fname{mi4}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{flash storage} diff --git a/manual/platform/gigabeatf.tex b/manual/platform/gigabeatf.tex index d78b4cd3b..bad3372e9 100644 --- a/manual/platform/gigabeatf.tex +++ b/manual/platform/gigabeatf.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.gigabeat}} +\newcommand{\firmwareextension}{\fname{gigabeat}} \newcommand{\screenshotsize}{6cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/gigabeats.tex b/manual/platform/gigabeats.tex index 414c1de3b..29e64e4ee 100644 --- a/manual/platform/gigabeats.tex +++ b/manual/platform/gigabeats.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.gigabeat}} +\newcommand{\firmwareextension}{\fname{gigabeat}} \newcommand{\screenshotsize}{6cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/h10.tex b/manual/platform/h10.tex index bd5794651..4b99b1ba5 100644 --- a/manual/platform/h10.tex +++ b/manual/platform/h10.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.mi4}} +\newcommand{\firmwareextension}{\fname{mi4}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/h100.tex b/manual/platform/h100.tex index bbb659d57..53b7ef6c8 100644 --- a/manual/platform/h100.tex +++ b/manual/platform/h100.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.iriver}} +\newcommand{\firmwareextension}{\fname{iriver}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/h10_5gb.tex b/manual/platform/h10_5gb.tex index ffe63d85e..d89e1eabc 100644 --- a/manual/platform/h10_5gb.tex +++ b/manual/platform/h10_5gb.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.mi4}} +\newcommand{\firmwareextension}{\fname{mi4}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/h300.tex b/manual/platform/h300.tex index fce8823db..211bc1a9b 100644 --- a/manual/platform/h300.tex +++ b/manual/platform/h300.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.iriver}} +\newcommand{\firmwareextension}{\fname{iriver}} \newcommand{\screenshotsize}{6cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ipod1g2g.tex b/manual/platform/ipod1g2g.tex index c5929f719..28679a502 100644 --- a/manual/platform/ipod1g2g.tex +++ b/manual/platform/ipod1g2g.tex @@ -16,6 +16,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ipod3g.tex b/manual/platform/ipod3g.tex index 5f2a7bebb..21ca69adb 100644 --- a/manual/platform/ipod3g.tex +++ b/manual/platform/ipod3g.tex @@ -16,6 +16,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ipod4g.tex b/manual/platform/ipod4g.tex index 0d7a296c4..06483fa6e 100644 --- a/manual/platform/ipod4g.tex +++ b/manual/platform/ipod4g.tex @@ -16,6 +16,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ipodcolor.tex b/manual/platform/ipodcolor.tex index b2d618fa3..04dc457a8 100644 --- a/manual/platform/ipodcolor.tex +++ b/manual/platform/ipodcolor.tex @@ -16,6 +16,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{6cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ipodmini.tex b/manual/platform/ipodmini.tex index 71df35547..7671a4fb1 100644 --- a/manual/platform/ipodmini.tex +++ b/manual/platform/ipodmini.tex @@ -16,6 +16,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ipodnano.tex b/manual/platform/ipodnano.tex index 5a4a8064c..974fe687e 100644 --- a/manual/platform/ipodnano.tex +++ b/manual/platform/ipodnano.tex @@ -15,6 +15,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{flash storage} diff --git a/manual/platform/ipodvideo.tex b/manual/platform/ipodvideo.tex index 843a3ddde..ff1855126 100644 --- a/manual/platform/ipodvideo.tex +++ b/manual/platform/ipodvideo.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.ipod}} +\newcommand{\firmwareextension}{\fname{ipod}} \newcommand{\screenshotsize}{8cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/m5.tex b/manual/platform/m5.tex index 7129d36ec..c7233b11f 100644 --- a/manual/platform/m5.tex +++ b/manual/platform/m5.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.iaudio}} +\newcommand{\firmwareextension}{\fname{iaudio}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/mrobe100.tex b/manual/platform/mrobe100.tex index d31d505e1..ddac2fda6 100644 --- a/manual/platform/mrobe100.tex +++ b/manual/platform/mrobe100.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.mi4}} +\newcommand{\firmwareextension}{\fname{mi4}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/ondiofm.tex b/manual/platform/ondiofm.tex index d0affafa8..4f6881289 100644 --- a/manual/platform/ondiofm.tex +++ b/manual/platform/ondiofm.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}} +\newcommand{\firmwareextension}{\fname{ajz}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{flash storage} diff --git a/manual/platform/ondiosp.tex b/manual/platform/ondiosp.tex index 17fe187b8..3c9e656ba 100644 --- a/manual/platform/ondiosp.tex +++ b/manual/platform/ondiosp.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}} +\newcommand{\firmwareextension}{\fname{ajz}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{flash storage} diff --git a/manual/platform/player.tex b/manual/platform/player.tex index 8222c4442..e3c04eea1 100644 --- a/manual/platform/player.tex +++ b/manual/platform/player.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{archos.mod}} +\newcommand{\firmwareextension}{\fname{mod}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/recorder.tex b/manual/platform/recorder.tex index 3d3abcfa6..da86c63aa 100644 --- a/manual/platform/recorder.tex +++ b/manual/platform/recorder.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}} +\newcommand{\firmwareextension}{\fname{ajz}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/recorderv2fm.tex b/manual/platform/recorderv2fm.tex index 936e06360..5a38b29cd 100644 --- a/manual/platform/recorderv2fm.tex +++ b/manual/platform/recorderv2fm.tex @@ -17,6 +17,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{ajbrec.ajz}} +\newcommand{\firmwareextension}{\fname{ajz}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/platform/x5.tex b/manual/platform/x5.tex index cf93d672c..df8473c60 100644 --- a/manual/platform/x5.tex +++ b/manual/platform/x5.tex @@ -18,6 +18,7 @@ %For use when referring to the player. E.g. the \daps\ capacity ... \newcommand{\daps}{player's} \newcommand{\firmwarefilename}{\fname{rockbox.iaudio}} +\newcommand{\firmwareextension}{\fname{iaudio}} \newcommand{\screenshotsize}{4cm} \newcommand{\disk}{hard disk} diff --git a/manual/plugins/text_editor.tex b/manual/plugins/text_editor.tex index aaa7f403d..04820e3fb 100644 --- a/manual/plugins/text_editor.tex +++ b/manual/plugins/text_editor.tex @@ -1,4 +1,4 @@ -\subsection{Text Editor} +\subsection{\label{sec:text_editor}Text Editor} This plugin allows you to view and edit simple text documents on your DAP. You can view files by using \setting{Open with} from the \setting{Context Menu} (see \reference{ref:Contextmenu}). -- 2.11.4.GIT