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