Octave Forge 软件包答案

【问题标题】：Octave Forge packagesOctave Forge 软件包
【发布时间】：2016-08-12 22:38:37
【问题描述】：

我在 Windows 10 上运行 Window 的 Octave 端口。

我已经安装了 3 个包；控制、信号和通信。

我想知道是否可以运行一个程序来更新磁盘上的帮助？

或者我应该使用Octave Forge online documentation的在线帮助

T.I.A.

【问题讨论】：

如果你的意思是，例如help medfilt1，那么您需要先pkg load signal，否则当无法访问该功能时无法访问帮助。如果您的意思是“文档”，例如控制台和编辑器选项卡旁边的文档选项卡，那么不，我认为软件包不会安装任何文档，所以是的，请在线查看。但是，直接进入函数引用的包页面可能更容易，而不是一般索引，例如octave.sourceforge.net/signal/index.html
@TasosPapastylianou 啊，是的。我在想help 而不是doc。
谢谢 Tasos，是的，我的意思是“文档”。
更新包的命令：pkg update 也会更新包的“磁盘帮助”
@Andy 软件包实际上是否将 html 文档安装到它们的 help 标头之外？我不知道这一点（我也无法在我的安装中找到任何此类文档）。我有一种感觉，您只是指help 标头。话虽如此，在线“文档”实际上只是 help 标头的 html 版本，所以我想 OP 问题的答案是“没有单独的文档，只需使用帮助标头；这些与在线文档相同如果有旧版本，可以通过pkg 命令更新”。也许这值得一个正确的答案。

标签： windows octave

【解决方案1】：

只是为了给未来的读者更全面地回答这个问题。

核心 Octave 文档有两种形式：

手册，在此处以 pdf 和 html 形式提供：http://www.octave.org/doc
这与单击“文档”选项卡时在 octave GUI 中显示的文档相同。
帮助标题。它们在每个函数中定义，可以通过help <functionname> 命令调用。

Packages 有 no 不同的 html 和“帮助标头”版本。只有帮助标题。但是，这些帮助标题也可以在 octave forge 网站上以看起来更好看的 html 格式在线阅读，列在其功能参考下。如果您的软件包安装是最新的，那么两者应该是相同的。

您可以通过键入pkg describe -verbose <packagename> 在您的终端上获取有关软件包本身的一些信息（例如简短描述和它提供的功能列表），您可以通过news <packagename> 查看更新日志。同样，这与可以在 octave forge 上找到的信息相同，只是格式化为更好的 html。

【讨论】：

相对缺乏好的、深入的文档似乎是 octave 中持续存在的痛点之一，这在讨论中经常出现。理论上欢迎高质量的文档贡献，但我同意“帮助标题”并不总是最合适的文档格式。也许值得在线拥有“适当的”文档并从解释器重定向到该文档...
你的眼睛里缺少什么？每个函数都使用 texinfo 记录。这用于可以用help 显示的功能文档，用于生成html 页面。一些包也有一个“包文档”，见octave.sourceforge.net/interval/package_doc/index.html 并且有用户可以编辑的wiki页面。一些例子：wiki.octave.org/IO_package wiki.octave.org/Image_acquisition_package wiki.octave.org/Instrument_control_package
对不起，我并不是故意让我听起来像在抱怨（或者更糟的是，“拖钓”）。我只知道过去已经讨论过文档的质量；例如我记得在 IRC 的一次聊天中，缺乏适当的文档是去年 octconf 的一个相当重要的主题（尽管我认为这更针对代码文档）。总的来说，wiki 有点偶然，它没有被提升为主要资源（我认为也不应该如此）。间隔包是一个明显的例外，即便如此，它的文档也不包含在 octave 客户端中。（续）
而且，一般来说，我发现帮助标头包含最少的信息，如果您想了解更多信息，通常可以更好地查看该函数的 matlab 文档（在有matlab等效的情况）。同样，不是批评，我很清楚这样一个庞大的开源项目所带来的开发限制和限制。但这是一个问题。
@Andy 我个人的看法是，如果从贡献主代码库的过程中可以更简单、更直接，那么有相当大的用户群可能会倾向于为文档方面做出贡献本身，这显然受到了鼓励。事实上，该项目给人的印象是它是一个非常“封闭”的项目（就紧密结合的团队而言，而不是许可证而言）。也就是说，它感觉更像是“接受或离开”交易，而不是社区。集市网站仍然处于休眠状态的事实有点表明这一点。