CodeChargeMVP
Posts: 473
|
| Posted: 03/15/2011, 5:06 AM |
|
Hi,
I´m wondering about the best way to develop the help section on our application,
We already have all the help section tree done, with all the html pages.
I mean about the integration in the application,
I´ve been thinking about an link icon help floating besides the forms so when the user click
on it the help pop-ups.
So the question is
¿what´s the best way to get sucess on this issue?
¿How have you integrate the help section on your software applications?
Thank you very much in advance.
_________________
Best Regards
Entrepeneur | NT Consultant
|
cvboucher
Posts: 191
|
| Posted: 03/18/2011, 10:01 AM |
|
Here's what I did in one application to provide context sensitive help. I put a little blue question mark image next to each field. When the user puts the mouse cursor over the image a help window pops up. When they move the mouse cursor off the image, the help window closes. Or they can click on the help image to keep the window open. Below is how I implemented it.
1. Downloaded the ajax-tooltip from dhtmlgoodies.com and included it in the /js folder of my application (http://www.dhtmlgoodies.com/index.html?whichScript=ajax-tooltip).
2. Added the following following to my header .html file that is included on every page.
<script type="text/javascript" src="js/ajax-dynamic-content.js"></script>
<script type="text/javascript" src="js/ajax.js"></script>
<script type="text/javascript" src="js/ajax-tooltip.js">
//DEL /************************************************************************************************************
//DEL (C) www.dhtmlgoodies.com, June 2006
//DEL
//DEL This is a script from www.dhtmlgoodies.com. You will find this and a lot of other scripts at our website.
//DEL
//DEL Terms of use:
//DEL You are free to use this script as long as the copyright message is kept intact. However, you may not
//DEL redistribute, sell or repost it without our permission.
//DEL
//DEL Thank you!
//DEL
//DEL www.dhtmlgoodies.com
//DEL Alf Magne Kalleland
//DEL
//DEL ************************************************************************************************************/
</script>
and
<script language="JavaScript" type="text/javascript">
function callHelp(fieldCode)
{
var helpPage = "help.aspx?FieldCode="+fieldCode
window.open(helpPage,'HelpWindow','height=250,width=400,toolbar=no,resizable=yes,scrollbars=yes,location=no,directories=no,status=no,menubar=no,copyhistory=no')
}
//End CCS script
</script>
3. Created a help table consisting of two fields, a help code (FieldCode in my application) and the help text.
4. Created a grid and record for entering the help text. I used the FCKEditor on the help text so I could include formatting and images.
5. Created a record for displaying the help (help.aspx in my application) with a label for the help text and set its Content to HTML.
6. For each place I wanted context sensitive help I put a little blue question mark image and populated three events.
onmouseover:ajax_showTooltip('help.aspx?FieldCode=CustomersetupPrimaryFeedback', this);return false
onmouseout:ajax_hideTooltip()
onclick:callHelp('CustomersetupPrimaryFeedback')
HTH,
Craig
|
