Improved documentation.
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Mon, 21 Nov 2016 20:14:52 +0000 (22:14 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Mon, 21 Nov 2016 20:14:52 +0000 (22:14 +0200)
doc/index.html
doc/index.org
doc/screenshot.png [new file with mode: 0644]
src/test/resources/exampleMenu/Moon.jpeg [new file with mode: 0644]
src/test/resources/exampleMenu/another directory/sample.txt [new file with mode: 0644]
src/test/resources/exampleMenu/broken link [new symlink]
src/test/resources/exampleMenu/chosen subdirectory/Sunrise over Tallinn.jpeg [new file with mode: 0644]
src/test/resources/exampleMenu/chosen subdirectory/sample.txt [new file with mode: 0644]
src/test/resources/exampleMenu/executable.sh [new file with mode: 0755]
src/test/resources/exampleMenu/sample link [new symlink]

index d67058c..068ef9a 100644 (file)
@@ -3,7 +3,7 @@
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
-<!-- 2016-11-21 Mon 08:21 -->
+<!-- 2016-11-21 Mon 22:12 -->
 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <meta  name="viewport" content="width=device-width, initial-scale=1" />
 <title>Instantlauncher - navigate to your files and programs quickly!</title>
@@ -149,8 +149,10 @@ for the JavaScript code in this tag.
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents">
 <ul>
-<li><a href="#orgheadline1">1. Usage</a></li>
-<li><a href="#orgheadline2">2. <span class="todo TODO">TODO</span> </a></li>
+<li><a href="#orgheadline1">1. General description</a></li>
+<li><a href="#orgheadline2">2. Usage</a></li>
+<li><a href="#orgheadline3">3. Configuration</a></li>
+<li><a href="#orgheadline4">4. <span class="todo TODO">TODO</span> </a></li>
 </ul>
 </div>
 </div>
@@ -174,18 +176,81 @@ published by the Free Software Foundation.</li>
 
 
 <div id="outline-container-orgheadline1" class="outline-2">
-<h2 id="orgheadline1"><span class="section-number-2">1</span> Usage</h2>
+<h2 id="orgheadline1"><span class="section-number-2">1</span> General description</h2>
 <div class="outline-text-2" id="text-1">
 <p>
-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.
+</p>
+
+
+<div class="figure">
+<p><img src="screenshot.png" alt="screenshot.png" />
 </p>
-</div>
 </div>
 
+<p>
+Files types are color-coded.
+</p>
+</div>
+</div>
 
 <div id="outline-container-orgheadline2" class="outline-2">
-<h2 id="orgheadline2"><span class="section-number-2">2</span> <span class="todo TODO">TODO</span> </h2>
+<h2 id="orgheadline2"><span class="section-number-2">2</span> Usage</h2>
 <div class="outline-text-2" id="text-2">
+<ul class="org-ul">
+<li>Executable file:
+<ul class="org-ul">
+<li>Left mouse click:
+<ul class="org-ul">
+<li>Run executable file.</li>
+</ul></li>
+<li>Right mouse click:
+<ul class="org-ul">
+<li>Toggle executable state.</li>
+</ul></li>
+</ul></li>
+
+<li>Non-executable file:
+<ul class="org-ul">
+<li>Left mouse click:
+<ul class="org-ul">
+<li>Open file using corresponding application.</li>
+</ul></li>
+<li>Right mouse click:
+<ul class="org-ul">
+<li>Toggle executable state.</li>
+</ul></li>
+</ul></li>
+
+<li>Directory/symlink:
+<ul class="org-ul">
+<li>Left mouse click:
+<ul class="org-ul">
+<li>Open directory using configured filesystem browser.</li>
+</ul></li>
+<li>Right mouse click:
+<ul class="org-ul">
+<li>Open directory using configured text based terminal emulator.</li>
+</ul></li>
+</ul></li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-orgheadline3" class="outline-2">
+<h2 id="orgheadline3"><span class="section-number-2">3</span> Configuration</h2>
+<div class="outline-text-2" id="text-3">
+<p>
+TODO:
+</p>
+</div>
+</div>
+
+<div id="outline-container-orgheadline4" class="outline-2">
+<h2 id="orgheadline4"><span class="section-number-2">4</span> <span class="todo TODO">TODO</span> </h2>
+<div class="outline-text-2" id="text-4">
 <p>
 TODO:
 </p>
@@ -194,7 +259,7 @@ TODO:
 </div>
 <div id="postamble" class="status">
 <p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2016-11-21 Mon 08:21</p>
+<p class="date">Created: 2016-11-21 Mon 22:12</p>
 <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
 </div>
 </body>
index 42b9fee..dd9cf29 100644 (file)
 - [[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 (file)
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 (file)
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 (file)
index 0000000..e69de29
diff --git a/src/test/resources/exampleMenu/broken link b/src/test/resources/exampleMenu/broken link
new file mode 120000 (symlink)
index 0000000..86a410d
--- /dev/null
@@ -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 (file)
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 (file)
index 0000000..e69de29
diff --git a/src/test/resources/exampleMenu/executable.sh b/src/test/resources/exampleMenu/executable.sh
new file mode 100755 (executable)
index 0000000..8bb9f02
--- /dev/null
@@ -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 (symlink)
index 0000000..454bc28
--- /dev/null
@@ -0,0 +1 @@
+another directory/
\ No newline at end of file