Creating a help system

[Steve Teeples]

Can someone point me to a document that clearly identifies the steps of
creating a good help system for an application? I have a test tool that I'd
like to add help to so that others will know how to use it.
--
Steve

[Zach]

sing System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.IO;
using System.Runtime.InteropServices;
namespace TestTool
{

public class Help : System.Windows.Forms.Form
{
private System.Windows.Forms.RichTextBox richTextBox1;

private System.ComponentModel.Container components = null;

public Help()
{
InitializeComponent();
}

protected override void Dispose( bool disposing )
{
if( disposing )
{
if(components != null)
{
components.Dispose();
}
}
base.Dispose( disposing );
}

#region Windows Form Designer generated code

#endregion

private void Help_Load(object sender, System.EventArgs e)
{
OpenFileDialog openFile1 = new OpenFileDialog();
openFile1.FileName="handleiding.rtf";
richTextBox1.LoadFile(openFile1.FileName,RichTextB oxStreamType.RichText);
openFile1.Dispose();
}
}
}

"Steve Teeples" <St**********@discussions.microsoft.com> wrote in message
news:37**********************************@microsof t.com...

Can someone point me to a document that clearly identifies the steps of
creating a good help system for an application? I have a test tool that I'd like to add help to so that others will know how to use it.
--
Steve

[Steve Teeples]

Zach,

Thanks for the example of how to load a help system. What I need to learn
is how to create a help system. I downloaded HTML Help Workshop, but it
doesn't clearly state what steps are required to create a help system. I've
read some of its documentation but there isn't anything like Step 1, step 2,
....

Do you know of such a link that will show me exactly how to create a help
system?
--
Steve
"Zach" wrote:

sing System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.IO;
using System.Runtime.InteropServices;
namespace TestTool
{

public class Help : System.Windows.Forms.Form
{
private System.Windows.Forms.RichTextBox richTextBox1;

private System.ComponentModel.Container components = null;

public Help()
{
InitializeComponent();
}

protected override void Dispose( bool disposing )
{
if( disposing )
{
if(components != null)
{
components.Dispose();
}
}
base.Dispose( disposing );
}

#region Windows Form Designer generated code

#endregion

private void Help_Load(object sender, System.EventArgs e)
{
OpenFileDialog openFile1 = new OpenFileDialog();
openFile1.FileName="handleiding.rtf";
richTextBox1.LoadFile(openFile1.FileName,RichTextB oxStreamType.RichText);
openFile1.Dispose();
}
}
}

"Steve Teeples" <St**********@discussions.microsoft.com> wrote in message
news:37**********************************@microsof t.com...

Can someone point me to a document that clearly identifies the steps of
creating a good help system for an application? I have a test tool that

I'd

like to add help to so that others will know how to use it.
--
Steve

[Pete Lees [MVP]]

Steve,

Do you know of such a link that will show me exactly how to create
a help system?

You should find Char James-Tanny's tutorial useful. It's available from
here:

http://www.mvps.org/htmlhelpcenter/h....html#char_hhw

For information on using HTML Help with C#, see:

http://www.mshelpwiki.com/index.php?...MLHelpArticles

--
Pete (Microsoft Help MVP)

[Zach]

http://helpware.net

Matthew McDonald "User Interfaces inC#" Chapter 14.
ISBN 1-59059-045-7
Price $49.95
The book is OK, so are its examples.
You can order the book via Amazon.com.
You need such a book in your library if you are using C#.

I woud like to question whether you do really need the MS
based help system rather than what I gave you. And if you
do really need the MS based help system, maybe your
application is too complicated.

"Steve Teeples" <St**********@discussions.microsoft.com> wrote in message
news:A2**********************************@microsof t.com...

Zach,

Thanks for the example of how to load a help system. What I need to learn
is how to create a help system. I downloaded HTML Help Workshop, but it
doesn't clearly state what steps are required to create a help system. I've read some of its documentation but there isn't anything like Step 1, step 2, ...

Do you know of such a link that will show me exactly how to create a help
system?
--
Steve
"Zach" wrote:

sing System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.IO;
using System.Runtime.InteropServices;
namespace TestTool
{

public class Help : System.Windows.Forms.Form
{
private System.Windows.Forms.RichTextBox richTextBox1;

private System.ComponentModel.Container components = null;

public Help()
{
InitializeComponent();
}

protected override void Dispose( bool disposing )
{
if( disposing )
{
if(components != null)
{
components.Dispose();
}
}
base.Dispose( disposing );
}

#region Windows Form Designer generated code

#endregion

private void Help_Load(object sender, System.EventArgs e)
{
OpenFileDialog openFile1 = new OpenFileDialog();
openFile1.FileName="handleiding.rtf";
richTextBox1.LoadFile(openFile1.FileName,RichTextB oxStreamType.RichText); openFile1.Dispose();
}
}
}

"Steve Teeples" <St**********@discussions.microsoft.com> wrote in message news:37**********************************@microsof t.com...

Can someone point me to a document that clearly identifies the steps of creating a good help system for an application? I have a test tool

that I'd

like to add help to so that others will know how to use it.
--
Steve

[Steve Teeples]

Zach, I'm curious. In your posted example, are you simply loading a
richtextformat file that contains "help" topics? Is this what your example
does? That being the case, then I take it your help file contains some type
of index with links to various topics in the document?

--
Steve
"Zach" wrote:

http://helpware.net

Matthew McDonald "User Interfaces inC#" Chapter 14.
ISBN 1-59059-045-7
Price $49.95
The book is OK, so are its examples.
You can order the book via Amazon.com.
You need such a book in your library if you are using C#.

I woud like to question whether you do really need the MS
based help system rather than what I gave you. And if you
do really need the MS based help system, maybe your
application is too complicated.

"Steve Teeples" <St**********@discussions.microsoft.com> wrote in message
news:A2**********************************@microsof t.com...

Zach,

Thanks for the example of how to load a help system. What I need to learn
is how to create a help system. I downloaded HTML Help Workshop, but it
doesn't clearly state what steps are required to create a help system.

I've

read some of its documentation but there isn't anything like Step 1, step

2,

...

Do you know of such a link that will show me exactly how to create a help
system?
--
Steve
"Zach" wrote:

sing System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.IO;
using System.Runtime.InteropServices;
namespace TestTool
{

public class Help : System.Windows.Forms.Form
{
private System.Windows.Forms.RichTextBox richTextBox1;

private System.ComponentModel.Container components = null;

public Help()
{
InitializeComponent();
}

protected override void Dispose( bool disposing )
{
if( disposing )
{
if(components != null)
{
components.Dispose();
}
}
base.Dispose( disposing );
}

#region Windows Form Designer generated code

#endregion

private void Help_Load(object sender, System.EventArgs e)
{
OpenFileDialog openFile1 = new OpenFileDialog();
openFile1.FileName="handleiding.rtf";
richTextBox1.LoadFile(openFile1.FileName,RichTextB oxStreamType.RichText); openFile1.Dispose();
}
}
}

"Steve Teeples" <St**********@discussions.microsoft.com> wrote in message news:37**********************************@microsof t.com...
> Can someone point me to a document that clearly identifies the steps of > creating a good help system for an application? I have a test tool that I'd
> like to add help to so that others will know how to use it.
> --
> Steve