在 2019 年创作 Apple 帮助手册

Posted 2023-03-11

【中文标题】在 2019 年创作 Apple 帮助手册

【英文标题】：Authoring Apple Help Book in 2019

【发布时间】：2019-08-21 13:44:04

【问题描述】：

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

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

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

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

感谢任何帮助！

【参考方案1】：

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

在您的项目文件夹中创建一个名为 MyAppHelp 的文件夹； 在后一个文件夹中创建一个名为Contents 的文件夹； 在此文件夹中，您应该创建以下内容：

Info.plist PkgInfo 里面包含文字BNDLhbwr 名为Resources 的文件夹

因此，您应该有这样的结构：

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

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

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

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

您应该将顶部文件夹的名称从 MyAppHelp 更改为 MyApp.help。当您使用扩展名 .app 重命名***文件夹时，这将创建一个类似于文件夹的包。 从 Monterey 开始，您的帮助包中必须有一个 PkgInfo 文件才能被 Finder 识别。

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

最后，不要忘记在应用的info.plist 中添加Help Book directory name 和Help Book identifier 键，以告知操作系统如何调用或识别您的帮助手册。

祝您的 Apple 帮助手册创作顺利。

【讨论】：

非常感谢！我明天试试这个。大多数教程已经过时了。

见我的观点 7. 您还需要在主应用程序的 info.plist 中添加一个键。否则这是行不通的。

是的。谢谢。我得到了它。我删除了整个内容并重新开始。

好问题和好答案。谢谢。不过我不得不问，截至 2020 年 3 月，有没有更新的方法？

@DavidDelMonte 不。唯一需要的更新是我在第 4 点给出的更新。其余的仍然有效。