运行 作为 Apple 帮助手册文件的 Apple DocC
Running Apple DocC as a Apple Help Book file
随着用于从源代码生成文档的 DocC 的引入,是否可以获取 DocC 的输出并将其用作 Apple 帮助手册(用于 macOS 应用程序内部)的真实来源?
可能不会。它们是完全不同的动物。帮助手册是一个完整的网站,为某些类型的锚点提供一些帮助。 DocC 是一种非常特定类型的信息的高度受限的形式化表示。事实上,即使你将这两件事融合在一起,你也不会想要;帮助手册可以帮助用户,而 DocC 向程序员显示编程 API。
举个例子,这是我写的一本帮助书:
http://www.apeth.com/sd5help/index.html
您不可能使用 DocC 表达这一点。如果问题是您正在寻找一种工具来帮助您编写帮助书籍,那么 DocC 不是它。
Is it possible to take the output of DocC and use it as the source of truth for an Apple Help Book?
- 是的,但可能不值得。
@matt提到:
A DocC is a highly restricted, formalized representation of a very specific type of information.
不过我不同意。您可以使用 DocC 创建文章页面:Getting Started with Sloths
使用 DocC 创建 Apple 帮助手册的问题:
DocC 文档仅支持基本的 markdown 语法,因此您的格式设置选项受到限制。
DocC 将文档导出为单页 Web 应用程序,其中 Apple Help Book 期望每个帮助页面都有单独的 html 文件。所以你需要自动生成静态 html 文件。
DocC 文档不允许您添加用于索引的自定义元标记或用于锚点的关键字和名称。 (也许你可以在 markdown 中使用评论,然后从评论中自动生成它们。但是我不确定 markdown 中的评论是否会保留在 DocC 生成的文件中)
您仍然需要使用 Help Indexer 来为它们编制索引。
@matt提到:
A help book helps users, whereas DocC displays a programming API to a programmer.
您绝对可以将两者结合起来并使用 DocC 生成的文件作为您的真实来源,但我宁愿与 其他 html 编辑,或 更好的 markdown 编辑器 如果你更喜欢 markdown 语法。
随着用于从源代码生成文档的 DocC 的引入,是否可以获取 DocC 的输出并将其用作 Apple 帮助手册(用于 macOS 应用程序内部)的真实来源?
可能不会。它们是完全不同的动物。帮助手册是一个完整的网站,为某些类型的锚点提供一些帮助。 DocC 是一种非常特定类型的信息的高度受限的形式化表示。事实上,即使你将这两件事融合在一起,你也不会想要;帮助手册可以帮助用户,而 DocC 向程序员显示编程 API。
举个例子,这是我写的一本帮助书:
http://www.apeth.com/sd5help/index.html
您不可能使用 DocC 表达这一点。如果问题是您正在寻找一种工具来帮助您编写帮助书籍,那么 DocC 不是它。
Is it possible to take the output of DocC and use it as the source of truth for an Apple Help Book?
- 是的,但可能不值得。
@matt提到:
A DocC is a highly restricted, formalized representation of a very specific type of information.
不过我不同意。您可以使用 DocC 创建文章页面:Getting Started with Sloths
使用 DocC 创建 Apple 帮助手册的问题:
DocC 文档仅支持基本的 markdown 语法,因此您的格式设置选项受到限制。
DocC 将文档导出为单页 Web 应用程序,其中 Apple Help Book 期望每个帮助页面都有单独的 html 文件。所以你需要自动生成静态 html 文件。
DocC 文档不允许您添加用于索引的自定义元标记或用于锚点的关键字和名称。 (也许你可以在 markdown 中使用评论,然后从评论中自动生成它们。但是我不确定 markdown 中的评论是否会保留在 DocC 生成的文件中)
您仍然需要使用 Help Indexer 来为它们编制索引。
@matt提到:
A help book helps users, whereas DocC displays a programming API to a programmer.
您绝对可以将两者结合起来并使用 DocC 生成的文件作为您的真实来源,但我宁愿与 其他 html 编辑,或 更好的 markdown 编辑器 如果你更喜欢 markdown 语法。