Skip to content

GitLab

Commit b9e62a2b authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[ADD #530] Added more help

parent f3ab2995
Hide whitespace changes
Inline Side-by-side
Showing with 47 additions and 2 deletions
src/gui/qt4/OpenWalnutHelp.html
View file @ b9e62a2b
<html>
<body>
<h1>OpenWalnut Help</h1>
<h2>Contents</h2>
<ol>
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#Navigation">Navigation</a></li>
<li><a href="#Keyboard">Keyboard Shortcuts</a></li>
<li><a href="#Config">Customizing OpenWalnut</a></li>
</ol>
<h2><a name="Introduction" />Introduction</h2>
The intention of this help document is to give short overview of how to use the current version
of OpenWalnut. Although it is not at all comprehensive,
it provides a description of the most commonly used features and GUI elements.
As described <a href="#Config">below</a>, the appearance of the GUI is customizable. This help document
asumes the standard configuration. Additionally, some described features may not be available
in every instance of OpenWalnut because the belong to special modules.
<h2><a name="Navigation" />Navigation</h2>
<h3>Navigation in Main View</h3>
<table>
<tr><td><b><i>Mouse Button&nbsp;&nbsp;</i></b></td><td><b><i>Action</i></b></td></tr>
......@@ -9,7 +29,7 @@
<tr><td><b><i>Key</i></b></td><td><b><i>Action</i></b></td></tr>
<tr><td>+</td><td>Zoom in</td></tr>
<tr><td>-</td><td>Zoom out</td></tr>
<tr><td>[space]</td><td>Reset view</td></tr>
<tr><td>[Space]</td><td>Reset view</td></tr>
</table>
<h3>Navigation in EEG View</h3>
<table>
......@@ -21,10 +41,35 @@
<tr><td>Wheel + Right</td><td>Change spacing between graphs</td></tr>
<tr><td>Wheel + Left</td><td>Change sensitivity of the coloring of the head surface</td></tr>
</table>
<h2><a name="Keyboard" />Keyboard Shortcuts</h2>
<h3>Program-wide Keyboard Shortcuts</h3>
<table>
<tr><td><b><i>Key</i></b></td><td><b><i>Action</i></b></td></tr>
<tr><td>[Ctrl] + q</td><td>Quit</td></tr>
<tr><td>[Esc]</td><td>Resets main view</td></tr>
<tr><td>[F1]</td><td>Opens help window</td></tr>
</table>
\ No newline at end of file
</table>
<h3>ROI tree</h3>
<table>
<tr><td><b><i>Key</i></b></td><td><b><i>Action</i></b></td></tr>
<tr><td>[Delete]</td><td>Removes ROI</td></tr>
</table>
<h3>Module tree</h3>
<table>
<tr><td><b><i>Key</i></b></td><td><b><i>Action</i></b></td></tr>
<tr><td>[Backspace]</td><td>Removes module</td></tr>
</table>
<h2><a name="Config" />Customizing OpenWalnut</h2>
OpenWalnut allows you to configure several features. Most of these options are only useful to advanced users.
You can have a user-scope configuration in your HOME directory as ".walnut.cfg".
If this file exists, OpenWalnut loads this file. You can also specify a "walnut.cfg" in your OpenWalnut directory under
"share/OpenWalnut/". A default file will be there after installation. The dafault file is very well documented.
<br />
<br />
<small>For more information on OpenWalnut visit <a href="http://www.openwalnut.org">www.openwalnut.org</a>.</small>
</body>
</html>
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment