第 4 部分

这一周终于又顺利了。我在日历中预留出固定时间段的计划奏效了。周三我几乎能够不间断地写作。
在此过程中,我注意到 AsciiDoc 中的一些小细节,想与您分享。
本地化的章节
遗憾的是,某些章节,例如目录、图目录、术语表、参考文献等,不会被翻译。第一步是定义语言:
:lang: de
但仅此还不够。还必须引入 Asciidoctor 自带的一个特定文件(在 Github 上的此处):
// Include your own path for the attributes:include::../locale/attributes.adoc[]
只有这样,所有标准章节名称才会以所需的语言显示。
程序名称的重复
当然,重复一般来说并不好。但在手册中,产品名称多次重复是不可避免的。因此我很快就编写了一个变量:
:mp: Merlin Project
我这样使用这个变量:
Willkommen bei {mp}!
结果:
Willkommen bei Merlin Project!
还有一个额外的好处:我在 Merlin 与 Project 之间放置了一个不换行空格(在 BBEdit 中是组合键 ⌥ + 空格键)。这样程序名称在换行时永远不会被拆开。
菜单名称与键盘快捷键
软件手册的本质在于对界面及其操作的描述。在这里,您当然可以设定自己的标准,将元素以 斜体 或 粗体 显示。不过 AsciiDoc 中还有一个很棒的替代方案。但为此需要先用一个特殊的开关启用其使用。
:experimental:
顺便一提,尽管这个开关名为 experimental,但该功能其实已经完全成熟。这里有 Dan Allen 对此的评论。
现在菜单项可以用一种特殊的写法来书写:
Ein Klick auf menu:Hilfe[Dynamische Hilfe] startet die Balloon-Hilfe.
结果:
点击 帮助->动态帮助 即可启动气球式帮助。
当然,菜单项的格式可以在样式中进行调整。
快捷键,也就是键盘缩写,用法类似。写法如下:
kbd:[⌘ + N]
结果:
⌘ + N。
如果把 HTML 实体放入变量中,会更加简便。我在 StackExchange 上找到了用于 Apple 计算机的最重要的 HTML 实体:
:commandkey: ⌘:optionkey: ⌥:controlkey: ⌃:shiftkey: ⇧:enterkey: ⌤:enterkey: ⌤:returnkey: ⏎:deletekey: ⌫:rightkey: →:leftkey: ←:upkey: ↑:downkey: ↓
现在您的输入只需:
Drücken Sie kbd:[{commandkey} + Q] um ins Wochenende zu starten.
结果:
按下 ⌘ + Q 即可开启周末。
就此,下周再见……
如果您对这篇博客文章有任何疑问或希望参与讨论,欢迎您在我们的论坛中发帖。