2019 年编写 Apple 帮助手册

Question

我试图在我的 Mac OS 应用程序中包含帮助手册，但我无法这样做。当我单击应用程序中的“帮助”菜单时，会出现搜索栏和“帮助”菜单项，但出现“内容当前不可用”错误。

我试过使用 Jekyll，但我无法让它工作。我还参考了 Apple Help Book 文档，但很难理解。我还阅读了 StackOverFlow 上的帖子，但目前似乎都没有。

我只需要一个简单的帮助手册，其中显示我的应用程序名称并显示“这是我的应用程序”。

我需要帮助来理解帮助手册目录结构、标题 HTML 内容以及如何使用 info.plist 将其集成到我的应用程序中。

任何帮助表示赞赏！

Answer 1

我希望您不会仅仅为了对您的用户说“这是我的应用程序”而编写帮助手册，而是将其作为一本严肃的帮助手册的起点，它可以帮助您的用户了解如何做到最好使用您的应用程序。如果是这样，这就是我所做的：

1. 在您的项目文件夹中创建一个文件夹，名为MyAppHelp;
2. Contents在后一个文件夹中创建一个名为的文件夹；

3. 在此文件夹中，您应该创建以下内容：

   • 信息表
   • 一个文件夹叫 Resources

因此，你应该有一个这样的结构：

MyAppleHelp/
    Contents/
       Info.plist
       Resources/
           en.lproj/
              index.html
           fr.lproj/
              index.html

然后，您可以像任何网站一样开始编辑您的帮助手册，使用HTML和css。您甚至可以在您的网站和帮助手册之间共享一些代码。这种结构还允许您将帮助手册本地化为不同的语言。macOS 将自动向用户显示它的正确版本。

要了解您应该在帮助手册内的 info.plist 中使用哪些键，请在此处查看它们。

4. 您应该使用 Apple 自己的Help Indexer应用程序为您的 Apple 帮助手册编制索引，您可以从 developer.apple.com 上的帐户下载该应用程序（Additional tools for Xcode在下载中查找“ ”）。这将.helpindex在您创建的每个文件夹中创建文件Contents，这将帮助您的用户在您的帮助手册中进行搜索。重要更新：不过，从 Mojave 开始，您必须使用hiutilCLI 实用程序在 Spotlight 帮助索引中索引您的帮助页面。这些文件将.cshelpindex改为具有扩展名。

5. 您应该将顶级文件夹的名称从MyAppHelp更改为MyApp.help。当您使用扩展名 .app 重命名顶级文件夹时，这将创建一个类似于文件夹的包。

6. 要将任何更改自动包含到您的应用程序中，您应该将帮助手册添加到copy bundle resources构建阶段。

7. 最后，不要忘记Help Book directory name在info.plist您的应用程序的帮助手册中添加一个密钥，以告诉操作系统如何调用您的帮助手册。

祝您 Apple Help Book 创作顺利。