From 5c701b02809ffeec2e9de50e89995dbb85cd7a62 Mon Sep 17 00:00:00 2001
From: Sebastian Leonhardt <sebastian.leonhardt@web.de>
Date: Fri, 15 Sep 2017 23:43:41 +0200
Subject: Add support for Windows shortcuts (*.lnk files)

Supports only relative links across the same volume.

Change-Id: I4f61bb9d5f2385d5b15d2b9d9a3f814a7ac85b54
---
 manual/plugins/main.tex         |  3 +++
 manual/plugins/shortcuts.tex    |  4 ++++
 manual/plugins/winshortcuts.tex | 15 +++++++++++++++
 3 files changed, 22 insertions(+)
 create mode 100644 manual/plugins/winshortcuts.tex

(limited to 'manual')

diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index c07d106024..96326cbffe 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -165,6 +165,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
       {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
       {}{}
     Shortcuts             & \fname{.link}                    &   \\
+    MS Windows shortcuts  & \fname{.lnk}                     &   \\
     Chip-8 Emulator       & \fname{.ch8}                     &   \\
     Frotz                 & \fname{.z1} to \fname{.z8}       &   \\
     Image Viewer          & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}}  &   \\
@@ -200,6 +201,8 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
 
 {\input{plugins/shortcuts.tex}}
 
+{\input{plugins/winshortcuts.tex}}
+
 \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
 
 \opt{lcd_bitmap}{\input{plugins/frotz.tex}}
diff --git a/manual/plugins/shortcuts.tex b/manual/plugins/shortcuts.tex
index 2cca5f773f..813bdeaf56 100644
--- a/manual/plugins/shortcuts.tex
+++ b/manual/plugins/shortcuts.tex
@@ -8,6 +8,10 @@ line containing the name of the file or the directory you want to quickly
 jump to. All names should be full absolute names, i.e. they should start
 with a \fname{/}. Directory names should also end with a \fname{/}.
 
+\note{This plugin cannot read Microsoft Windows shortcuts (\fname{.lnk}
+files). These are handled by a separate plugin; see
+\reference{ref:Winshortcutsplugin}.}
+
 \subsubsection{How to create \fname{.link} files}
 
 You can use your favourite text editor to create a \fname{.link} file on the
diff --git a/manual/plugins/winshortcuts.tex b/manual/plugins/winshortcuts.tex
new file mode 100644
index 0000000000..a3a4063b6f
--- /dev/null
+++ b/manual/plugins/winshortcuts.tex
@@ -0,0 +1,15 @@
+\subsection{Windows Shortcuts}
+\label{ref:Winshortcutsplugin}
+
+This plugin follows Microsoft Windows Explorer shortcuts (\fname{.lnk} files).
+In Rockbox, these types of shortcuts will show up as \fname{.lnk} files. To
+follow a shortcut, just ``play'' a \fname{.lnk} file from the file browser.
+The plugin will navigate the file browser to the linked file (which
+will be highlighted) or directory (which will be opened). Linked files will
+not be automatically opened; you must do this manually.
+
+Only relative links across the same volume are supported.
+
+\note{You may like to use native Rockbox shortcuts instead. These can be
+    created from within Rockbox itself and have advanced capabilities.
+    See \reference{ref:Shortcutsplugin}.}
-- 
cgit v1.2.3