[TC10.50b6] Help Index - Unintentionally created sub-keywords

[white]

Currently in Help Index:

Code: Select all

Decode file (MIME
	UUE,XXE,BinHex)
...
Encode file (MIME
	UUE,XXE)
...
Mark newer
	hide same

Intended result:

Code: Select all

Decode file (MIME,UUE,XXE,BinHex)
...
Encode file (MIME,UUE,XXE)
...
Mark newer, hide same

TC uses HelpScribble to create the Help file. This means you cannot use comma and semicolon in keywords for the index because these have special meaning.

Separate keywords with a semicolon. Separate sub-keywords from their main keywords with a comma.

HelpScribble doesn't seem to have an escape character or other solution. So I don't think there is an easy solution while still using HelpScribble.

A solution can be to use a replacement string, for example "((comma))", and create a program HHC.EXE (that launches a script) that replaces "((comma))" with "," in the .hhk file and html\*.htm files in the temp folder, before launching the real HHC.EXE to compile the Help.

[white]

Currently in Help Index:

Code: Select all

Mark newer
	hide same

In the German help the index entry for the page "Neue markieren, gleiche verstecken" is:

Code: Select all

Neue markieren

So ", gleiche verstecken" was simply left out for the keyword.

[ghisler(Author)]

I'm not using HelpScribble directly - I'm using a very old help editor, ForeHelp, to create HLP files. Then I use HelpScribble to import the help project and build the CHM file. I could drop ForeHelp and move completely to HelpScribble, but then I could no longer offer HLP files.

So the only solution would be to replace the comma in help index entries in ForeHelp with a different character - but what character?

[white]

So the only solution would be to replace the comma in help index entries in ForeHelp with a different character - but what character?

It's not the only solution. I already gave a solution. If you need more info, let me know.

Maybe you can also ask HelpScribble if they have a solution for you. Perhaps they can implement an escape character or give another solution.

Alternatively, perhaps you could use different software to create the .chm files that doesn't have this problem.

[white]

So the only solution would be to replace the comma in help index entries in ForeHelp with a different character - but what character?

How about:

Code: Select all

Decode file (MIME/UUE/XXE/BinHex)
...
Encode file (MIME/UUE/XXE)
...
Mark newer & hide same

[ghisler(Author)]

That's a good solution, I will use it. But I will use "Mark newer - hide same" because the & can also cause problems in xml files.

[white]

That's a good solution, I will use it. But I will use "Mark newer - hide same" because the & can also cause problems in xml files.

Well, you already have "Drag & Drop" as keyword.

[white]

So the only solution would be to replace the comma in help index entries in ForeHelp with a different character - but what character?

How about:

Code: Select all

Decode file (MIME/UUE/XXE/BinHex)
...
Encode file (MIME/UUE/XXE)
...
Mark newer & hide same

That's a good solution, I will use it. But I will use "Mark newer - hide same" because the & can also cause problems in xml files.

Tested TC10.50b7.

• It is changed this way in the Help Search results, where it wasn't a problem. Screenshot
• The Help Index entries are now cut off and 2 extra entries "Encode" and "Decode" are added. And two Index entries point to the wrong page. "Decode" leads to the help page "Encode file (MIME,UUE,XXE)" and "Encode file" leads to the help page "Decode file (MIME, UUE, XXE, BinHex)". Screenshot

[ghisler(Author)]

It is changed this way in the Help Search results, where it wasn't a problem. Screenshot

Yes, for consistency I changed the , to / there too.
I will check why the links are reversed.

[white]

It is changed this way in the Help Search results, where it wasn't a problem. Screenshot

Yes, for consistency I changed the , to / there too.

The Index entries are now cut off, so no longer contain , or /. So consistent with what? It's the only place where it changed or not?

[white]

Tested OK using TC10.50b8 German and English help file.

Moderator message from: white » 2022-06-01, 23:15 UTC

Moved to Fixed bugs.