From: Svjatoslav Agejenko Date: Mon, 21 Nov 2016 20:14:52 +0000 (+0200) Subject: Improved documentation. X-Git-Url: http://www2.svjatoslav.eu/gitweb/?p=instantlauncher.git;a=commitdiff_plain;h=17d7a34974ab7b0142e10c6f85880c5290dbf0cd Improved documentation. --- diff --git a/doc/index.html b/doc/index.html index d67058c..068ef9a 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Instantlauncher - navigate to your files and programs quickly! @@ -149,8 +149,10 @@ for the JavaScript code in this tag.

Table of Contents

@@ -174,18 +176,81 @@ published by the Free Software Foundation.
-

1 Usage

+

1 General description

-TODO: +Quick filesystem based document/application launcher. It starts by showing +content of predefined directory. Sub directories can be chosen by simply moving +mouse pointer over corresponding directory. +

+ + +
+

screenshot.png

-
+

+Files types are color-coded. +

+
+
-

2 TODO

+

2 Usage

+
    +
  • Executable file: +
      +
    • Left mouse click: +
        +
      • Run executable file.
        • +
      • +
    • Right mouse click: +
        +
      • Toggle executable state.
        • +
      • +
    • + +
  • Non-executable file: +
      +
    • Left mouse click: +
        +
      • Open file using corresponding application.
        • +
      • +
    • Right mouse click: +
        +
      • Toggle executable state.
        • +
      • +
    • + +
  • Directory/symlink: +
      +
    • Left mouse click: +
        +
      • Open directory using configured filesystem browser.
        • +
      • +
    • Right mouse click: +
        +
      • Open directory using configured text based terminal emulator.
        • +
      • +
    • +
+
+
+ +
+

3 Configuration

+
+

+TODO: +

+
+
+ +
+

4 TODO

+

TODO:

@@ -194,7 +259,7 @@ TODO:

Author: Svjatoslav Agejenko

-

Created: 2016-11-21 Mon 08:21

+

Created: 2016-11-21 Mon 22:12

Validate

diff --git a/doc/index.org b/doc/index.org index 42b9fee..dd9cf29 100644 --- a/doc/index.org +++ b/doc/index.org @@ -15,10 +15,37 @@ - [[http://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]] +* General description +Quick filesystem based document/application launcher. It starts by showing +content of predefined directory. Sub directories can be chosen by simply moving +mouse pointer over corresponding directory. + +[[file:screenshot.png]] + +Files types are color-coded. + * Usage ++ Executable file: + + Left mouse click: + + Run executable file. + + Right mouse click: + + Toggle executable state. + ++ Non-executable file: + + Left mouse click: + + Open file using corresponding application. + + Right mouse click: + + Toggle executable state. + ++ Directory/symlink: + + Left mouse click: + + Open directory using configured filesystem browser. + + Right mouse click: + + Open directory using configured text based terminal emulator. + +* Configuration TODO: - * TODO TODO: diff --git a/doc/screenshot.png b/doc/screenshot.png new file mode 100644 index 0000000..5b840af Binary files /dev/null and b/doc/screenshot.png differ diff --git a/src/test/resources/exampleMenu/Moon.jpeg b/src/test/resources/exampleMenu/Moon.jpeg new file mode 100644 index 0000000..c3beeac Binary files /dev/null and b/src/test/resources/exampleMenu/Moon.jpeg differ diff --git a/src/test/resources/exampleMenu/another directory/sample.txt b/src/test/resources/exampleMenu/another directory/sample.txt new file mode 100644 index 0000000..e69de29 diff --git a/src/test/resources/exampleMenu/broken link b/src/test/resources/exampleMenu/broken link new file mode 120000 index 0000000..86a410d --- /dev/null +++ b/src/test/resources/exampleMenu/broken link @@ -0,0 +1 @@ +broken \ No newline at end of file diff --git a/src/test/resources/exampleMenu/chosen subdirectory/Sunrise over Tallinn.jpeg b/src/test/resources/exampleMenu/chosen subdirectory/Sunrise over Tallinn.jpeg new file mode 100644 index 0000000..33d6eef Binary files /dev/null and b/src/test/resources/exampleMenu/chosen subdirectory/Sunrise over Tallinn.jpeg differ diff --git a/src/test/resources/exampleMenu/chosen subdirectory/sample.txt b/src/test/resources/exampleMenu/chosen subdirectory/sample.txt new file mode 100644 index 0000000..e69de29 diff --git a/src/test/resources/exampleMenu/executable.sh b/src/test/resources/exampleMenu/executable.sh new file mode 100755 index 0000000..8bb9f02 --- /dev/null +++ b/src/test/resources/exampleMenu/executable.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +xclock + + + diff --git a/src/test/resources/exampleMenu/sample link b/src/test/resources/exampleMenu/sample link new file mode 120000 index 0000000..454bc28 --- /dev/null +++ b/src/test/resources/exampleMenu/sample link @@ -0,0 +1 @@ +another directory/ \ No newline at end of file