summaryrefslogtreecommitdiff
path: root/manual/main_menu/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/main_menu/main.tex')
-rw-r--r--manual/main_menu/main.tex57
1 files changed, 57 insertions, 0 deletions
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index 139d85f958..3d5a2be69f 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -265,3 +265,60 @@ pages of information.}
265 quickscreen, then pressing up and down will cycle through this setting in 265 quickscreen, then pressing up and down will cycle through this setting in
266 opposite directions. 266 opposite directions.
267} 267}
268
269\section{\label{ref:MainMenuShortcuts}Shortcuts}
270
271This menu item is a container for user defined shortcuts to files, folders or
272settings. The following are valid shortcuts:
273\begin{itemize}
274 \item A file can be ``run'' (i.e. a music file played, plugin started or
275 a \fname{.cfg} loaded)
276 \item The file browser can be opened with the cursor positioned at
277 the specified file or folder
278 \item A file's or folder's ``Current Playlist'' context menu item can
279 be displayed
280 \item Most settings can be configured (any which can be added to the
281 \setting{Quick Screen})
282 \item Any debug menu item (useful for developers mostly)
283\end{itemize}
284
285\note{Shortcuts into the database are not possible}
286
287Shortcuts are loaded from the file \fname{/.rockbox/shortcuts.txt} which lists
288each item to be displayed. Each shortcut looks like the following:
289
290\begin{example}
291 [shortcut]
292 type: <specify the shortcut type/action>
293 data: <what the shortcut actually links to>
294 name: <what you want the shortcut to be displayed as>
295 icon: <number of the theme icon to use (see http://www.rockbox.org/wiki/CustomIcons)>
296\end{example}
297
298Only ``type'' and ``data'' are required (except if type is ``separator'' in which case
299``data'' is also not required).
300
301Available types are:
302\begin{description}
303\item[file] \config{data} is the filename to run
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
306 ``Current Playlist'' context menu item on
307\item[setting] \config{data} is the config name of the setting you want to change
308\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 or left blank to make the list more accessible with visual gaps
311\end{description}
312
313
314If the name/icon items are not specified a sensible default will be used.
315
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
318\fname {/Music}). Without the trailing slash, it will cause the file broser to open
319with \fname{/Music} selected instead.}
320
321The file \fname{shortcuts.txt} can be edited with any text editor. Most items can
322also be added to it through their context menu item ``Add to shortcuts''.
323A reboot is needed for manual changes to \fname{shortcuts.txt} to be applied.
324