Skip to content

GitLab

Commit 755d8393 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[ADD #530] Moved help data to a separate directory and added some more help

parent c1852bbf
Hide whitespace changes
Inline Side-by-side
Showing with 36 additions and 5 deletions
src/gui/qt4/OpenWalnutHelp.html → doc/user/help/OpenWalnutHelp.html
View file @ 755d8393
<html>
<body bgcolor="#fff">
<h1>OpenWalnut Help</h1>
<h1>OpenWalnut Help <img src="icons/logoIcon.png"/></h1>
<h2>Contents</h2>
<ol>
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#MainWindow">Main Window</a></li>
<li><a href="#Navigation">Navigation</a></li>
<li><a href="#Keyboard">Keyboard Shortcuts</a></li>
<li><a href="#Toolbar">Toolbar</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,
......@@ -17,6 +20,12 @@ As described <a href="#Config">below</a>, the appearance of the GUI is customiza
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="MainWindow" />Main Window</h2>
By now this section only shows a snapshot of the main window of OpenWalnut. In
the future this illustration will be annotated to explain the names and the use of
all components of the main window.
<img src="images/mainWindow.png" width="100%"/>
<h2><a name="Navigation" />Navigation</h2>
<h3>Navigation in Main View</h3>
<table>
......@@ -62,14 +71,33 @@ in every instance of OpenWalnut because the belong to special modules.
<tr><td>[Backspace]</td><td>Removes module</td></tr>
</table>
<h2><a name="Toolbar" />Toolbar</h2>
<table>
<tr><td><b>Icon</b></td><td><b>Name</b></td><td><b>Description</b></td></tr>
<tr><td><img src="icons/fileopen.png" width="20"></td><td>Load
Data</td><td>Loads data given in various formats like fibers (.fib), NIfTI
images (.nii, .nii.gz) or EEG data (.cnt).</td></tr>
<tr><td><img src="icons/projOpen.png" width="20"></td><td>Load a project from
file</td><td>Opens a project file (.owp), and instantiates modules, sets their
connections and orients the scene accordingly.</td></tr>
<tr><td><img src="icons/disc.png" width="20"></td><td>Save current project to
file</td><td>Saves the current state (modules, connections, orientation of
the scene) of OpenWalnut to a project file (.owp).</td></tr>
<tr><td><img src="icons/camera.png" width="20"></td><td>Reset Main View</td><td>Rotates
and scales the scene in the cetral 3D view to show the same orientation as
after program startup but zoomed to show all contents of the
scene.</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 />
<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
</html>
src/CMakeLists.txt
View file @ 755d8393
......@@ -297,7 +297,9 @@ add_custom_target( fontsDirectoryConfiguration
#---------- OpenWalnut help -------------
ADD_CUSTOM_TARGET( onlineHelp
ALL
COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/gui/qt4/OpenWalnutHelp.html ${PROJECT_BINARY_DIR}/share/OpenWalnut
COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/../doc/user/help/OpenWalnutHelp.html ${PROJECT_BINARY_DIR}/share/OpenWalnut
COMMAND ${CMAKE_COMMAND} -E copy_directory ${PROJECT_SOURCE_DIR}/../doc/user/help/images/ ${PROJECT_BINARY_DIR}/share/OpenWalnut/images
COMMAND ${CMAKE_COMMAND} -E copy_directory ${PROJECT_SOURCE_DIR}/gui/icons/ ${PROJECT_BINARY_DIR}/share/OpenWalnut/icons
COMMENT "Copy online help"
)
......
src/gui/qt4/WMainWindow.cpp
View file @ 755d8393
......@@ -766,7 +766,8 @@ void WMainWindow::openOpenWalnutHelpDialog()
window->show();
QWebView *view = new QWebView( this );
view->setHtml( content.c_str() );
QString location( QString( "file://" ) + WPathHelper::getAppPath().file_string().c_str() + "/../share/OpenWalnut/" );
view->setHtml( content.c_str(), QUrl( location ) );
view->show();
layout->addWidget( view );
}
......
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