Skip to content

Commit

Permalink
Updated Help Documentation and changed Help Menu->Help to Help Menu->…
Browse files Browse the repository at this point in the history 
…Workbench Help
  • Loading branch information
John Harwell committed Sep 9, 2014
1 parent c703b72 commit dfd2086
Show file tree
Hide file tree
Showing 12 changed files with 74 additions and 47 deletions.
2 changes: 1 addition & 1 deletion src/GuiQt/GuiManager.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ GuiManager::GuiManager(QObject* parent)
/*
* Help dialog action
*/
m_helpViewerDialogDisplayAction = WuQtUtilities::createAction("Help...",
m_helpViewerDialogDisplayAction = WuQtUtilities::createAction("Workbench Help...",
"Show/Hide the Help Window",
QKeySequence::HelpContents,
this,
Expand Down
16 changes: 13 additions & 3 deletions src/Resources/HelpFiles/Menus/Help_Menu/Help_Menu.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,22 @@
"tool".</font> </li>
</ul>
<ul>
<li><font face="Calibri"><b>Workbench Help...</b> Information on
functions and features.&nbsp; The branched list on the left
are links to information about each Workbench component.&nbsp;</font></li>
<li><font face="Calibri"><b>Workbench Help...</b> Opens the Help
Window containing information on functions and features.&nbsp;
The Help Window is also accessible through the <img alt=""
src="Help_button.png" align="middle" height="26" width="27">
button in the top right of the <a
href="../../Workbench_Window/Workbench_Window.html"><b>Workbench
Window</b></a>.&nbsp;</font></li>
</ul>
<ul>
<ul>
<li><font face="Calibri">The branched list links to information
about each Workbench component. <br>
</font></li>
<li><font face="Calibri">Open branches by clicking the triangles
to the left.<br>
</font></li>
<li><font face="Calibri">Click on a topic to show information on
the right.&nbsp;</font><br>
</li>
Expand Down
Binary file added src/Resources/HelpFiles/Menus/Help_Menu/Help_button.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions src/Resources/HelpFiles/Workbench_Window/Viewing_Area/Viewing_Area.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
or in <a href="../../Toolbar/Chart_View/Chart_View.html"><u><b>Chart




Vie</b></u><u><b>w</b></u></a>, where chart data is
displayed.&nbsp;&nbsp; </font>
Expand All @@ -21,11 +22,13 @@
each <a href="../Viewing_Tabs/Viewing_Tabs.html"><u><b>Viewing




Tab</b></u></a>, unless Tile Tabs view is on (see <a
href="../../Menus/View_Menu/View_Menu.html"><u><b>View Menu</b></u></a>),




which displays images/charts for all tabs within a single
viewing area.</font></li>
Expand All @@ -41,6 +44,7 @@





View</u></b></a>, rotation is about the center of
gravity of the surface.</font></li>
Expand Down Expand Up @@ -93,11 +97,12 @@





Functions</b></u></a>).</font><br>
<br>
<font face="Calibri"><img alt="" src="Workbench_Window_1.jpg"
height="1301" width="1458"></font><br>
<font face="Calibri"><img alt=""
src="WBwindow_Horiz_Labels.png" height="1198" width="1368"></font><br>
</li>
</ul>
</ul>
Expand Down
Binary file added src/Resources/HelpFiles/Workbench_Window/Viewing_Area/WBwindow_Horiz_Labels.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/Resources/HelpFiles/Workbench_Window/Viewing_Area/Workbench_Window_1.jpg
View file
Binary file not shown.
Binary file added src/Resources/HelpFiles/Workbench_Window/WBwindow_Horiz_Labels.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...es/HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Help_button.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 10 additions & 2 deletions ...Workbench_Window/Window_Elements_Hide-Show_Buttons/Window_Elements_Hide-Show_Buttons.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,36 @@
Buttons</font></b></font><br>
<font face="Calibri">The Hide/Show buttons for the <a
href="../Workbench_Window.html"><u><b>Workbench Window</b></u></a>
elements (<a
elements (<b><a href="../../Menus/Help_Menu/Help_Menu.html">Help
Window</a></b>, <a
href="../../Information_Window/Information_Window.html"><u><b>Informat</b></u><u><b>ion



Window</b></u></a>, <a
href="../../Scenes_Window/Scenes_Window.html"><u><b>Scene</b></u><u><b>s
Window</b></u></a>, <a href="../../Toolbar/Toolbar.html"><u><b>Toolbar</b></u></a>,
<a href="../../Overlay_Toolbox/Overlay_Toolbox.html"><u><b>Overlay
Toolbox</b></u></a>, and <a
href="../../Features_Toolbox/Features_Toolbox.html"><u><b>Features


Toolbox</b></u></a>) are located in the upper right corner
of the Workbench Window. These buttons turn the display of these
elements on and off. The buttons are shaded gray (as in the images
below) to indicate that the element is on, and are unshaded when
the element is off.</font>
<blockquote><img alt="" src="Information_icon.png" align="middle"
<blockquote><img alt="" src="Help_button.png" align="middle"
height="26" width="27"><font face="Calibri">&nbsp;&nbsp; <b>Help
Window button<br>
<br>
</b></font><img alt="" src="Information_icon.png" align="middle"
height="27" width="27"><font face="Calibri">&nbsp;&nbsp;&nbsp; <b>Information






Window button</b><br>
<br>
Expand Down
76 changes: 39 additions & 37 deletions src/Resources/HelpFiles/Workbench_Window/Workbench_Window.html
View file
Original file line number Diff line number Diff line change
@@ -1,39 +1,41 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Workbench Window</title>
</head>
<body>
<font size="+2"><b><font face="Calibri">Workbench Window</font></b></font><br>
<font face="Calibri">Workbench Window refers to the main interface
of wb_view, containing the <a
href="Viewing_Tabs/Viewing_Tabs.html"><u><b>Viewing Tabs</b></u></a>,
<a href="../Toolbar/Toolbar.html"><u><b>Toolbar</b></u></a>, <a
href="Viewing_Area/Viewing_Area.html"><u><b>Viewing Area</b></u></a>,
<a href="../Overlay_Toolbox/Overlay_Toolbox.html"><u><b>Overlay
Toolbox</b></u></a>, <a
href="../Features_Toolbox/Features_Toolbox.html"><u><b>Features
Toolbox</b></u></a> and <a
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Workbench Window</title>
</head>
<body>
<font size="+2"><b><font face="Calibri">Workbench Window</font></b></font><br>
<font face="Calibri">Workbench Window refers to the main interface
of wb_view, containing the <a
href="Viewing_Tabs/Viewing_Tabs.html"><u><b>Viewing Tabs</b></u></a>,
<a href="../Toolbar/Toolbar.html"><u><b>Toolbar</b></u></a>, <a
href="Viewing_Area/Viewing_Area.html"><u><b>Viewing Area</b></u></a>,
<a href="../Overlay_Toolbox/Overlay_Toolbox.html"><u><b>Overlay
Toolbox</b></u></a>, <a
href="../Features_Toolbox/Features_Toolbox.html"><u><b>Features
Toolbox</b></u></a> and <a
href="Window_Elements_Hide-Show_Buttons/Window_Elements_Hide-Show_Buttons.html"><u><b>Window
Elements Hide/Show buttons</b></u></a> as shown.</font> <font
face="Calibri"> </font>
<ul>
<li><font face="Calibri">In PC/Linux, the Workbench Window also
includes the Menu bar.</font></li>
</ul>
<ul>
<li><font face="Calibri">More than one Workbench Window can be
opened at one time, either by selecting <b>New Window</b>

Elements Hide/Show buttons</b></u></a> as shown.</font> <font
face="Calibri"> </font>
<ul>
<li><font face="Calibri">In PC/Linux, the Workbench Window also
includes the Menu bar.</font></li>
</ul>
<ul>
<li><font face="Calibri">More than one Workbench Window can be
opened at one time, either by selecting <b>New Window</b>
from the <a href="../Menus/File_Menu/File_Menu.html"><u><b>File
menu</b></u></a> or from selections made from the <a
href="../Menus/Window_Menu/Window_Menu.html"><u><b>Window
menu</b></u></a>.</font></li>
</ul>
<font face="Calibri"><img alt="" src="Workbench_Window_1.jpg"
height="1301" width="1458"><br>
</font>
<ul>
</ul>
</body>
</html>

menu</b></u></a> or from selections made from the <a
href="../Menus/Window_Menu/Window_Menu.html"><u><b>Window
menu</b></u></a>.</font></li>
</ul>
<font face="Calibri"><img alt="" src="WBwindow_Horiz_Labels.png"
height="1198" width="1368"><br>
</font>
<ul>
</ul>
</body>
</html>
Binary file removed src/Resources/HelpFiles/Workbench_Window/Workbench_Window_1.jpg
View file
Binary file not shown.
6 changes: 4 additions & 2 deletions src/Resources/resources.qrc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
<file>./HelpFiles/Menus/File_Menu/Save-Manage_Files/Upload_symbol.png</file>
<file>./HelpFiles/Menus/Help_Menu/Bug_Report_box.png</file>
<file>./HelpFiles/Menus/Help_Menu/Help_box.png</file>
<file>./HelpFiles/Menus/Help_Menu/Help_button.png</file>
<file>./HelpFiles/Menus/Help_Menu/Help_Menu.html</file>
<file>./HelpFiles/Menus/Help_Menu/Help_Menu.png</file>
<file>./HelpFiles/Menus/Help_Menu/Help_Search.png</file>
Expand Down Expand Up @@ -160,17 +161,18 @@
<file>./HelpFiles/Workbench_Window/Tooltip/Tooltip.html</file>
<file>./HelpFiles/Workbench_Window/Tooltip/Tooltip.png</file>
<file>./HelpFiles/Workbench_Window/Viewing_Area/Viewing_Area.html</file>
<file>./HelpFiles/Workbench_Window/Viewing_Area/Workbench_Window_1.jpg</file>
<file>./HelpFiles/Workbench_Window/Viewing_Area/WBwindow_Horiz_Labels.png</file>
<file>./HelpFiles/Workbench_Window/Viewing_Tabs/Viewing_Tabs.html</file>
<file>./HelpFiles/Workbench_Window/Viewing_Tabs/Viewing_Tabs.png</file>
<file>./HelpFiles/Workbench_Window/WBwindow_Horiz_Labels.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Features_TB_icon.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Help_button.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Information_icon.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Overlay_TB_icon.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Scenes_icon.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Toolbar_icon.png</file>
<file>./HelpFiles/Workbench_Window/Window_Elements_Hide-Show_Buttons/Window_Elements_Hide-Show_Buttons.html</file>
<file>./HelpFiles/Workbench_Window/Workbench_Window.html</file>
<file>./HelpFiles/Workbench_Window/Workbench_Window_1.jpg</file>
<file>./LayersPanel/colorbar.png</file>
<file>./LayersPanel/construction.png</file>
<file>./LayersPanel/wrench.png</file>
Expand Down

0 comments on commit dfd2086

Please sign in to comment.