Merge pull request #71 from sdias/documentation-improved-navigation

Documentation improved navigation

docs/installation.md

@@ -1,5 +1,22 @@
 # Installation
 
+## Table of contents
+
+<!-- TOC -->
+
+- [Installation](#installation)
+    - [Table of contents](#table-of-contents)
+    - [Prerequisites](#prerequisites)
+    - [Procedure](#procedure)
+        - [Autostart](#autostart)
+            - [Procedure 1: Autostart folder](#procedure-1-autostart-folder)
+            - [Procedure 2: Task scheduler](#procedure-2-task-scheduler)
+    - [Request assistance](#request-assistance)
+
+<!-- /TOC -->
+
+Click here to go back to the [README](../README.md).
+
 ## Prerequisites
 
 **This application only works on Windows 10 x64 (64 bit) systems** due to limitations in the library used to control the virtual desktops.  
@@ -46,3 +63,5 @@ Please try the first procedure: if it does not work try the second one.
 ## Request assistance
 
 If you have problems with the installation of Windows 10 Virtual Desktop Enhancer please submit a new issue in the project page as described [here](issue-page.md).
+
+Click here to go back to the [README](../README.md).

docs/issue-page.md

@@ -1,4 +1,23 @@
-# Issue page: what is it?
+# Issue page
+
+## Table of contents
+
+<!-- TOC -->
+
+- [Issue page](#issue-page)
+    - [Table of contents](#table-of-contents)
+    - [Issue page: what is it?](#issue-page-what-is-it)
+    - [Windows 10 Virtual Desktop Enhancer's issue page](#windows-10-virtual-desktop-enhancers-issue-page)
+    - [When should I open a new issue?](#when-should-i-open-a-new-issue)
+    - [What to include in the issue?](#what-to-include-in-the-issue)
+        - [Example of an useless issue](#example-of-an-useless-issue)
+        - [Example of a useful issue](#example-of-a-useful-issue)
+
+<!-- /TOC -->
+
+Click here to go back to the [README](../README.md).
+
+## Issue page: what is it?
 
 The _Issue page_ of a project is a service on GitHub which, despite its name, lets the users and  the developers of a project communicate easily about pretty much anything related to the project itself.  
 Its main use is to submit bugs and problem found while using the program, but, depending on the project and its administrators it can also be used to ask for new features in next releases, ask questions and receive help.
@@ -8,7 +27,7 @@ Its main use is to submit bugs and problem found while using the program, but, d
 [Here](https://github.com/sdias/win-10-virtual-desktop-enhancer/issues/) you can find Windows 10 Virtual Desktop Enhancer's Issue page.  
 If you open that link you will find a list of open issues (which have not been solved yet) and old closed (solved) issues as well.
 
-### When should I open a new issue?
+## When should I open a new issue?
 
 If you have found yourself in any of these situations:
 
@@ -23,7 +42,7 @@ If you did not find any issue related to your case then you can submit a new iss
 
 **Important note:** if you want to comment on an issue or open a new one you will need to login with your GitHub account. If you don't have one you can register [here](https://github.com/join): it's a really quick procedure.
 
-### What to include in the issue?
+## What to include in the issue?
 
 If you are reporting a problem or a bug, please include as much details as you can, for example:
 
@@ -32,18 +51,20 @@ If you are reporting a problem or a bug, please include as much details as you c
 - Is this a recurring issue or a one-time event?
 - Have you tried anything to solve it? Have you had any form of success?
 
-#### Example of an useless issue
+### Example of an useless issue
 
 > Title: **Program not working**
 > Message: The program does not work: I cannot use it correctly as it sometimes stops working.
 
 This description of the problem is exceptionally vague and offers little to no ground for the developers to work on to understand, isolate and solve the problem.
 
-#### Example of a useful issue
+### Example of a useful issue
 
 > Title: **Program crashes when switching desktops**
 > Message: Since I installed the last version of the program sometimes as I switch desktops it crashes without giving any error message: it just shuts down (the icon in the tray bar disappears).  
 > Every time it has happened I was switching from the last to the first desktop, however it does not always happen: sometimes it will switch correctly and sometimes it will crash.
 
 This is a great description of the problem: the user reported many extremely useful information, such as a possible version number which introduced the bug, a meaningful description of what happens and an hypothesis on what action triggers the crash.  
 Obviously you will not always be able to give so much useful information, however _the more details you can report the better it is_.
+
+Click here to go back to the [README](../README.md).

docs/known-issues.md

@@ -7,10 +7,18 @@ For a complete list of all the issues reported for this project visit [this page
 
 ## Table of contents
 
-- [Programs run as another user](#programs-run-as-another-user)
-- [Remote Desktop Protocol](#remote-desktop-protocol)
-- [Synergy and AutoHotkey](#synergy-and-autohotkey)
-- [Windows 10 Game Bar](#windows-10-game-bar)
+<!-- TOC -->
+
+- [Known issues](#known-issues)
+    - [Table of contents](#table-of-contents)
+        - [Programs run as another user](#programs-run-as-another-user)
+        - [Remote Desktop Protocol](#remote-desktop-protocol)
+        - [Synergy and AutoHotkey](#synergy-and-autohotkey)
+        - [Windows 10 Game Bar](#windows-10-game-bar)
+
+<!-- /TOC -->
+
+Click here to go back to the [README](../README.md).
 
 ### Programs run as another user
 
@@ -64,3 +72,5 @@ Although it has not been possible to pinpoint exactly what the root cause of thi
 
  - Disabling the Windows Game Bar (recommended if it's not used on your computer). [Here is a guide](https://www.howtogeek.com/273180/how-to-disable-windows-10s-game-dvr-and-game-bar/) explaining how to do it
  - Not using the `Alt` key (neither alone nor with other keys) nor the `Win` key alone (it looks to be fine if used together with other keys) in your custom hotkeys setup (recommended if you want to use the Game Bar on your computer). See the [customization page](settings.md#keyboard-shortcuts) of this documentation for further details
+
+Click here to go back to the [README](../README.md).

docs/settings.md

@@ -5,14 +5,36 @@ Mainly you will have to edit some lines in the `settings.ini` file in the main f
 
 ## Table of contents
 
-- [Main settings](#main-settings)
-- [Custom wallpapers](#custom-wallpapers)
-- [Desktop names](#desktop-names)
-- [Tooltips](#tooltips)
-- [Keyboard shortcuts](#keyboard-shortcuts)
-- [Run programs when switching desktops](#run-programs-when-switching-desktops)
-- [Tray icon](#tray-icon)
-- [Old settings migration](#old-settings-migration)
+<!-- TOC -->
+
+- [Personalize the settings](#personalize-the-settings)
+    - [Table of contents](#table-of-contents)
+    - [Main settings](#main-settings)
+    - [Custom wallpapers](#custom-wallpapers)
+        - [Image wallpapers](#image-wallpapers)
+        - [Solid color wallpapers](#solid-color-wallpapers)
+        - [Example configuration](#example-configuration)
+    - [Desktop names](#desktop-names)
+        - [Example configuration](#example-configuration-1)
+    - [Tooltips](#tooltips)
+        - [Example configuration](#example-configuration-2)
+    - [Keyboard shortcuts](#keyboard-shortcuts)
+        - [Available shortcuts](#available-shortcuts)
+            - [Keyboard shortcuts modifier keys](#keyboard-shortcuts-modifier-keys)
+            - [Keyboard shortcuts identifier keys](#keyboard-shortcuts-identifier-keys)
+            - [Keyboard shortcuts combinations](#keyboard-shortcuts-combinations)
+        - [Example configurations](#example-configurations)
+            - [Default configuration](#default-configuration)
+            - [Custom configuration](#custom-configuration)
+    - [Run programs when switching desktops](#run-programs-when-switching-desktops)
+        - [Example configuration](#example-configuration-3)
+    - [Tray Icon](#tray-icon)
+        - [Icon Packs](#icon-packs)
+    - [Old settings migration](#old-settings-migration)
+
+<!-- /TOC -->
+
+Click here to go back to the [README](../README.md).
 
 ## Main settings
 
@@ -408,3 +430,5 @@ NextTenDesktops=
 PreviousDesktop=Left
 NextDesktop=Right
 ```
+
+Click here to go back to the [README](../README.md).