Feature: Need to offer Apple style helpbook integration for macOS #47

TinyJS 0.50.1
macOS 27.0 Golden Gate M1

I have found that helpbook use with apps can be done manually but some code changes in the app build would allow the process to be rather seamless and also be integrated prior to signing, etc.

Details:

My helpbook bundle is called 'Example Help' - some changes to cli.js are required and then a rebuild of binaries.

First create a Resources folder in the project root which will be the folder to hold any files/bundles taht the dev wishes to build into the Resources folder of the app bundle.

Source amendments:

cli.js -

L1894 +    await run(['cp', '-R', 'Resources/', APP + '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/Contents/Resources']);  // any file/bundle in Resources of project root will be copied to Resources of app bundle


L1931 +    if (cfg.helpbook) {
             // Inserts 2 keys required for helpbook use
             extraKeys += `
             CFBundleHelpBookFolder   ${escXml(cfg.helpbook)}
             CFBundleHelpBookName   ${escXml(cfg.helpbook)}`;
L1936 +    }


L2075 +    CFBundleShortVersionString         ${escXml(cfg.shortVersion || '0.1')}     // shortversion used for helpbook cache entries

Project folder:

tinyjs.json -

"shortVersion": "7.3",
"helpbook": "Example Help"

Note: addition of L1894 probably means that L1981 ~ 1983 can be removed as Credits.html if being used can also be placed into the project Resources folder. This would also broaden the credits file to Credits.rtf which is also valid for macOS and any other custom files that a dev doesn't want in the app folder can be placed in the Resources folder.

This request means that the menu Help search can be used as intended.

Attached is a sample help folder that should work OK and contains some info about help bundles.

Example Help.zip

BTW Boo is excellent!