用 AsciiDoc 编写的新手册

第 5 部分

Merlin Project 手册封面

新的一年如今已经过去几天,最后一批度假者现在也都重新投入了忙碌的工作。

当然,我在节假日期间也放慢了节奏,主要处理一些为新一年做准备的行政事务。同样,我也为即将发布的 Merlin Project 8.1 版在网站上做了不少准备工作。

细心的读者可以由此立即看出,新手册我并没有写多少……其实根本一个字都没写 🤷‍♂️。

对此前文章的反馈

尽管如此,我还是想回应一些在 第四部分 之后收到的邮件。许多人对变量和文本替换非常感兴趣。因此,这次我想给出一个重要的提示。

AsciiDoc 有一个 Admonitions 的概念,在中文里最贴切的译法是「提示框」。常见的取值 有 NOTE、IMPORTANT、TIP、CAUTION 和 WARNING。这些提示会以单词形式输出,大致看起来是这样:

IMPORTANT | 阅读文档有助于避免出错!

但如果在文档开头包含这样一行:

:icons: font

那么这些词语就会被符号所替代。视所用图像而定,效果大致如下:

阅读文档有助于避免出错!

每当我需要在 Merlin ProjectMerlin Project Express 等程序之间加以区分时,我都会利用这一技巧,插入一段像这样的文本:

[{MPE}]
NOTE: Merlin Project Express 只识别「文件」这一种附件类型。

由此便生成了这样的效果:

这要求在 attributes.adoc 中已定义该图标。

:mpe: icon=mpExpress-32.png

就这样,下次再会……


如果您对这篇博客文章有任何疑问或希望参与讨论,欢迎您在我们的论坛中发帖

规划项目, 让计划真正奏效。

一款管理项目计划的应用,在所有 Apple 设备上原生运行。