向Cocoa App添加帮助

Question

我想在我的Cocoa应用程序中添加一个简单的单页HTML页面帮助。你能告诉我怎么做吗？我假设我只需要将一个糟糕的.html（可能还有一个.css？）文件放入Xcode的Cocoa项目中？

Answer 1

创建在帮助查看器中打开的Apple帮助文档非常简单，但您必须严格遵循文档中的说明。

帮助文件是HTML，但您需要在页面中放置几个​​特殊标记，并以特定方式命名文件。

所有这些都在the documentation中解释。

Answer 2

今天我一直面临同样的问题。我发现没有最新的howto所以这里是我自己的。帮助很好地使用了这个Step by Step to create Apple Help in your Cocoa Xcode Application。

Answer 3

如果您只想要一个HTML页面而不是正确的帮助文件，则可以将HTML文档和CSS文件添加到项目中。在编译项目时，这些将被复制到应用程序包内的应用程序的Resources目录中。要加载文档，您需要获取其地址。这实际上非常简单：

NSString *helpFilePath = [[NSBundle mainBundle] pathForResource:@"YourHelpDocumentHere" ofType:@"html"];
NSURL *helpFileURL = [NSURL fileURLWithPath:helpFilePath];

生成的URL将是WebView可以在您的应用程序中显示的文件URL，或者您可以使用NSWorkspace将其传递给操作系统，它将在用户的默认Web中打开浏览器。