Tk Source Code

View Ticket
Login
2024-11-05
14:41 Ticket [bb110c70] cannot build .chm help file (Windows) status still Closed with 5 other changes artifact: 062a2b62 user: msoyka
08:25 Ticket [bb110c70]: 5 changes artifact: 9091e388 user: jan.nijtmans
08:00 Ticket [bb110c70]: 6 changes artifact: 982e17a2 user: oehhar
2024-11-04
21:11
(cherry-pick): Handle non-zero exit code from hcc command (see [bb110c70d1]) check-in: efc4e27d user: jan.nijtmans tags: core-8-branch
21:08 Closed ticket [bb110c70]: cannot build .chm help file (Windows) plus 6 other changes artifact: 56e9c673 user: jan.nijtmans
21:05
Handle non-zero exit code from hcc command (see [bb110c70d1]) check-in: 70f89189 user: jan.nijtmans tags: trunk, main
08:24
(cherry-pick): Fix [bb110c70d1]: cannot build .chm help file (Windows) check-in: a9a3b0d4 user: jan.nijtmans tags: core-8-branch
08:22
Fix [bb110c70d1]: cannot build .chm help file (Windows) check-in: f303d8e0 user: jan.nijtmans tags: trunk, main
00:27 Ticket [bb110c70] cannot build .chm help file (Windows) status still Open with 3 other changes artifact: 59a77c6a user: msoyka
2024-11-03
17:43 Ticket [bb110c70]: 4 changes artifact: 40f9642e user: jan.nijtmans
17:40
Fix for [bb110c70d1]: cannot build .chm help file (Windows) (from msoyka, slightly modified) Closed-Leaf check-in: 11b60316 user: jan.nijtmans tags: bug-bb110c70d1
2024-11-02
17:48 Ticket [bb110c70] cannot build .chm help file (Windows) status still Open with 3 other changes artifact: 1834421b user: fvogel
14:54 Add attachment Tcl9_makefiles.zip to ticket [bb110c70] artifact: 8ff5f6cd user: msoyka
14:35 Delete attachment "makefile.vc" from ticket [bb110c70] artifact: 0c0d130b user: msoyka
14:25 Add attachment makefile.vc to ticket [bb110c70] artifact: 4858d201 user: msoyka
14:01 Add attachment makefile.vc to ticket [bb110c70] artifact: 43dacb73 user: msoyka
13:59 Delete attachment "makefile.vc" from ticket [bb110c70] artifact: f7a6f2ba user: msoyka
13:58 Add attachment makefile.vc to ticket [bb110c70] artifact: e1b80a1a user: msoyka
13:39 Ticket [bb110c70] cannot build .chm help file (Windows) status still Open with 3 other changes artifact: 1c30254e user: fvogel
13:05 Ticket [bb110c70]: 3 changes artifact: d7016c24 user: msoyka
01:11 New ticket [bb110c70]. artifact: 73bb7af3 user: msoyka

Ticket UUID: bb110c70d1b5866a3dad6d7899d97bca818143d9
Title: cannot build .chm help file (Windows)
Type: Bug Version: 9
Submitter: msoyka Created on: 2024-11-02 01:11:45
Subsystem: 85. Win Build Assigned To: jan.nijtmans
Priority: 5 Medium Severity: Minor
Status: Closed Last Modified: 2024-11-05 14:41:22
Resolution: Fixed Closed By: msoyka
    Closed on: 2024-11-05 14:41:22
Description:
Makefile.vc creates the HTML help files with a .html extension but the "inline file" code in makefile.vc lists them with a .htm extension and so the Microsoft Help Workshop cannot find them.

In addition, the file contents.htm is also listed but perhaps should be listed as index.html instead.
User Comments: msoyka added on 2024-11-05 14:41:22:
I can't help with the missing Inventory and Keywords tabs.  I know next to nothing about the Workbench product and my copy of the Workbench IDE does not list all the possible options, contrary to what we'd expect from an IDE.  I defer to Ashok on this feature.

jan.nijtmans added on 2024-11-05 08:25:57:

> the Tabs (on the left side) for Inventory and Keywords are missing.

Any idea how to add those?


oehhar added on 2024-11-05 08:00:19:

Thank you for looking into this. For me, a Tk target "htmlhelp" is not required, as TCL builds the unified TCL/Tk help file. The now generated help file has the start page correctly. Nevertheless, the Tabs (on the left side) for Inventory and Keywords are missing. Ashok had them in his help file and I find them quite handy.

Anyway, great work !

Harald


jan.nijtmans added on 2024-11-04 21:08:28:

> There is one other difference between the Tcl and Tk makefile behaviors when they invoke hhc.exe. The return code from hhc is zero for the Tcl version but the Tk version returns the status one. In the latter case, nmake interprets it as an error and will terminate by default. Even so, the .chm file appears to be okay.

[70f8918985dadb71|this] should help

Closing


msoyka added on 2024-11-04 00:27:21:
Your patch works but will be complete if you add the HHP option "Full-text search=Yes" to the Tk makefile.  This option is already present in the Tcl makefile.

This option creates the toolbar above the documentation pane and also creates a topic-search pane to the left of the documentation pane.  

The toolbar contains the choices "Show/Hide", "Back", "Print" and "Options".  The "Show/Hide" button is used to show or hide the search-topic pane.  This is important because I have found that the first time that Tk .chm is launched, the search-topic pane is not visible and the "Show/Hide" button is labeled "Show".  For unknown reasons, the Tcl makefile, with corrections, does show the search-topic pane by default.  This is a minor nit because once the search-topic pane is displayed, that choice is recorded somewhere, perhaps in the Registry.

There is one other difference between the Tcl and Tk makefile behaviors when they invoke hhc.exe.  The return code from hhc is zero for the Tcl version but the Tk version returns the status one.  In the latter case, nmake interprets it as an error and will terminate by default.  Even so, the .chm file appears to be okay.

jan.nijtmans added on 2024-11-03 17:43:34:

@msoyka, does [11b60316ae833198|this] work for you? (If it works for Tk, I will have a look at Tcl too)


fvogel added on 2024-11-02 17:48:30:
@ashok, would you be so kind to have a look please?

fvogel added on 2024-11-02 13:39:09:
There is an "Attach" button on top of the ticket page, you can use it to provide a patch. Thanks!

msoyka added on 2024-11-02 13:05:32:
I neglected to mention that the file makefile.vc is in the Tcl distribution.  The htmlhelp target in the Tk distribution's makefile.vc is also broken in somewhat the same way but has some additional problems.

I have a fix for the Tk makefile but don't know how to provide it to you since the ticket system doesn't seem to support patches.

Attachments: