summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Levin <al.le@rockbox.org>2011-11-15 22:38:55 +0000
committerAlexander Levin <al.le@rockbox.org>2011-11-15 22:38:55 +0000
commit3607d88aa0371b047464b98690fead9c9b88b1e3 (patch)
tree2441f4ee4968ed902a20b5b0249af333d645878b
parent3ba0e05ab5b731e09478ed089ff954ad3580be63 (diff)
downloadrockbox-3607d88aa0371b047464b98690fead9c9b88b1e3.tar.gz
rockbox-3607d88aa0371b047464b98690fead9c9b88b1e3.zip
Manual: Some minor fixes to the shortcuts section
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30993 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/main_menu/main.tex22
1 files changed, 11 insertions, 11 deletions
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index 3d5a2be69f..223ef2bd8d 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -269,17 +269,17 @@ pages of information.}
269\section{\label{ref:MainMenuShortcuts}Shortcuts} 269\section{\label{ref:MainMenuShortcuts}Shortcuts}
270 270
271This menu item is a container for user defined shortcuts to files, folders or 271This menu item is a container for user defined shortcuts to files, folders or
272settings. The following are valid shortcuts: 272settings. With a shortcut,
273\begin{itemize} 273\begin{itemize}
274 \item A file can be ``run'' (i.e. a music file played, plugin started or 274 \item A file can be ``run'' (i.e. a music file played, plugin started or
275 a \fname{.cfg} loaded) 275 a \fname{.cfg} loaded)
276 \item The file browser can be opened with the cursor positioned at 276 \item The file browser can be opened with the cursor positioned at
277 the specified file or folder 277 a specified file or folder
278 \item A file's or folder's ``Current Playlist'' context menu item can 278 \item A file's or folder's ``Current Playlist'' context menu item can
279 be displayed 279 be displayed
280 \item Most settings can be configured (any which can be added to the 280 \item A setting can be configured (any which can be added to the
281 \setting{Quick Screen}) 281 \setting{Quick Screen})
282 \item Any debug menu item (useful for developers mostly) 282 \item A debug menu item can be displayed (useful for developers mostly)
283\end{itemize} 283\end{itemize}
284 284
285\note{Shortcuts into the database are not possible} 285\note{Shortcuts into the database are not possible}
@@ -289,10 +289,10 @@ each item to be displayed. Each shortcut looks like the following:
289 289
290\begin{example} 290\begin{example}
291 [shortcut] 291 [shortcut]
292 type: <specify the shortcut type/action> 292 type: <shortcut type>
293 data: <what the shortcut actually links to> 293 data: <what the shortcut actually links to>
294 name: <what you want the shortcut to be displayed as> 294 name: <what the shortcut should be displayed as>
295 icon: <number of the theme icon to use (see http://www.rockbox.org/wiki/CustomIcons)> 295 icon: <number of the theme icon to use (see \wikilink{CustomIcons})>
296\end{example} 296\end{example}
297 297
298Only ``type'' and ``data'' are required (except if type is ``separator'' in which case 298Only ``type'' and ``data'' are required (except if type is ``separator'' in which case
@@ -300,18 +300,18 @@ Only ``type'' and ``data'' are required (except if type is ``separator'' in whic
300 300
301Available types are: 301Available types are:
302\begin{description} 302\begin{description}
303\item[file] \config{data} is the filename to run 303\item[file] \config{data} is the name of the file to ``run''
304\item[browse] \config{data} is the file or the folder to open the file browser at 304\item[browse] \config{data} is the file or the folder to open the file browser at
305\item[playlist menu] \config{data} is the file or the folder to open the 305\item[playlist menu] \config{data} is the file or the folder to open the
306 ``Current Playlist'' context menu item on 306 ``Current Playlist'' context menu item on
307\item[setting] \config{data} is the config name of the setting you want to change 307\item[setting] \config{data} is the config name of the setting you want to change
308 (see \reference{ref:config_file_options} for the list of the possible settings)
308\item[debug] \config{data} is the name of the debug menu item to display 309\item[debug] \config{data} is the name of the debug menu item to display
309\item[separator] \config{data} is ignored; name can be used to display text, 310\item[separator] \config{data} is ignored; \config{name} can be used to display text,
310 or left blank to make the list more accessible with visual gaps 311 or left blank to make the list more accessible with visual gaps
311\end{description} 312\end{description}
312 313
313 314If the name/icon items are not specified, a sensible default will be used.
314If the name/icon items are not specified a sensible default will be used.
315 315
316\note{For the ``browse'' type, if you want the file browser to start \emph{inside} 316\note{For the ``browse'' type, if you want the file browser to start \emph{inside}
317a folder, make sure the data has the trailing slash (i.e \fname{/Music/} instead of 317a folder, make sure the data has the trailing slash (i.e \fname{/Music/} instead of