嵌入宏(Inline Macro)是一种指令语法,它允许在文本流中使用内嵌指令。其作用是为了更方便的向 AsciiDoc 中添加元数据信息、重复使用内容以及通过脚本生成输出内容等。
与其他指令语法不同,嵌入宏的语法格式相对简单。它使用双个冒号标记,在指令名称之后紧跟着指令内容,即在文本中直接使用指令名称并传入参数即可。
嵌入宏的出现减少了重复工作,使得文档编辑和文档更新变得更加方便和高效。以下是使用嵌入宏的一些优势:
1、增加可读性:内嵌指令能够使文档的结构更加清晰,并且不会使文档的结构混乱。
2、减少维护难度:嵌入宏可以将一些需要重复使用的元素放在一个地方,当需要修改时也只需要修改一个地方,而不用修改多处。
3、提供更多的弹性:嵌入宏还可以通过编写脚本来实现一些更为复杂的功能,例如自动生成表格、列表、图片等。
嵌入宏语法由双冒号与指令组成,可传入0个或多个参数。
例如: name::
其中,name
是指令的名称,<param1>
是第一个参数,<param2>
和 <param3>
是第二个和第三个参数,使用逗号分隔。
嵌入宏广泛用于 AsciiDoc、Asciidoctor 等文档工具中。例如,常常使用的嵌入宏有:
1、quote:引用块的指令,用于在文档中插入一引用块。
2、include:插入文档内容的指令,用于在当前文档中插入其他文档部分。
3、image:插入图片的指令,可以直接将图片插入到文档中。
除此之外,嵌入宏还可以实现其他更为高级的功能,如递归嵌入、动态生成表格等。