summaryrefslogtreecommitdiff
path: root/manual/rockbox_interface
diff options
context:
space:
mode:
authorJonas Häggqvist <rasher@rasher.dk>2006-11-25 09:42:06 +0000
committerJonas Häggqvist <rasher@rasher.dk>2006-11-25 09:42:06 +0000
commit6b1d2cbd8279b495d391b65689fda79a10a8a146 (patch)
treebf77446a768a04a171936726a3aec15d92a46815 /manual/rockbox_interface
parent38d716660e026873dfd0dfcc1f4ce287141f296b (diff)
downloadrockbox-6b1d2cbd8279b495d391b65689fda79a10a8a146.tar.gz
rockbox-6b1d2cbd8279b495d391b65689fda79a10a8a146.zip
Tag cache renamed to the less cryptic "Database" throughout the UI and manual. No functional changes.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11588 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/rockbox_interface')
-rw-r--r--manual/rockbox_interface/main.tex6
-rw-r--r--manual/rockbox_interface/playback.tex10
-rw-r--r--manual/rockbox_interface/tagcache.tex66
3 files changed, 41 insertions, 41 deletions
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index dddcef0d9e..c64cc82ec7 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -148,8 +148,8 @@ audio files to it.
148When you have files on your \dap{} you'll see the supported ones now. Of 148When you have files on your \dap{} you'll see the supported ones now. Of
149course you can change this view later. You can also completely switch to 149course you can change this view later. You can also completely switch to
150a view that is based on the meta-data\footnote{ID3 Tags, Vorbis comments, etc.} 150a view that is based on the meta-data\footnote{ID3 Tags, Vorbis comments, etc.}
151of your audio files. This view is called Tag Cache (see 151of your audio files. This view is called Database (see
152\reference{ref:tagcache}). Now you can start browsing the folder structure of 152\reference{ref:database}). Now you can start browsing the folder structure of
153your \dap{}. 153your \dap{}.
154 154
155\subsection{Basic controls} 155\subsection{Basic controls}
@@ -223,4 +223,4 @@ garbled.}
223\fixme{include an overview of the menu structure here} 223\fixme{include an overview of the menu structure here}
224%\input{rockbox_interface/menu_structure.tex} 224%\input{rockbox_interface/menu_structure.tex}
225 225
226\input{rockbox_interface/playback.tex} \ No newline at end of file 226\input{rockbox_interface/playback.tex}
diff --git a/manual/rockbox_interface/playback.tex b/manual/rockbox_interface/playback.tex
index b4a3faa72b..ba49204ea2 100644
--- a/manual/rockbox_interface/playback.tex
+++ b/manual/rockbox_interface/playback.tex
@@ -7,20 +7,20 @@ Rockbox lets you browse your music in either of two ways. The
7your \dap, entering folders and executing the default action on each file. 7your \dap, entering folders and executing the default action on each file.
8To help differentiate files, each file format is displayed with an icon. 8To help differentiate files, each file format is displayed with an icon.
9 9
10The \setting{Tag Cache Browser}, on the other hand, allows you to navigate 10The \setting{Database Browser}, on the other hand, allows you to navigate
11through the music on your player using categories like album, artist, genre, 11through the music on your player using categories like album, artist, genre,
12etc. 12etc.
13 13
14You can select whether to browse using the \setting{File Browser} or the 14You can select whether to browse using the \setting{File Browser} or the
15\setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting. 15\setting{Database Browser} by adjusting the \setting{Show Files} setting.
16If you choose the \setting{File Browser}, the \setting{Show Files} setting also 16If you choose the \setting{File Browser}, the \setting{Show Files} setting also
17lets you select what types of files you wish to view. See 17lets you select what types of files you wish to view. See
18\reference{ref:ShowFiles} for more information on the \setting{Show Files} 18\reference{ref:ShowFiles} for more information on the \setting{Show Files}
19setting. 19setting.
20 20
21\note{The \setting{File Browser} allows you to manipulate your files in ways 21\note{The \setting{File Browser} allows you to manipulate your files in ways
22that are not available within the \setting{Tag Cache Browser}. Read more about 22that are not available within the \setting{Database Browser}. Read more about
23\setting{Tag Cache} in \reference{ref:tagcache}. The remainder of this section 23\setting{Database} in \reference{ref:database}. The remainder of this section
24deals with the \setting{File Browser}.} 24deals with the \setting{File Browser}.}
25 25
26\opt{ondio}{ 26\opt{ondio}{
@@ -307,4 +307,4 @@ This is the virtual keyboard that is used when entering file names in Rockbox.
307\input{rockbox_interface/wps.tex} 307\input{rockbox_interface/wps.tex}
308 308
309%Include playlist section 309%Include playlist section
310\input{working_with_playlists/main.tex} \ No newline at end of file 310\input{working_with_playlists/main.tex}
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex
index 08c5ef2f67..fc68f9d85e 100644
--- a/manual/rockbox_interface/tagcache.tex
+++ b/manual/rockbox_interface/tagcache.tex
@@ -1,38 +1,38 @@
1% $Id$ % 1% $Id$ %
2\section{\label{ref:tagcache}Tag Cache} 2\section{\label{ref:database}Database}
3 3
4\subsection{Introduction} 4\subsection{Introduction}
5Tag Cache is the Rockbox music database system. Using the information 5This chapter describes the Rockbox music database system. Using the information
6contained in the tags (ID3v1, ID3v2% 6contained in the tags (ID3v1, ID3v2%
7 \opt{SWCODEC}{, Vorbis Comments, Apev2, etc.}% 7 \opt{SWCODEC}{, Vorbis Comments, Apev2, etc.}%
8) in your audio files, Rockbox builds and maintains a database of the music 8) in your audio files, Rockbox builds and maintains a database of the music
9files on your player and allows you to browse them by Artist, Album and Genre. 9files on your player and allows you to browse them by Artist, Album and Genre.
10 10
11\subsection{Initialising the Tag Cache} 11\subsection{Initialising the database}
12Before you use the Tag Cache for the first time, you must initialise it by using 12Before you use the database for the first time, you must initialise it by using
13the \setting{Initialize Now} function in the \setting{Tag Cache Menu} 13the \setting{Initialize Now} function in the \setting{Database Menu}
14(\setting{General Settings $\rightarrow$ File View $\rightarrow$ Tag Cache}) 14(\setting{General Settings $\rightarrow$ File View $\rightarrow$ Database})
15, which is described in the following section. 15, which is described in the following section.
16 16
17\subsection{\label{ref:tagcachemenu}The Tag Cache Menu} 17\subsection{\label{ref:databasemenu}The Database Menu}
18 18
19\begin{description} 19\begin{description}
20 \opt{SWCODEC}{ 20 \opt{SWCODEC}{
21 \item[Load To Ram.] 21 \item[Load To Ram.]
22 The Tag Cache database can either be kept on disk (to save memory), or 22 The database can either be kept on disk (to save memory), or
23 loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads 23 loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads
24 the Tag Cache to RAM, allowing faster browsing and searching. Setting this 24 the database to RAM, allowing faster browsing and searching. Setting this
25 option to \setting{No} keeps the Tag Cache on the disk, meaning slower 25 option to \setting{No} keeps the database on the disk, meaning slower
26 browsing but it does not use extra RAM and saves some battery on boot up. 26 browsing but it does not use extra RAM and saves some battery on boot up.
27 27
28 \note{If you browse your music frequently using Tag Cache, you should load 28 \note{If you browse your music frequently using the database, you should
29 to RAM, as this will reduce the overall battery consumption because the 29 load to RAM, as this will reduce the overall battery consumption because
30 disk will not need to spin on each search.} 30 the disk will not need to spin on each search.}
31 } 31 }
32 32
33\item[Auto Update.] 33\item[Auto Update.]
34 If \setting{Auto update} is set to \setting{on}, each time the \dap{} 34 If \setting{Auto update} is set to \setting{on}, each time the \dap{}
35 boots, Tag Cache will automatically update the database. 35 boots, the database will automatically be updated.
36 \opt{SWCODEC}{ 36 \opt{SWCODEC}{
37 \note{The \setting{Auto Update} will only check for deleted files if the 37 \note{The \setting{Auto Update} will only check for deleted files if the
38 \setting{Directory Cache} (\setting{General Settings $\rightarrow$ 38 \setting{Directory Cache} (\setting{General Settings $\rightarrow$
@@ -44,22 +44,22 @@ the \setting{Initialize Now} function in the \setting{Tag Cache Menu}
44 deleted files from the database you need to run \setting{Update Now}.}% 44 deleted files from the database you need to run \setting{Update Now}.}%
45 45
46\item[Initialize Now.] 46\item[Initialize Now.]
47 Before you use the Tag Cache for the first time, you must Initialize it by 47 Before you use the database for the first time, you must Initialize it by
48 using the \setting{Initialize Now} function in the \setting{Tag Cache 48 using the \setting{Initialize Now} function in the \setting{Database
49 Menu}. 49 Menu}.
50 \warn{\setting{Initialize Now} removes all database files (removing 50 \warn{\setting{Initialize Now} removes all database files (removing
51 runtimedb data also) and rebuilds the database from scratch.} 51 runtimedb data also) and rebuilds the database from scratch.}
52 This can take quite a while depending on the number of music files on your 52 This can take quite a while depending on the number of music files on your
53 \dap{}, and may require a restart to allow the files to be committed to the 53 \dap{}, and may require a restart to allow the files to be committed to the
54 cache. 54 database.
55 55
56 The Tag Cache initialisation happens in the background, so you can continue 56 The database initialisation happens in the background, so you can continue
57 to listen to music while the Tag Cache is being initialised. If you shut 57 to listen to music while the database is being initialised. If you shut
58 down your player during initialisation, the database building process will 58 down your player during initialisation, the database building process will
59 continue next time you turn it on. 59 continue next time you turn it on.
60 60
61\item[Update Now.] 61\item[Update Now.]
62 \setting{Update now} causes Tag Cache to detect new and deleted files 62 \setting{Update now} causes the database to detect new and deleted files
63 \opt{SWCODEC}{ 63 \opt{SWCODEC}{
64 \note{Unlike the \setting{Auto Update} function, \setting{Update Now} 64 \note{Unlike the \setting{Auto Update} function, \setting{Update Now}
65 will update the database regardless of whether the \setting{Directory Cache} 65 will update the database regardless of whether the \setting{Directory Cache}
@@ -76,31 +76,31 @@ the \setting{Initialize Now} function in the \setting{Tag Cache Menu}
76 76
77\item[Export modifications.] 77\item[Export modifications.]
78 This allows for the runtime data to be exported into \\ 78 This allows for the runtime data to be exported into \\
79 \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in 79 \fname{/.rockbox/database\_changelog.txt}, which backs up the runtime data in
80 ASCII format. This is needed when Tag Cache structures change, because new 80 ASCII format. This is needed when database structures change, because new
81 code cannot read old Tag Cache database code. But, all modifications 81 code cannot read old database code. But, all modifications
82 exported to ASCII format should be readable by all Tag Cache versions. 82 exported to ASCII format should be readable by all database versions.
83 83
84\item[Import modifications.] 84\item[Import modifications.]
85 Allows the \fname{/.rockbox/tagcache\_changelog.txt} backup to be 85 Allows the \fname{/.rockbox/database\_changelog.txt} backup to be
86 conveniently loaded into the Tag Cache. This is performed automatically when 86 conveniently loaded into the database. This is performed automatically when
87 the Tag Cache is initialised. 87 the database is initialised.
88 88
89\end{description} 89\end{description}
90 90
91\subsection{Using the Tag Cache} 91\subsection{Using the database}
92Once the Tag Cache has been initialised, you can browse your music by Artist, 92Once the database has been initialised, you can browse your music by Artist,
93Album, Genre and Song Name. To use the Tag Cache, change the 93Album, Genre and Song Name. To use the database, change the
94\setting{Show Files} show mode by changing the \setting{General Settings 94\setting{Show Files} show mode by changing the \setting{General Settings
95$\rightarrow$ File View $\rightarrow$ Show files} option to 95$\rightarrow$ File View $\rightarrow$ Show files} option to
96\setting{ID3 database}. This disables the \setting{File Browser} and instead 96\setting{Database}. This disables the \setting{File Browser} and instead
97allows you to view files using the information in the Tag Cache database.\\ 97allows you to view files using the information in the database.\\
98 98
99\note{You may need to increase the value of the \setting{Max files in dir 99\note{You may need to increase the value of the \setting{Max files in dir
100browser} setting (\setting{General Settings $\rightarrow$ System $\rightarrow$ 100browser} setting (\setting{General Settings $\rightarrow$ System $\rightarrow$
101Limits}) in order to view long lists of tracks in the ID3 database browser.\\ 101Limits}) in order to view long lists of tracks in the ID3 database browser.\\
102 102
103There is no option to turn off Tag Cache completely. If you do not want 103There is no option to turn off database completely. If you do not want
104to use it just don't do the initial build of the database and do not load it 104to use it just don't do the initial build of the database and do not load it
105to RAM.} 105to RAM.}
106% 106%