【问题标题】:Apple Help Book – Linking styles and Scripts likeApple 帮助手册 – 链接样式和脚本,例如
【发布时间】:2018-02-19 12:36:17
【问题描述】:

我想知道是否有一些 Apple 帮助手册的模板。

由于我不是专业的程序员,但是,我偶然发现了制作苹果帮助书。首先,我对the apple help documentation quality 感到惊讶。 Jekyll Apple Help的作者称它为拜占庭,这正是我的第一印象。但是,我能够学习基本概念。

当我检查了 Apple 如何为他们的应用程序编写教程时,我意识到他们只使用简单的 HTML 文件,没有任何 JS 和 CSS。

所以问题是:

如何像苹果一样? 这是在苹果帮助查看器中神奇地发生的事情吗? 是否有一些隐藏的方式如何将样式和脚本链接到其他地方? 如果这是必须手动制作的东西

如果我必须处理 JS 和 CSS – 该怎么做?它是必须在 x 代码中编程的东西吗? 或者最终,有人可以为我们提供文档化的帮助手册模板吗?

【问题讨论】:

    标签: html objective-c xcode cocoa apple-help


    【解决方案1】:

    Apple 确实使用 Javascript。而且很多。例如,如果您查看他们的 Pages.app 帮助包,您会发现至少 3 个 javascript 文件。似乎这些 javascript 文件负责加载和显示 HTML 文件。所以你不会在其中找到任何 javascript。

    话虽如此,您实际上并不需要使用 javascript,除非您希望 HelpViewer 窗口上的 TOC 按钮起作用。如果你这样做了,那么你提到的Jekyll Apple Help 项目已经拥有完成这项工作所需的 javascript。

    您应该提交一份雷达,要求更新文档和示例代码。我在构建应用程序的帮助手册时确实这样做了。

    【讨论】:

    • 感谢分享见解。
    • 那么你会建议只使用 Jekyll Apple Help 吗?什么是“提交雷达要求更新文档和示例代码”?
    • 是的,我会选择 Jekyll Apple Help。填补雷达几乎是开发人员与 Apple 沟通的唯一方式。您可以在radar.apple.com 提交雷达
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2011-03-02
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多