时间戳

首页 > 解决方案 > 在 2019 年创作 Apple 帮助手册

ios - 在 2019 年创作 Apple 帮助手册

问题描述

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

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

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

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

任何帮助表示赞赏！

标签： iosswiftxcodemacos

解决方案

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

  1. 在项目文件夹中创建一个名为MyAppHelp;
  2. 在后一个文件夹中创建一个名为Contents的文件夹；
  3. 在此文件夹中，您应该创建以下内容：
  • Info.plist
  • PkgInfoBNDLhbwr包含里面的文字
  • 一个文件夹叫Resources

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

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

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

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

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

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

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

  4. 最后，不要忘记在您的应用程序中添加一个Help Book directory name和Help Book identifier键info.plist来告诉操作系统您的帮助手册是如何被调用或被识别的。

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

推荐阅读