Contact me: hankecnc@gmail.com

2.8 文档中对 halui.jog 的过时引用 #969

推推 grbl 3年前 (2023-01-30) 273次浏览
打开
sigma1912 开了这个issue 2020 年 10 月 28 日 · 6条评论
打开

2.8 文档中对 halui.jog 的过时引用#969

sigma1912 开了这个issue 2020 年 10 月 28 日 · 6条评论

注释

2.8 文档中对 halui.jog 的过时引用 #969
贡献者

halui.jog 已在 2.8 版中删除,但在 2.8 文档中仍有对它的引用

那里很好
linuxcnc.org/docs/2.8/html/man/man1/halui.1.html

但这里是错误的
linuxcnc.org/docs/2.8/pdf/LinuxCNC_Documentation.pdf

在这里:
linuxcnc.org/docs/2.8/html/gui/halui.html

也在这里(我想这是当前稳定版本的文档?):
linuxcnc.org/docs/html/gui/halui.html

2.8 文档中对 halui.jog 的过时引用 #969
合作者

@jethornton你能回答关于无链接版本的问题吗?

2.8 文档中对 halui.jog 的过时引用 #969
合作者

为什么我们删除了主文档中的 halui pin 参考?

2.8 文档中对 halui.jog 的过时引用 #969
合作者

提交589db06删除了 halui.txt 中的错误和冗余信息,因为 halui 联机帮助页 (docs/man/man1/halui.1) 中的信息是错误和冗余的,halui 联机帮助页已得到更一致的维护。添加到 halui.txt 的参考将读者引导至手册页 (man halui)

如果有人想恢复 halui,txt,他们将需要在两个地方维护冗余信息

2.8 文档中对 halui.jog 的过时引用 #969
合作者

感谢您的回复。
为什么我们要删除文档,因为它们已经过时了?通常的事情是更新它们。
HTML 文档经常用作参考,例如在论坛中。
将您引向其他文档(尤其是您需要有一台机器才能看到的文档)的文档对用户来说不是很友好。

2.8 文档中对 halui.jog 的过时引用 #969
合作者
安迪普 评论了 2020 年 12 月 14 日  

联机帮助页以 HTML 格式提供,在本例中为http://linuxcnc.org/docs/2.8/html/man/man1/halui.1.html

我可以看到一个论点,即(在 html 文档中)指向联机帮助页 html 的链接比命令行示例更有用。

然而,这仍然是离线 PDF 的情况。阅读 PDF 硬拷贝的人在做什么?(虽然我们可能只有一个用户经常这样做)

2.8 文档中对 halui.jog 的过时引用 #969
合作者

好吧,有一个 HTML 手册页的链接会好得多,我同意(不知道有没有)

但我觉得 HTML 文档和手册页是两种不同的动物,一个不应该取代另一个。
手册页是简单明了的机器参考。
HTML/PDF 文档更应该是漂亮的扩展版本——但它们仍然应该是完整的。

我的意思是一个极端的例子是 HTML 文档,它们大多说请参阅相关的手册页 – 很糟糕。

我理解思考过程——两套文档保持相关性,但采用 halui 文档——它们如此过时的原因是因为 linuxcnc 作为一个整体发生了巨大变化。这不是一个正常发生的问题。

就个人而言 – 如果我们有可用的离线 HTML 文档 – 我永远不会使用手册页并且我已经不使用 PDF – 尽管如果我打印文档我想 PDF 会更好。

我已经替换了我拥有的一个分支中的引脚引用 – 我只是还没有推送(掌握)。
我会等着看是否有更多的讨论。

免费注册 在 GitHub 上加入此对话。已有帐户? 登录评论
标签
还没有
项目

还没有

发展

没有分支机构或拉取请求

4人参加
2.8 文档中对 halui.jog 的过时引用 #9692.8 文档中对 halui.jog 的过时引用 #9692.8 文档中对 halui.jog 的过时引用 #9692.8 文档中对 halui.jog 的过时引用 #969

喜欢 (0)