Merge pull request #5 from humdingerb/newgui

New GUI and features

documentation/User Documentation.html

@@ -109,42 +109,84 @@
 <img width="64" height="64" src="./images/filer_icon_64.png" alt="Filer icon" />
 <p><span style="font-size: 1.5em; font-weight:bold">Filer's User Documentation</span></p>
 <hr />
-<p id="index"><a href="#filer">Filer</a> &mdash; <a href="#filer-usage">Filer Usage</a><br />
-<a href="#autofiler">AutoFiler</a> &mdash; <a href="#autofiler-usage">AutoFiler Usage</a></p>
+<p id="index"><a href="#usage">Usage</a> &mdash; <a href="#dropzone">Dropzone</a> &mdash; <a href="#rules">Rules</a> &mdash; <a href="#autofiler">AutoFiler</a> &mdash; <a href="#help">Help</a> &mdash; <a href="#history">History</a></p>
 </div>
 <hr />
 <p><br /></p>
-<p><i>Filer</i> is an automatic file organizer. It takes the files it's opened with or that are dropped on its icon and move, rename, copy or do all sorts of other things with them according to rules created by the user.</p>
-<p><i>Filer</i> is accompanied by <i>AutoFiler</i>. Instead of working on a set of files provided by the user, it can be started together with Haiku to monitor certain folders and deal with new files appearing there according to the user-defined rules.</p>
+<p><i>Filer</i> is an automatic file organizer. It takes the files it's opened with or that are dropped on its icon and moves, renames, copies or does all sorts of other things with them according to rules created by the user.</p>
+<p><i>Filer</i> is accompanied by <i>AutoFiler</i>. Instead of working on a set of files provided by the user, it can be started (automatically with Haiku) to monitor certain folders and deal with new files appearing there according to the user-defined rules.</p>
+
+<h2>
+<a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
+<a id="usage" name="usage">Usage</a></h2>
+<p>When started for the first time, you are asked if you'd like to have a few example rules by default. You can edit them to your needs or remove them altogether at any time. All settings are saved in <tt>~/config/settings/Filer/</tt>.</p>
+<p>Once you have created some rules, using <i>Filer</i> to process files accordingly is very simple. There are basically four ways:</p>
+<ol>
+<li>From a Terminal, simply type "<tt>Filer</tt>" followed by the files you want processed.</li>
+<li>Select the files to process, right-click them and choose <span class="menu">Open with… | Filer</span> from Tracker's context menu.</li>
+<li>Select the files to process and drag&amp;drop them on Filer's icon. You may want to create a link to <i>Filer</i> on the Desktop for that.</li>
+<li>Open Filer, select the files to process and drag&amp;drop them onto the "Dropzone". The Dropzone can also be embedded into the Desktop as a Replicant.</li>
+</ol>
+<p>…or have <i>AutoFiler</i> monitor specific folders to automatically process their incoming files according to Filer's rules.</p>
+<p>Filer's interface is divided into four tabs: Dropzone, Rules, AutoFiler and Help.</p>
+
 <h2>
 <a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="filer" name="filer">Filer</a></h2>
+<a id="dropzone" name="dropzone">Dropzone</a></h2>
 <div align="center">
-<img src="./images/filer_ruleslist.png" alt="Filer list of rules" />&nbsp;&nbsp;&nbsp;<img src="./images/filer_edit_rule.png" alt="Editing a rule" /></div>
-<p>Double-clicking <i>Filer</i> opens the settings with a list of organization rules. When started for the first time, you are asked if you'd like to have a few example rules by default. You can edit them to your needs or remove them altogether at any time.</p>
+<img src="./images/filer_dropzone.png" alt="Filer's dropzone" />
+</div>
+<p>As described above under 4.), you can drag&amp;drop files onto the Dropzone to have them processed according to your set of rules. If you'd like to embed this Dropzone into the Desktop, click the button <span class="button">Replicate dropzone…</span>.<br />
+It opens a window to resize the dropzone to fit your needs. When that's done, drag the little Replicant handle in the bottom-right corner onto your Desktop. Make sure to have <span class="menu">Show replicants</span> in the Deskbar menu activated. Once on the Desktop, right-click the Replicant's handle for a menu to remove it again.</p>
+
+<h2>
+<a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
+<a id="rules" name="rules">Rules</a></h2>
+<div align="center">
+<img src="./images/filer_ruleslist.png" alt="Filer's rules" />
+</div>
+<p>The second tab shows the list of organization rules. Every dropped file is being tested against &ndash; and if its type etc. matches processed  by &ndash; each rule, top to bottom.</p>
+<p>You can arrange the rules with the <span class="button">Move up/down</span> buttons and <span class="button">Add…</span>, <span class="button">Edit…</span> and <span class="button">Remove</span> them.<br />
+Here's the window that opens to edit a rule:</p>
+<div align="center">
+<img src="./images/filer_edit_rule.png" alt="Editing a rule" /></div>
 <p>A rule needs three items: A <span class="menu">Description</span>, the condition <span class="menu">When</span> it is applied, and what action to <span class="menu">Do</span>.</p>
 <p>Click on the buttons in the "When" and "Do" boxes to explore the various options to construct the right condition and what action will be taken. You can add several conditions which will <i>all</i> have to be met to trigger the action. If you add several actions in the "Do" box, be aware that they are executed in order, from top to bottom.</p>
 <p>Please read the <a href="Rule-Making%20Reference.html">Rule-Making Reference</a> (also available from the <span class="button">Help…</span> button) for more information on the various possibilities.</p>
-<h2>
-<a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="filer-usage" name="filer-usage">Filer Usage</a></h2>
-<p>Once you have created some rules, using <i>Filer</i> to process some files accordingly is very simple. There are basically three ways:</p>
-<ol>
-<li>Select the files to process, right-click them and choose <span class="menu">Open with… | Filer</span> from Tracker's context menu.</li>
-<li>Select the files to process and drag&amp;drop them on Filer's icon. You may want to create a link to Filer on the Desktop for that.</li>
-<li>From within a Terminal, simply type "Filer" followed by the files you want processed.</li>
-</ol>
+
 <h2>
 <a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
 <a id="autofiler" name="autofiler">AutoFiler</a></h2>
 <p>When <i>AutoFiler</i> is running, it monitors user-defined folders and executes the actions defined in the <i>Filer</i> rules automatically.</p>
+<div align="center">
+<img src="./images/autofiler_settings.png" alt="AutoFiler settings" />
+</div>
+
+<p>The <i>AutoFiler</i> itself is a background application. You can activate the checkbox at the top to automatically <span class="menu">Run AutoFiler on system startup</span>. The button to beside it lets you start/stop it manually.</p>
+<p>You can <span class="button">Add…</span>, <span class="button">Edit…</span> and <span class="button">Remove</span> the folders that <i>AutoFiler</i> will monitor for incoming files.</p>
+
 <h2>
 <a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
-<a id="autofiler-usage" name="autofiler-usage">AutoFiler Usage</a></h2>
-<p>The <i>AutoFiler</i> itself is a background application that normally isn't started manually. If you want to stop an already running <i>AutoFiler</i>, you'll have to quit it through a tool like Haiku's ProcessController or kill it from the TeamMonitor (press <span class="key">CTRL</span> <span class="key">ALT</span> <span class="key">DEL</span>).</p>
-<p>The configuration is done with the <i>AutoFiler Settings</i>:</p>
+<a id="help" name="help">Help</a></h2>
 <div align="center">
-<img src="./images/autofiler_settings.png" alt="AutoFiler settings" /></div>
-<p>You can add, edit and remove the folders that <i>AutoFiler</i> will monitor and use the checkbox to enable/disable the automatic launch on startup.</p>
+<img src="./images/help.png" alt="The help tab" />
+</div>
+<p>The last tab shows some information about <i>Filer</i> and offers two quick links to <span class="button">Help on rules</span> and the <span class="button">User documentation</span>.</p>
+
+<h2>
+<a href="#"><img src="images/up.png" style="border:none;float:right" alt="index" /></a>
+<a id="history" name="history">History</a></h2>
+<p><b>1.0.0</b> - <i>2008:</i></p>
+<ul>
+<li>Initial release.</li>
+</ul>
+
+<p><b>1.1.0</b> - <i>03-05-2016</i></p>
+<ul>
+<li>A new GUI to integrate Filer and AutoFiler settings.</li>
+<li>Add a button to manually start/stop AutoFiler.</li>
+<li>Adding a dropzone and make it replicatable.
+<li>Add user documentation.</li></li>
+</ul>
 </body>
 </html>