Chm Help filenames with dot not allowed?

Please post all questions and comments regarding Help & Manual 7 here.

Moderators: Alexander Halser, Tim Green

Post Reply
Horst Reichert
Posts: 77
Joined: Tue May 25, 2004 12:54 pm

Chm Help filenames with dot not allowed?

Unread post by Horst Reichert » Tue Sep 29, 2015 8:49 am

I need to update a project for supporting my Delphi components for Embarcadero RAD Studio 8 and 10.
As these environments switched over from Microsoft VStudio Help to Web Help (chm) I need to alter my pages accordingly:
--------------------------------------------------------------------- from Embarcadero documentatio -------------------------------------------------------
You need to add the fully-qualified name as title. It is very important that the title included between the <Title></Title> HTML tags is the fully-qualified name that describes the content of such file, such as: <Title>UnitName.ClassName.MethodName</Title>.
Warning: The title included between the <Title></Title> HTML tags must be fully qualified, otherwise the help may not link to the right file when F1 is pressed.
----------------------------------------------------------------------------------------------------------------------------------------------------------------------
But as I see H&M7 does replace the dots used in the topic names with underscores. This results in a malfunction using <F1> to retrieve the correct information on my component properties.
How can I come around this problem?

User avatar
Tim Green
Site Admin
Posts: 21691
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: Chm Help filenames with dot not allowed?

Unread post by Tim Green » Tue Sep 29, 2015 9:55 am

Hi Horst,

A CHM topic ID that contains special characters like dots, spaces and a number of other characters is invalid and simply will not work. That is one of the many restrictions of the ancient Microsoft CHM system. (Actually, Windows itself doesn't really support them either, but current versions do a lot of acrobatics to make it look as though it does.)

It is fine if the *title* that the user sees contains dots and any other characters. The only things you need to change are the topic IDs that the user does not normally see, which are used for actually accessing the topics (they are converted into the internal topic filenames inside the CHM, which is an archive format).

You can edit the topic IDs in the Topic Options tab (upper left of the editor window). All references to the topic within the project will be updated automatically when you do this. Any external references (context calls etc) must be updated externally, of course. You will probably need to export a new map file for your references after updating the topic IDs.
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.

Horst Reichert
Posts: 77
Joined: Tue May 25, 2004 12:54 pm

Re: Chm Help filenames with dot not allowed?

Unread post by Horst Reichert » Tue Sep 29, 2015 11:56 am

You can edit the topic IDs in the Topic Options tab (upper left of the editor window). All references to the topic within the project will be updated automatically when you do this.
That is what I already did! I was not mentioning the title but the TopicIDs (Embarcadero names them titles) which dots are converted by H&M7 to underscores.
This causes the Errors with Embarcadero Studio.
Any further hints?

Horst Reichert
Posts: 77
Joined: Tue May 25, 2004 12:54 pm

Re: Chm Help filenames with dot not allowed?

Unread post by Horst Reichert » Tue Sep 29, 2015 12:23 pm

OK I figured it out...
...I had to enter the fully qualified Name as Topic.

Post Reply