Fix some quotation marks. Thanks to Alexander Levin for pointing it out.
[Rockbox.git] / manual / plugins / shortcuts.tex
blobcb9979a68ba341b6c71811d5d51187b07ec3801f
1 \subsection{Shortcuts}
3 The Shortcuts Plugin allows you to jump to places within the file browser
4 without having to navigate there manually. The plugin works with
5 \fname{.link} files. A \fname{.link} file is just a text file with every
6 line containing the name of the file or the directory you want to quickly
7 jump to. All names should be full absolute names, i.e. they should start
8 with a \fname{/}. Directory names should also end with a \fname{/}.
10 \subsubsection{How to create \fname{.link} files}
12 You can use your favourite text editor to create a \fname{.link} file on the
13 PC an then copy the file to the \dap{}. Or you can use the context menu on
14 either a file or a directory in the file browser tree, and use the ``Add to
15 shortcuts'' menu option. This will append a line with the full name of the
16 file or the directory to the \fname{shortcuts.link} file in the root
17 directory of the \dap{}. (The file will be created if it does not exist
18 yet.) You can later rename the automatically created \fname{shortcuts.link}
19 file or move it to another directory if you wish. Subsequent calls of the
20 context menu will create it again.
23 \subsubsection{How to use \fname{.link} files, i.e. jump to desired places}
25 To use a \fname{.link} file just ``play'' it from the file browser. This will
26 show you a list with the entries in the file. Selecting one of them will
27 then exit the plugin and leave you within the directory selected, or with
28 the file selected in the file browser. You can then play the file or do
29 with it whatever you want. The file will not be ``played'' automatically.
31 If the \fname{.link} file contains only one entry no list will be shown, you
32 will directly jump to that location. The file \fname{shortcuts.link} in the
33 root directory is an exception. After ``playing'' it, the list will be shown
34 even if the file contains just one entry.
36 If the list you are seeing is from \fname{shortcuts.link} in the root
37 directory, you can delete the selected entry by pressing \ActionStdMenu.
38 Deleting entries from other \fname{.link} files is not possible.
41 \subsubsection{Advanced Usage}
43 Placing the line ``\#Display last path segments=n'' (where n is a number) in
44 the beginning of a \fname{.link} file will leave just the last n segments of
45 the entries when they are shown. For example, if n is chosen to be 1, then
46 the entry \fname{/MyMusic/collection/song.mp3} will be shown as
47 \fname{song.mp3}. This allows you to hide common path prefixes.
49 You can also provide a custom display name for each entry individually. To
50 do so, append a tabulator character after the entry's path followed by your
51 custom name. That name will then be used for showing the entry. For example,
52 \fname{/MyMusic/collection/song.mp3<TAB>My favourite song!}