473,840 Members | 1,415 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

How to create and use chm-file for online help?

Hello NG,

I am currently confronted with the task to equip a vs2005 project with
context sensitive online help (F1).
Reading through the MSDN-Library I found out about the "HelpProvid er" class,
which lets me use a chm help file for this purpose.

My question now is, how can I generate a chm file which contains my help?
Is there a way, that I can for example write my Help with word (or some
other editor) and then use (what ever) tool to generate the chm file?

I would greatly appreciate any hints and/or links to get started on this
subject.

Regards
Rainer Queck
May 7 '07 #1
7 7540
Hi Rainer,

I searched the Internet and found a 3rd party tool--Txt2Htm2Chm, that
enables you to convert text files to Windows HTML Help Project and compile
the project to CHM file.

You may visit the following link to get this tool:

http://www.softany.com/txt2htm2chm/index.htm

Hope this helps.
Sincerely,
Linda Liu
Microsoft Online Community Support

=============== =============== =============== =====
Get notification to my posts through email? Please refer to
http://msdn.microsoft.com/subscripti...ult.aspx#notif
ications.

Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at
http://msdn.microsoft.com/subscripti...t/default.aspx.
=============== =============== =============== =====

This posting is provided "AS IS" with no warranties, and confers no rights.

May 7 '07 #2
Hi Linda,

thanks for your efforts.
I took a look at your link, and it looks like a nice simple tool.
Unfortunately I need to implement graphics into my help too. Currently I am
looking at the "HTML Help Work Shop", but this looks like I have to provide
my help as html files.
Well I could get along with that, but I hope to find a more convenient tool.

Regards
Rainer
"Linda Liu [MSFT]" <v-****@online.mic rosoft.comschri eb im Newsbeitrag
news:pR******** ******@TK2MSFTN GHUB02.phx.gbl. ..
Hi Rainer,

I searched the Internet and found a 3rd party tool--Txt2Htm2Chm, that
enables you to convert text files to Windows HTML Help Project and compile
the project to CHM file.

You may visit the following link to get this tool:

http://www.softany.com/txt2htm2chm/index.htm

Hope this helps.
Sincerely,
Linda Liu
Microsoft Online Community Support

=============== =============== =============== =====
Get notification to my posts through email? Please refer to
http://msdn.microsoft.com/subscripti...ult.aspx#notif
ications.

Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at
http://msdn.microsoft.com/subscripti...t/default.aspx.
=============== =============== =============== =====

This posting is provided "AS IS" with no warranties, and confers no
rights.


May 7 '07 #3
You can create your basic XML documentation inside the codefiles for your
project, using the XML Grammar that comes with Visual Studio.

If you want a convenient helper add-in, take a look at Roland Wieget's
"GhostDoc".

Then, you would use NDOC along with the HTML Help Workshop (download from
Microsoft) to compile this into your choice of outputs - CHM is one of them,
and HTML (Web) Help is another.
Peter

--
Site: http://www.eggheadcafe.com
UnBlog: http://petesbloggerama.blogspot.com
Short urls & more: http://ittyurl.net


"Rainer Queck" wrote:
Hello NG,

I am currently confronted with the task to equip a vs2005 project with
context sensitive online help (F1).
Reading through the MSDN-Library I found out about the "HelpProvid er" class,
which lets me use a chm help file for this purpose.

My question now is, how can I generate a chm file which contains my help?
Is there a way, that I can for example write my Help with word (or some
other editor) and then use (what ever) tool to generate the chm file?

I would greatly appreciate any hints and/or links to get started on this
subject.

Regards
Rainer Queck
May 7 '07 #4
PS - the HTML Help output from NDoc provides you with Html Files you can add
images to and customize. Then you would import these files into HTML Help
Workshop, create your index and TOC, and compile to CHM with the images
included.

Also, there is a "for pay" utility called FARHTML which does all this
"automagically" .
It's not very expensive.
Peter

--
Site: http://www.eggheadcafe.com
UnBlog: http://petesbloggerama.blogspot.com
Short urls & more: http://ittyurl.net


"Rainer Queck" wrote:
Hi Linda,

thanks for your efforts.
I took a look at your link, and it looks like a nice simple tool.
Unfortunately I need to implement graphics into my help too. Currently I am
looking at the "HTML Help Work Shop", but this looks like I have to provide
my help as html files.
Well I could get along with that, but I hope to find a more convenient tool.

Regards
Rainer
"Linda Liu [MSFT]" <v-****@online.mic rosoft.comschri eb im Newsbeitrag
news:pR******** ******@TK2MSFTN GHUB02.phx.gbl. ..
Hi Rainer,

I searched the Internet and found a 3rd party tool--Txt2Htm2Chm, that
enables you to convert text files to Windows HTML Help Project and compile
the project to CHM file.

You may visit the following link to get this tool:

http://www.softany.com/txt2htm2chm/index.htm

Hope this helps.
Sincerely,
Linda Liu
Microsoft Online Community Support

=============== =============== =============== =====
Get notification to my posts through email? Please refer to
http://msdn.microsoft.com/subscripti...ult.aspx#notif
ications.

Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at
http://msdn.microsoft.com/subscripti...t/default.aspx.
=============== =============== =============== =====

This posting is provided "AS IS" with no warranties, and confers no
rights.


May 7 '07 #5
Hello Peter,
"Peter Bromberg [C# MVP]" <pb*******@yaho o.yabbadabbadoo .comschrieb im
Newsbeitrag news:95******** *************** ***********@mic rosoft.com...
Also, there is a "for pay" utility called FARHTML which does all this
"automagically" .
It's not very expensive.
Thanks for this link.
I have tried FARHTML and it looks good.

Currently I have on problem:
How can I get the right help topic selected?
I have added the HelpProvider class to my form, set the help name space, and
for testing placed controls, where I set the HelpKeyWord and HelpNavigator
(TableOfContent s in this case) for each control. But when I press F1 on
either control the help opens, but it does not select the right topic.

What am I doing wrong there?

Regards
Rainer
May 7 '07 #6
How can I get the right help topic selected?

Set:
1. HelpKeyword property to HTML file name of the topic to be opened in
your compiled CHM file, e.g. myTopic.htm
2. HelpNavigator property to "Topic".

Don't forget to specify the absolute full path to the CHM file on
program startup. Otherwise your help wouldn't work on other machines.
Note that the system doesn't look in application's folder. Use something
like:
HelpProvider1.H elpNamespace = IO.Path.Combine (appPath, "myFile.chm ");
--
Peter Macej
Helixoft - http://www.helixoft.com
VSdocman - Commenter and generator of class documentation for C#, VB
..NET and ASP .NET code
May 7 '07 #7
Hi Peter,

"Peter Macej" <pe***@helixoft .comschrieb im Newsbeitrag
news:eH******** *****@TK2MSFTNG P06.phx.gbl...
>How can I get the right help topic selected?

Set:
1. HelpKeyword property to HTML file name of the topic to be opened in
your compiled CHM file, e.g. myTopic.htm
2. HelpNavigator property to "Topic".
Great! Now it is working.
Don't forget to specify the absolute full path to the CHM file on
program startup. Otherwise your help wouldn't work on other machines. Note
that the system doesn't look in application's folder. Use something like:
HelpProvider1.H elpNamespace = IO.Path.Combine (appPath, "myFile.chm ");
Thanks for this hint too.

Regards
Rainer
May 7 '07 #8

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

2
2501
by: Luca | last post by:
I'm looking for last Smarty chm file (english) but Smarty's site is down. Does anybody can send it to me by email please? Also a link should be enought... Thank you, Luca ps: to answer NOSPAM from email address.
1
1899
by: Alvaro G Vicario | last post by:
I really love the extended CHM format documentation. However, it apparently hasn't been updated since september 2003: http://www.php.net/docs-echm.php Does anyone know something about this? Has the project died? -- -- Álvaro G. Vicario - Burgos, Spain
1
1765
by: Robert Kattke | last post by:
Using: php_manual_en.chm on Windows XP I'm trying to keep a few notes from the manual in text files. And would love to select blurbs from the .chm Encouraged by the right-click menu option, "Copy Selection to Clipboard" Unfortunately, it does not work. or Maybe just works when it wants to. Any Suggestions ?
2
3223
by: Paramjit Oberoi | last post by:
Where can I download python documentation in CHM (windows help) format? I believe the windows installers come with it, but I'm on Linux and I use CHM for easier searching/navigation. The "download documentation" page on python.org---http://docs.python.org/download.html---doesn't seem to have it. I would like to avoid downloading & unpacking the windows installer if possible. -param PS: I recommend xchm for viewing CHM files on...
6
19629
by: Wayfarer | last post by:
I Googled on Javascript CHM and came up with a couple of hits, but they were for dead links at http://developer.netscape.com/. I'd really like to have a handy Javascript CHM. Is there such a beast, and where might I get it? TIA Neill
1
5219
by: Sven Claasen | last post by:
As far as I know one could compile chm sources with the MS VisualStudio. Is there another (preferable freeware) software which let me compile chm source files? Sven
0
1699
by: Sven Claasen | last post by:
Since I upgraded Internet Explorer to 6.0 it occurs that sometimes a CHM does not show a contents. It could be started resp. opened but the content pane is empty. Why? Is there an unknown old format? Are there other, external (3rd party) tools with which I could open CHM files otherwise? Sven
3
6549
by: Ya Ya | last post by:
I have a folder with a lot of PDF and CHM files. I would like to develope an ASP.net application that enables the user to search inside the content of those files. How do I search inside those type of files ? Thanks for your time ra294@hotmail.com
2
1602
by: vbgunz | last post by:
Hello! this is the main error: http://img406.imageshack.us/img406/5218/screenshotxchmerror1ae.png navigation link images broken here: http://img406.imageshack.us/img406/2822/screenshotxchmv12python24docum.png when I first open up the docs, the main page and Global Module Index links in the tree are unaccessible. They give me errors. While
15
2637
by: John Salerno | last post by:
Hi all. I apologize since this is only remotely Python related, but I hope someone might now the solution. I tried opening my Python chm docs just now, as well as the one for wxPython, and both are giving me an error dialog when I double-click them and I can't open them. This happened apparently for no reason, just today. I even reset but that didn't help. Does anyone know what might cause this, and if it could affect the rest of...
0
10916
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
0
10598
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
1
10657
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
10299
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
1
7836
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
5684
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
5872
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
4495
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
4071
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.