开源改变世界

HALUI 手册页 HTML 文档使用了错误的连字符 #1093

推推 grbl 3年前 (2023-01-30) 122次浏览
关闭
c-morley 打开了这个问题 2021 年 2 月 28 日 · 16条评论
关闭

HALUI 手册页 HTML 文档使用了错误的连字符#1093

c-morley 打开了这个问题 2021 年 2 月 28 日 · 16条评论

注释

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者

至少 2.7、2.8 和 HALUI 的主要 HTML 手册页呈现错误的连字符。
这在运行复制/粘贴代码时显示为错误。

这是典型的手册页行:
.B halui.feed-override.count-enable\fR bit in \fR(默认值:\fBTRUE\fR)

这里的连字符是正确的。渲染时它更长。
它似乎是反斜杠连字符
mitsub_vfd 正确呈现但不使用反斜杠。

有谁知道为什么连字符被反斜杠?

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者

https://www.gnu.org/software/groff/manual/groff.html说 – 是减号。(在该页面上查找 [-])
我认为它用于指定字符是减号而不是连字符。

你的描述并没有说清楚哪些是对的,哪些是错的。

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者作者

看来我们当时使用减号作为连字符。

错误: http:
//linuxcnc.org/docs/devel/html/man/man1/halui.1.html

右: http:
//linuxcnc.org/docs/devel/html/gui/halui.html#_max_velocity

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者

嗯,它在键盘上的 + 旁边。并在文本编辑器或编码时给你一个减号。

复杂的是文字处理器使用键插入连字符,这是一个不同的字符。

HAL 引脚名称肯定有减号作为破折号。

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
贡献者
Sigma1912 评论了 2021 年 3 月 3 日  

@andy
c-morley 上面发布的两个页面是否在您的机器上给您相同(正确)的连字符?

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者
安迪普 评论了 2021 年 3 月 3 日  

按照链接,复制并粘贴到http://www.hexed.it显示第一个为 unicode 连字符 (E2 88 92)
第二个是(正确的)2D。
但是,奇怪的是,如果我在自己的机器上查看在本地构建文档时生成的 HTML,连字符在那里也都是正确的。
<b>halui.tool.length-offset.b</b>(二维)

(查看从http://www.linuxcnc.org提供的原始 html )
<b>halui.tool.length−offset.b</b>(E2 88 92)

因此,相同的工具似乎在不同的机器上从相同的输入文件生成不同的输出。

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
成员

但是,奇怪的是,如果我在自己的机器上查看在本地构建文档时生成的 HTML,连字符在那里也都是正确的。

是的,在我的机器上它也能正确生成。

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
成员

从 2.6 到 2.7 的构建过程是否有一些变化?
因为 2.6 的文档在这方面似乎是正确的。

http://linuxcnc.org/docs/2.6/html/man/man1/halui.1.html <–> http://linuxcnc.org/docs/2.7/html/man/man1/halui.1。 HTML )

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者

环顾四周,似乎转义连字符“-”(实际上是正确的)的联机帮助页以包含“-”的 html 结尾,然后呈现为破折号。
有趣的是,shuttle 联机帮助页并没有逃脱连字符,而且那个连字符是正确的。
因此,联机帮助页的诀窍可能是取消转义(监禁?)各处的减号。

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者作者

是的,我在第一篇文章中提到过。
问题是它被回砍是否有充分的理由 – 似乎可能没有。

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者作者

我想我应该在第一篇文章中说反斜杠减号 :)

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者

我尝试删除 Master 中 halui 联机帮助页中的转义符,并且正确生成了文档:
http
://linuxcnc.org/docs/devel/html/man/man1/halui.1.html 与未更改的 2.8 文档相比:
http ://linuxcnc.org/docs/2.8/html/man/man1/halui.1.html

所以,这似乎是对用 troff 编写的联机帮助页的修复,但不一定适用于用 asciidoc 编写的联机帮助页

尽管让 a2x(或它做的任何事情)不将 /- 转换为 &minus 会更整洁

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
合作者
安迪普 评论了 2021 年 3 月 6 日  

奇怪的是,这个问题似乎是在试图解决这个问题时引入的:4a89720

HALUI 手册页 HTML 文档使用了错误的连字符 #1093
成员

我错过了关于这个问题的提交吗?或者有人修改了构建过程?因为现在它显示正确了。现在甚至显示图像?

HALUI 手册页 HTML 文档使用了错误的连字符 #1093

我将文档的构建从 Wheezy 移到了 Buster。Buster 中较新版本的 docs 工具链可以正确解决这个问题。

为了后代,联机帮助页应使用:

  • \-他们想要正常的“减号”字符(unicode 2d,我们过去称之为 ASCII 0x2d)。这包括 HAL 引脚名称和命令行参数,例如--verbose.
  • -他们想要连字符的地方,例如在短语“命令行”中。
HALUI 手册页 HTML 文档使用了错误的连字符 #1093
成员

干得好!