Skip to content

Instantly share code, notes, and snippets.

@mattshepherd

mattshepherd/apple help book example.txt

Last active November 3, 2022 13:32
Show Gist options
  • Star 11 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mattshepherd/54c66d38be90c2b1acf0 to your computer and use it in GitHub Desktop.
Save mattshepherd/54c66d38be90c2b1acf0 to your computer and use it in GitHub Desktop.
Download ZIP
To support the table of contents button in the OS X Help Book app you need to implement the following code. This isn't documented anywhere but I found it in Apple's own help files and tested it to work. I believe it only works in the more recent versions of OS X, so you if your app supports really old versions you might want to check it.
Raw
apple help book example.txt
//disable TOC button
window.HelpViewer.showTOCButton(false);
//enable TOC button
//If you call this on window load it will flash active for a brief second and then disable again.
//Call if after a delay of 250ms and is works fine
//Not sure what the second variable does yet, but passing false works fine
window.HelpViewer.showTOCButton( true, false, function() {
//do something to toggle TOC in your webpage
});
//Apple stores the status of the TOC using a window session variable, you can use this to keep the TOC open or closed
//when transitioning between pages.
window.sessionStorage.getItem("toc");
@jayMcBee
Copy link

Also: In order to enable the Share menu - specifically to enable users printing a user guide - the HPDBookRemoteURL must be specified and set to a copy of the Resources folder on your server

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment