这份文件总结了每个季度对AsciiDoc语言文档所做的更改。如需了解详细的更改内容,请参考仓库的[提交历史]https://github.com/asciidoctor/asciidoc-docs/commits/main。
发布于2023年第四季度
- 添加了
-
-
记录`include`指令上的`encoding`属性以及何时使用它
-
在图像宏上记录
link
属性及其相关属性
-
- 变更
-
-
澄清行规范化只适用于包含AsciiDoc格式的文件。
-
发布于2023年第三季度
- 添加了
-
-
解释了为什么节级别限制为5的原因
-
记录如何转义有序列表标记
-
- 变更
-
-
澄清一个开放的块只能伪装成其他段落或限定块。
-
澄清在简写xref和xref宏中,如何处理xref目标中的点。
-
2023年第二季度发布
- 添加了
-
-
在视频宏上记录静音选项 (!10)
-
- 变更
-
-
澄清标题中的脚注并不是官方支持的
-
记录零宽度空格字符在破折号和省略号替换中的使用情况。
-
澄清链接宏的目标中不允许使用空格,因此必须进行转义或编码。
-
- 固定的
-
-
修复了许多拼写错误 (!14)
-
2023年第一季度发布
- 添加了
-
-
添加提示,说明如何找到各种语法高亮器支持的源语言列表
-
- 变更
-
-
将文档版本从最新更改为预规范 (#30)
-
澄清上标和下标的格式既不是受限的也不是不受限的,而是一种特殊的混合型。
-
请澄清,第一个菜单项必须以字母字符或字符引用开头。
-
强调菜单的简写语法并不是标准轨道上的内容。
-
澄清文档标题是如何被解读的,并指出不允许任何内容块位于它之前。
-
- 固定的
-
-
更新docinfo示例,以便它能够识别docinfo文件
-
从UI宏页面中移除关于`experimental`属性的多余警告。
-
- 已移除
-
-
移除有关过时的`docinfo1`和`docinfo2`文档属性的信息。
-
发布于2022年第四季度
- 添加了
-
-
恢复菜单宏简写语法的文档说明。
-
明确设置时无序列表样式的继承文档。
-
文档中关于shell和console源语言之间的区别
-
记录水平定义列表的`labelwidth`和`itemwidth`属性。
-
添加页面以记录`docinfo`属性和docinfo文件
-
- 变更
-
-
澄清在渲染的无序列表中哪些标记默认被选中
-
如果源语言已设置,则更明确地指出在列表块中不需要源样式。
-
澄清源代码语言的值是由语法高亮库定义的。
-
在链接宏的目标中添加冒号编码的示例
-
在同一个文档中混合使用AsciiMath和LaTeX数学公式的完整示例
-
澄清何时可以在源代码块上使用行高亮以及它是如何工作的
-
- 固定的
-
-
修复图像块示例,使源代码与输出匹配
-
发布于2022年第三季度
- 添加了
-
-
关于分页宏的更多详细信息
-
关于主题断裂宏的更多细节添加
-
关于问答列表添加更多细节
-
将`table-frame`、`table-grid`和`table-stripes`添加到文档属性参考表中
-
在图像上为`pdfwidth`属性的`iw`单位编写文档。
-
文档块标题(带标题的标题)以及用于生成和控制它们的属性。
-
适当介绍属性列表,详细添加它们可用之处的更多细节。
-
- 变更
-
-
向ID属性页面添加了子部分
-
在多部分组成的书籍中,清楚地说明特别章节的运作方式。
-
澄清`ifeval`指令的表达式的每一边应该具有相同的类型。
-
澄清默认情况下,表格上的
frame
和grid
属性可以分别通过使用table-frame
和table-grid
文档属性来控制。 -
澄清
frame
和grid
属性都接受值all
。 -
在快速参考中澄清块标题显示的位置。
-
澄清格式化文本可以跨越多个连续的行
-
2022年第二季度发布
- 添加了
-
-
记录展平的
backend
、basebackend
、doctype
和filetype
值属性(例如,backend-html5
) -
记录如何编码包含等号和引号的链接文本
-
文档中提到,可以在xref宏上指定`xrefstyle`属性,以便单独覆盖一个引用的xrefstyle值。
-
文档中提到,从定界块中自动删除了前导和尾随的空行。
-
通过删除宏替换来记录如何关闭自动链接。
-
- 固定的
-
-
澄清在role属性中的多个角色(role)值必须通过空格分隔(#114)
-
在文字格式类型与视觉呈现之间画出清晰的联系(加重字体=粗体,强调=斜体等)。
-
将"macro substitution"更改为"macros substitution"以保持术语的一致性
-
- 变更
-
-
更精确地指定在命名属性值中引号何时不被转义
-
修订关于URL和链接宏中窗口属性的文本。
-
添加警告,说明在window=_blank中使用下划线可能会意外形成一个受限的格式对;推荐使用简写语法代替。
-
2022年第一季度发布
- 添加了
-
-
添加章节来澄清,替换操作不适用于在外部定义的属性值。
-
必须使用%22来对URL中的双引号进行编码
-
为多个属性添加专用章节,并包含ifndef指令的示例。
-
明确说明,在`ifdef`和`ifndef`指令中,
,`和
+`组合器不能组合使用。
-
- 变更
-
-
澄清在ifdef指令中多个属性的解释
-
发布于2021年第四季度
- 添加了
-
-
在块和格式化文本中引入属性速记的专用部分。
-
将术语attrlist定义为为元素或包含指令定义属性的源文本。
-
在外部脚注文本中使用文本格式化标记的文档说明。
-
建议在连续的include指令之间增加一个空行,除非目的是为了紧邻地连接内容。
-
文档中可接受的图像目标值是什么
-
在转换为HTML时,图像目标中的空格会被编码。
-
当启用自动生成章节ID时,如果标题包含向前引用的交叉引用,需要一个自定义ID。
-
在文档中切换自动生成的章节ID的步骤说明
-
添加涵盖单个和加号直通的部分,并提供示例
-
为块和行注释添加完整的文档,包括一个简介
-
明确记录你可以在一个属性条目的值中引用另一个属性的值。
-
- 固定的
-
-
声明scaledwidth属性使用%值会相对于内容区域缩放图像。
-
从元素属性名的有效字符列表中移除点号;这从未是一个有效字符。
-
提高内部交叉引用的描述准确性
-
修复了关于内联锚点解释的许多问题。
-
- 变更
-
-
将“列表继续”页面重构为“复杂列表项”。
-
澄清用户定义的文档属性是按照它们定义的顺序存储的。
-
澄清宽度和高度属性的值必须是一个没有单位的整数值。
-
关于图像尺寸属性的一般说明。
-
澄清元素属性的模式是开放式的(#87)
-
修改“文档属性”页面,使其提供更清晰、更准确的文档属性介绍。
-
澄清 include 指令的目标接受哪些值
-
重写单引号和双引号的介绍;为直引号添加示例。
-
重新编写撇号行为和语法的介绍;添加智能排版替换的例子。
-
将内容拆分为内部交叉引用的部分;添加推荐做法
-
改进自动生成的章节和离散标题ID的描述。
-
澄清属性条目可以在哪里声明;指出在限定块内声明属性条目是未定义的。
-
澄清书籍中的版本说明部分可以放置在任何位置。
-
在链接介绍页面上区分绝对URL和相对URL
-
将 '''Literal Monospace section''' 提升为一个页面
-
显示没有前导冒号的上下文以避免混淆
-
2021年第三季度发布
- 固定的
-
-
澄清lang属性的值必须是一个BCP 47语言标签
-
修正文本引用中将mailto宏错误地引用为email宏的问题。
-
修正与自定义行内样式相关的术语
-
修正与突出显示文本相关的术语
-
轻微澄清对于一个受限格式化对的规则,强调文本不能以空白类字符开始或结束。
-
将 chapter-label 改为 chapter-signifier
-
- 添加了
-
-
折叠文档块(示例结构容器上的collapsible和open选项)(#34)
-
文档中如何转义属性引用
-
文档文本跨度(以前称为无格式文本)
-
记录块AsciiMath标记中的换行符是如何处理的
-
记录块状LaTeX符号中的换行符是如何处理的
-
记录图像宏上的格式属性
-
在目标为SVG时,记录图像宏上的fallback属性。
-
将窗口属性添加到图像宏的参照表中。
-
在源代码块上记录 linenums 选项
-
将`pp`添加到字符替换属性表中
-
记录partintro块样式(#84)
-
音频宏中的文档开始和结束属性 (#74)
-
完整文档中的音频宏,提供了介绍和例子
-
将音频宏加入到句法快速参考中
-
展示如何指定包含逗号的alt文本的例子
-
记录AsciiDoc在ID值中允许哪些字符,并提供推荐。
-
在通道部分添加介绍页面
-
在嵌入YouTube视频时记录列表和播放列表属性
-
使用标记列表类型记录建议的描述列表
-
将"block name, context, block style, structural container, 和 content model"添加到术语表中。
-
将“block element(块级元素)”、“inline element(内联元素)”、“element(元素)”和“node(节点)”添加到术语表中。
-
记录在描述列表中使用的有效术语分隔符集合(#95)
-
- 变更
-
-
重新编写有关块的文档,以包含有关内容模型、上下文、结构容器、界定块、块伪装和嵌套界定块的信息。
-
提供更多详细信息和示例,解释如何使用 mailto 宏的属性列表。
-
使其更清楚地表明 GitHub、GitLab 和浏览器预览扩展会自动调整 relfilesuffix
-
重写关于多行属性值的页面,描述行连接器作为行继续符。
-
在适用的情况下将 Asciidoctor 的提及更改为 AsciiDoc 处理器
-
澄清格式化对不能重叠
-
将离散标题页面移动到块模块,并在导航中映射到顶级条目 (#4)
-
澄清表格上自定义单元格分隔符必须是单个字符
-
澄清表格上的条纹设置会被嵌套表格继承。
-
为了与MDN保持一致,在HTML和XML中提到元素节点时,请优先使用“元素”这个词汇,而不是“标签”。
-
将文件名后缀从
-reference.adoc
更改为-ref.adoc
,具体文件为document-attributes-reference.adoc
和character-replacement-reference.adoc
。 -
重写元素属性的解释
-
2021年第二季度发布
- 固定的
-
-
在README中更新商标归属(PR #62)
-
将 part-label 更改为 part-signifier (PR #64)
-
- 变更
-
-
为在单引号属性值中转义单引号提供更清晰的示例(PR #60)
-
将属性替换例子切换为自动链接,以避免关闭方括号是否需要转义的细微差别。
-
澄清一点,分配给章节标题的额外ID不能用于文档内的引用。
-
澄清只能使用主要ID来引用文档中的章节标题。
-
发布于2021年第一季度
- 固定的
-
-
重新编写大部分的link-macro-attribute-parsing.adoc文件,以反映在https://github.com/asciidoctor/asciidoctor/issues/2059中实现的简化解析行为。
-
澄清一个否定标签选择所有行,除了那些包含标签指令的行(不仅仅是之前建议的所有行)。
-
将术语“STEM interpreter”更正为“STEM notation” (#8)
-
- 添加了
-
-
添加如何选择标记区域外的所有行以及特定标记区域内的行的示例
-
详细解析文档属性列表(#43)
-
记录对AsciiDoc源文件和AsciiDoc包含文件应用的规范化处理 (#51)
-
- 变更
-
-
将内容移动到docs文件夹中 (#55)
-
澄清include标签过滤规则;强调通配符只能使用一次
-
澄清包括通过标签包含的内容,意味着包含了所有带有该相同标签的区域。
-
统一使用“链接文本”这个术语,而不是“被链接的文本”(#50)
-
2020年第四季度发布
这些更改已提交并合并到主分支中,开始日期为2020年11月24日。
- 固定的
-
-
将短语_lead style_替换为_lead role_
-
将表格框架值
topbot
替换为ends
(#9) -
解决与内置前导码ID的冲突
-
将文档属性`hardbreaks`替换为`hardbreaks-option` (#3)
-
修复指向页面片段(又称深层链接)的链接
-
修复导航文件中的分组问题
-
更新交叉引用以反映在asciidoctor组件中模块名称的变更
-
记录内联传递宏接受的替代值;阐明这个宏的目的(#37)。
-
将块图像示例的标注移动到包含的行中 (#39)
-
在示例中添加了缺少的前置反斜杠,以展示如何转义包含指令。
-
- 添加了
-
-
导入AsciiDoc语法快速参考内容(#14)
-
在导航栏中添加关于抽象块风格的页面,并与抽象部分区分开来。
-
将相关链接文档集成到链接宏页面
-
描述列表中列表项必须放置锚点的文档 (#21)
-
- 变更
-
-
重做内置属性的参考表,通过修正错误的值和描述、阐明有效值和隐含值之间的差异、以及合并仅用于标题的列(#24)。
-
将内置属性引用合并到文档属性引用中 (#26)
-
在提到格式标记补充时,请使用术语“对”而不是“集合”(#6)。
-
将短语_set of brackets_替换为短语_pair of brackets_,以与更新后的术语(#6)保持一致。
-
将短语 set of delimited lines 替换为 pair of delimited lines (#6)
-
修订概览页面的文本格式和标点符号 (#6)
-
将硬换行部分移动到"段落"部分下的专用页面(#3)。
-
在导航文件中将无序列表移动到有序列表之前。
-
将围栏代码块替换为AsciiDoc源代码块
-
删除`subs`属性值中不必要的引号
-
AsciiDoc表格单元格中交换列的示例
-
使用xref宏进行文档间的交叉引用
-
将名称AsciiDoc Python替换为AsciiDoc.py
-
将术语“master document”替换为“primary document”。
-
在开始页面上定义
navtitle
属性 -
将版本从当前更名为最新
-
- 已移除
-
-
移除正在进行中的迁移通知
-
删除禁用的页面
-