有效的内置名称
内置属性名是保留的,不能重新用于用户定义的属性名。内置属性名列在document-attributes-ref.html和character-replacement-ref.html中。
有效的用户自定义名称
用户定义的属性名称必须:
-
至少为一个字符长,
-
以一个单词字符开始(a-z、0-9 或 _),并且
-
仅包含单词字符和连字符(-)。
用户自定义的属性名不能包含点号(.)或空格。尽管在属性名中允许使用大写字符,但在存储之前该名字会被转换为小写。例如,`URL-REPO`和`URL-Repo`在文档加载或转换时都会被当作`url-repo`对待。一个最佳实践是属性名中只使用小写字母,并且避免以数字开始属性名。
属性值类型和赋值方法
根据属性的不同,其值可能是一个空字符串、一个整数如5或者2,或者是一串字符,比如你的名字或者一个网址。接受字符串值的属性可能包含对其他属性的引用和内联宏。值不能包含复杂的、多行的块状元素,例如表格或侧边栏。
当属性条目中的值为空时,可以默认分配一个属性的值,或者用户可以显式地指定一个值。属性接受的值的类型,以及它是否使用默认值、具有多个内置值、接受用户定义的值,或者需要显式分配一个值,这取决于属性本身。
内置值
许多内置属性具有一个或多个内置值。这些值中可能有一个被指定为属性的默认值。如果您设置了属性但是没有填写值,AsciiDoc处理器将回退到这个默认值。此外,处理器在处理时间会自动设置许多内置属性,并赋予它们默认值,除非您显式地取消设置属性或者分配另一个值。例如,处理器会自动设置所有的character replacement attributes(字符替换属性)。
如果你想使用内建属性的非默认值,你需要设置它并赋予一个替代值。
空字符串值
内置布尔属性的值在属性条目中总是保持空白,因为这些属性只用来开启或关闭某个特性。在处理过程中,AsciiDoc处理器会为所有激活的布尔属性分配一个_空字符串_值。
显式值
你必须在以下情况下显式地为属性分配一个值:
-
它没有默认值。
-
你想要覆盖默认值,还是…
-
这是一个用户定义的属性。
内置属性接受的显式值的类型取决于属性本身。 用户定义的属性接受字符串值。 长的显式值可以使用 wrapped 来换行。