General settings

General settings are used to view and modify general information for the helpbook. This includes:

• The bundle Id (if targeting Apple Help). This will generally be you app’s bundle Id with the suffix .help. For example, if your app’s bundle Id is com.mycompany.myapp, the bundle Id for the help bundle will likely be com.mycompany.myapp.help. If you will not be creating a help bundle, this is not necessary,

• The Help icon, which is a special image that is used to represent your help content. For best results, it should be a small, square image no greater than 128x128 pixels, though other size will work.

• It is the icon that is displayed for your content in the Apple Help Viewer search results

• It is represented by a variable called BundleIcon, which can be inserted into your help content. 

• Whether or not your pages include a common  header and footer

• Which localizations your help book contain. Any localizations not checked in the general settings are inactive, and will not be included when you generate your help content.

To add a new localization:

• Press the + button

• Select a localization from the menu

• Enter the Help title for the new localization. The Apple Help viewer uses the Help title shown here when it displays your help content. You can also enter the Help title in the  structure pane  of the main view.

To remove a localization:

• Select the localization you wish to remove

• Press the - button

  Note that your must always have at least one localization.

Copyright © 2015 - 2022  Putercraft LLC

Still need help? Please  email  us with any questions .