Retired Document
Important: This document may not represent best practices for current development. Links to downloads and other resources may no longer be valid.
Help Book Caching During Software Development
Q: While developing my application, Help Viewer suddenly stopped displaying the help content. I confirmed that my content is inside my bundle, and the necessary property list keys are set. What's wrong?
A: While developing my application, Help Viewer suddenly stopped displaying the help content. I confirmed that my content is inside my bundle, and the necessary property list keys are set. What's wrong?
In development situations, it is not unusual for an Xcode project or built product to be moved around on the filesystem frequently. If this happens, the Help Viewer will load up with the assumption that the content is in place because there is an entry for your help content both in its cache, and in the Help Viewer preferences located at ~/Library/Preferences/com.apple.help.plist
. If the content files are no longer where the cache says they are, it is possible for Help Viewer to simply display nothing on Mac OS X 10.3 and earlier.
This is not a common occurence, but it is possible in development situations if multiple copies of a given project exist in different places, or if entirely different projects specify the same CFBundleHelpBookName
. Deployment situations, where a single copy of an application is installed, and likely not moved, are much less prone to this problem.
If you find yourself in this situation, it can most likely be solved by deleting the ~/Library/Caches/com.apple.helpui
folder, which contains the most recent Help Viewer cache information. The next time HelpViewer is launched, a new cache will be constructed using the information taken from the preferences, which should be up-to-date, since it is revised every time a given application is launched.
Developers receiving similar reports from end-users can refer them to Mac OS X: Can't access Help content, or content is blank or missing links, from the Apple support website.
Document Revision History
Date | Notes |
---|---|
2005-03-30 | New document that development situations that can potentially confuse Help Viewer |
Copyright © 2005 Apple Computer, Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2005-03-30