Click here to Skip to main content
15,895,283 members
Articles / Web Development / HTML

Providing Web Applications with Context Sensitive Help Using RoboHelp WebHelp

Rate me:
Please Sign up or sign in to vote.
5.00/5 (2 votes)
23 Apr 2008CPOL11 min read 72.9K   1.5K   17  
This article shows how to implement context sensitive help for your ASP.NET web applications using RoboHelp WebHelp.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>Popup WebHelp Links</title>

<style>
<!--  
h1    { font-family: Verdana; font-size: 14px; color: "darkslateblue"; font-weight: bold }  
h2           { font-family: Verdana; font-size: 14px; color: RGB(25, 25, 112); font-weight: bold }  
h3           { font-family: Verdana; font-size: 12px; color: "black"; font-weight: bold }  

body
{
	font-family: Verdana; 
	font-size: 12px; 
} 

.code
{
	font-family:  Courier New;
	display:block;
	Color:Blue;
	font-size: 13px;
}

--> 


</style>
</head>

<script  type="text/javascript" language=JavaScript1.2 src="RoboHelp_CSH.js">

</script> 



<body>

<b></b>


<h2>You can specify parameters to show help with different tabs as default.</h2>
	
	<h3>Display Contents Tab by Default</h3>

	<div class="code">
	&lt;A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm", <strong>HH_HELP_CONTEXT</strong>,
	0)'&gt;Show Help with &lt;b&gt;Contents&lt;/b&gt; Tab&lt;/a&gt;
	
	</div>
	
	<p>
		<A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm", HH_HELP_CONTEXT, 0)'>Show Help with <b>Contents</b> Tab</a>
	</p>

	<h3>Display Search Tab by Default</h3>

	<div class="code">
	&lt;A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm", <strong>HH_DISPLAY_SEARCH</strong>,
	0)'&gt;Show Help with &lt;b&gt;Search&lt;/b&gt; Tab&lt;/a&gt;
	</div>

	<p>
		<A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm", HH_DISPLAY_SEARCH, 0)'>Show Help with <b>Search</b> Tab</a></p>


	<h3>Display Index Tab by Default</h3>

	<div class="code">

	&lt;A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm", <strong>HH_DISPLAY_INDEX</strong>,
	0)'&gt;Show Help with &lt;b&gt;Index&lt;/b&gt; Tab&lt;/a&gt;
	</div>
	
	<p>
		<A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm", HH_DISPLAY_INDEX, 0)'>Show Help with <b>Index</b> Tab</a></p>


	<hr />

	<h1>Specifying Help Topic by Context Number</h1>

	
	<h2>
		You can specify a specific help topic by number</h2>
<p>In this case, topic 2.  However, mapping web pages to help topic IDs is cumbersome.</p>
	<div class="code">
		&lt;A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm<strong>&gt;First</strong>",
		HH_HELP_CONTEXT, <strong>2</strong>)'&gt;Link Here&lt;/a&gt;
	</div>


<p>
<A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm>First", HH_HELP_CONTEXT, 2)'>Popup Specifying a page by context number.</a>
</p>

	<p>
		Note the "&gt;First" tag which specifies the type of window to open.  In this case, it is supposed to show the navigation panel, but it doesn't work.</p>


<h2>You can suppress the navigation pane in the popup window.</h2>

	<div class="code">


	&lt;A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm<strong>&gt;SecondWindow</strong>",
	HH_HELP_CONTEXT, 1)'&gt;Link Here&lt;/a&gt;</div>
	<p>
		<A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm>SecondWindow", HH_HELP_CONTEXT, 1)'>Popup without Navigation</a></p>
	<p>
		Note the "&gt;SecondWindow" tag which specifies that the window should be opened
		without the navigation bar.</p>

	<div class="code">
	
		&lt;A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm&gt;<strong>MainWindow</strong>",
		HH_HELP_CONTEXT, 1)'&gt;Sample Opening in MainWindow&lt;/a&gt;
	</div>
	
	<p>
	<A HREF='javascript:RH_ShowHelp(0, "WebHelp/Webhelp_Demo.htm>MainWindow", HH_HELP_CONTEXT, 1)'>Sample Opening in MainWindow</a></p>
	<p>
		Note the "&gt;MainWindow" tag which specifies that the window should be opened without
		the navigation bar.</p>
	

<h2>Display Context Sensutive Help in a New Window</h2>

<p>
To eliminate the problems with popups, the best solution is to display the help in a new browser window.
</p>

<div class="code">
	
	&lt;a href="WebHelp/Webhelp_Demo.htm#Topic1.htm" target="_new" &gt;New Window Link&lt;/a&gt;
</div>
	<p>
<a href="WebHelp/Webhelp_Demo.htm#Topic1.htm" target="_new" >New Window Link</a>    
	</p>


<h2>Links for WebHelp Bugs</h2>


<p>
<a href="http://www.grainge.org/pages/authoring/browsers/browsers.htm">RoboHelp Browser Issues</a>
</p>



</body>
</html>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
President Starpoint Software Inc.
United States United States
Bob Pittenger is founder and President of Starpoint Software Inc. He holds a B.A. degree from Miami University, M.S. and Ph.D. degrees from Purdue University, and an MBA from Xavier University. He has been programming since 1993, starting with Windows application development in C++/MFC and moving to C# and .NET around 2005 and is a .NET Microsoft Certified Professional Developer.

Bob is the author of two books:
Billionaire: How the Ultra-Rich Built Their Fortunes Through Good and Evil and What You Can Learn from Them
and
Wealthonomics: The Most Important Economic and Financial Concepts that Can Make You Rich Fast.
Visit http://www.billionairebook.net for more information.

Comments and Discussions