HTML Help not showing

Slogging on… this time I stumble over the HTML help. I defined a HTML Help file for the module. The Contents path is visible in the node properties panel when I select it; it reverts to “null” the next time I open the HTML Help File node, but that may be normal as I still find the expected contents in the module file as a zipped file inside the “help” folder after I saved the module.
Problem: The menu shows in the module, but does nothing; I get no error message. The log shows where the problem is (BTW; is there a way to clear the log short of re-starting VASSAL?): When I choose the Help menu, VASSAL complains (FileNotFound exception) that it does not find one of the images on the start page in the path
/var/folders/_t/8f5l5jy1515458bh6wlt5d3h0000gn/T/VASSAL/help/Advanced_Civ_Module_Help
The folder in fact exists, but it is completely empty. So, for some reason VASSAL could create the folder (in fact it used the same folder thoroughout today’s experiments) but did not expand the help content into it. When I copy the help content into the folder manually, everything works as expected. This means, as far as I can see, that VASSAL either does not try to expand the help content into the folder or, more likely, it tries but fails without creating an error log entry.

Has anyone any idea what could be wrong? What else could I try to isolate the source of the problem?
Environment: MacOS 10.11.6, VASSAL 3.2.17

1 Like

Thus spake PunTheHun:

Slogging on… this time I stumble over the HTML help. I defined
a HTML Help file for the module. The Contents path is visible in
the node properties panel when I select it; it reverts to “null”
the next time I open the HTML Help File node, but that may be
normal as I still find the expected contents in the module file as
a zipped file inside the “help” folder after I saved the module.
Problem: The menu shows in the module, but does nothing; I
get no error message. The log shows where the problem is (BTW; is
there a way to clear the log short of re-starting VASSAL?): When I
choose the Help menu, VASSAL complains (FileNotFound exception) that
it does not find one of the images on the start page in the path
/var/folders/_t/8f5l5jy1515458bh6wlt5d3h0000gn/T/VASSAL/help/Advanced_Ci
v_Module_Help The folder in fact exists, but it is completely empty.
So, for some reason VASSAL could create the folder (in fact it used the
same folder thoroughout today’s experiments) but did not expand the help
content into it. When I copy the help content into the folder manually,
everything works as expected. This means, as far as I can see, that
VASSAL either does not try to expand the help content into the folder
or, more likely, it tries but fails without creating an error log entry.

Has anyone any idea what could be wrong? What else could I try to
isolate the source of the problem? Environment: MacOS 10.11.6, VASSAL
3.2.17

Have you tried adding the HTML file, saving the module and closing it,
reopening the module, and then checking the HTML help you added?


J.


messages mailing list
messages@vassalengine.org
vassalengine.org/mailman/listinfo/messages

This is really weird.
I experienced the same problem when developing a module and extensions.
HTML Help Files were not properly unzipped: folder created, HTML file unzipped there, but folder containing the resources for the HTML folder (css, icons…) was not there.

I have tried many different things (apart from checking the code myself).
Finally I got it working by following this procedure:

  • Create the HTML Help File using VASSAL Editor.
  • Manually unzip the vmod or vmdx files.
  • Manually zip the HTML file and resources folder used to display the web page and icons.
  • replace the zip file in the /help folder with the one manually created.
  • Manually zip again the vmod or vmdx files.

Now it works!
Do not ask me why.

Maybe something is funny with the built-in zipper?