create-asciidoc-multi-book-workspace 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/templates/default-workspace/books/07-structured-writing-conventions/backmatter/appendix-a.adoc +14 -13
- package/templates/default-workspace/books/07-structured-writing-conventions/backmatter/appendix-b-decision-trees.adoc +22 -17
- package/templates/default-workspace/books/07-structured-writing-conventions/backmatter/glossary.adoc +6 -5
- package/templates/default-workspace/books/07-structured-writing-conventions/book.adoc +7 -5
- package/templates/default-workspace/books/07-structured-writing-conventions/frontmatter/abstract.adoc +1 -1
- package/templates/default-workspace/books/07-structured-writing-conventions/frontmatter/acknowledgments.adoc +1 -1
- package/templates/default-workspace/books/07-structured-writing-conventions/frontmatter/preface.adoc +3 -10
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/010-source-surface/010-source-and-projection.adoc +14 -14
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/010-source-surface/020-heading-address-and-xref.adoc +55 -0
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/010-source-surface/030-source-order-notation.adoc +3 -3
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/010-source-surface/_partintro.adoc +1 -1
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/020-names-roles-and-relations/010-names-and-address-labels.adoc +20 -0
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/{020-identity-and-relation/010-role-identity.adoc → 020-names-roles-and-relations/020-heading-roles.adoc} +7 -7
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/{020-identity-and-relation/020-relation-predicate.adoc → 020-names-roles-and-relations/030-relation-predicate.adoc} +3 -3
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/020-names-roles-and-relations/_partintro.adoc +1 -0
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/030-fields-and-terminology/010-surface-fields.adoc +16 -3
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/030-fields-and-terminology/020-glossary.adoc +2 -2
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/030-fields-and-terminology/_partintro.adoc +1 -1
- package/templates/default-workspace/catalog.adoc +2 -2
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/010-source-surface/020-default-semantics.adoc +0 -47
- package/templates/default-workspace/books/07-structured-writing-conventions/parts/020-identity-and-relation/_partintro.adoc +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.1 - 2026-10-15
|
|
4
|
+
|
|
5
|
+
### Changed
|
|
6
|
+
|
|
7
|
+
- Rework the structured writing conventions sample around names and addressing: headings now serve as the canonical name and default xref target, while `[#...]` is presented only as an explicit address label for existing technical or external addresses.
|
|
8
|
+
- Reorganize part two of the structured writing conventions sample from identity-and-relation into names-roles-and-relations, adding guidance on renames, aliases, concept-boundary changes, splits, and retirements.
|
|
9
|
+
- Update the quick reference, decision trees, glossary, part introductions, and catalog descriptions to drop the stable-ID teaching path.
|
|
10
|
+
|
|
3
11
|
## 0.3.0 - 2026-07-26
|
|
4
12
|
|
|
5
13
|
### Changed
|
package/package.json
CHANGED
|
@@ -32,33 +32,34 @@
|
|
|
32
32
|
|`010-opening.adoc`
|
|
33
33
|
|Chapter 文件的源文件编排号。规则与 Part 目录编排号一致。
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
(1) 该标题被至少一个 `xref` 交叉引用;
|
|
38
|
-
(2) 标题文本本身可能变更或在全书范围内可能重复。
|
|
39
|
-
若标题本身已是领域内唯一且稳定的标识符(如专有名词、唯一实体名、标准化编号),即使被交叉引用,也无需额外声明稳定 ID——标题文本即地址。
|
|
35
|
+
|`== 标题`
|
|
36
|
+
|创建标题节点;标题给出当前规范名称。
|
|
40
37
|
|
|
41
|
-
|`[
|
|
42
|
-
|
|
43
|
-
需要能够回答: “这个标题在整本书的知识体系中扮演什么认知功能”
|
|
38
|
+
|`[.concept]`
|
|
39
|
+
|用 role 标记标题在书中的作用。
|
|
44
40
|
|
|
45
|
-
|`[#
|
|
46
|
-
|
|
41
|
+
|`[#address-label]`
|
|
42
|
+
|为标题附加显式寻址标签。它用于找到标题。
|
|
43
|
+
|
|
44
|
+
|`[.example, owner=writing-team]`
|
|
45
|
+
|role 和 named attributes 保留标题的作用与附加字段。
|
|
47
46
|
|
|
48
47
|
|`summary::` + 下一行说明文本
|
|
49
48
|
|标题下描述列表字段。用于较多字段或多行字段值。
|
|
50
49
|
|
|
51
|
-
|`pass:[xref
|
|
50
|
+
|`pass:[xref:标题[显示文本]]`
|
|
52
51
|
|显示为链接,投影为 references。
|
|
53
52
|
|
|
54
|
-
|`pass:[xref
|
|
53
|
+
|`pass:[xref:标题[显示文本, rel=depends-on]]`
|
|
55
54
|
|显示为链接,同时声明 depends-on 关系。
|
|
56
55
|
|
|
57
56
|
|===
|
|
58
57
|
|
|
59
58
|
全书标题需要保持 `标题层级连续`。
|
|
60
59
|
|
|
61
|
-
role
|
|
60
|
+
role 描述标题在书中的作用。rel 描述 xref 边上的关系谓词。附加字段可以写在标题 attrlist、标题下描述列表或 xref named attributes 中。
|
|
61
|
+
|
|
62
|
+
标题改名时,更新引用;旧称有保留价值时写入别名。概念被拆分或废止时,保留历史标题并写明后续使用的标题。
|
|
62
63
|
|
|
63
64
|
`[appendix]`、`[glossary]` 和 `[bibliography]` 是 section style。它们改变紧随其后 section 的语义;标题层级仍由 `=` 数量决定。
|
|
64
65
|
|
|
@@ -27,33 +27,38 @@
|
|
|
27
27
|
└─ 否:写入标准等号标题。流程结束。
|
|
28
28
|
----
|
|
29
29
|
|
|
30
|
-
==
|
|
30
|
+
== 名称变化与寻址标签
|
|
31
31
|
|
|
32
|
-
触发场景::
|
|
32
|
+
触发场景:: 作者发现当前标题、旧称或引用地址发生变化。
|
|
33
33
|
|
|
34
34
|
[source,text]
|
|
35
35
|
----
|
|
36
|
-
1.
|
|
37
|
-
├─
|
|
38
|
-
└─
|
|
36
|
+
1. 当前标题还是该对象的规范名称吗?
|
|
37
|
+
├─ 是:继续使用标题。
|
|
38
|
+
└─ 否:判断变化类型。
|
|
39
39
|
|
|
40
|
-
2.
|
|
41
|
-
├─
|
|
42
|
-
└─
|
|
43
|
-
----
|
|
40
|
+
2. 只是换成更准确的名称吗?
|
|
41
|
+
├─ 是:改标题,更新引用;旧称有价值时写入别名。
|
|
42
|
+
└─ 否:检查概念边界。
|
|
44
43
|
|
|
45
|
-
|
|
44
|
+
3. 概念边界改变了吗?
|
|
45
|
+
├─ 是:检查描述、纳入条件、排除条件、相关标题和既有结论。
|
|
46
|
+
└─ 否:完成名称更新。
|
|
46
47
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
48
|
+
4. 旧概念被拆分或废止了吗?
|
|
49
|
+
├─ 是:保留历史标题,写明后续标题。
|
|
50
|
+
└─ 否:继续维护当前标题。
|
|
51
|
+
|
|
52
|
+
5. 是否已有外部技术地址必须保留?
|
|
53
|
+
├─ 是:为标题保留显式寻址标签。
|
|
54
|
+
└─ 否:不增加标签。
|
|
52
55
|
----
|
|
53
56
|
|
|
57
|
+
跨改名追踪记录和冻结内容版本,由工具层分别处理,不由标题的显式寻址标签承担。
|
|
58
|
+
|
|
54
59
|
== role 的作用域与语境管理
|
|
55
60
|
|
|
56
|
-
触发场景::
|
|
61
|
+
触发场景:: 作者为标题标记认知作用。
|
|
57
62
|
前提:: 当前书稿已经约定 role 受控词表,例如 `.concept`、`.rule`、`.example`。
|
|
58
63
|
|
|
59
64
|
[source,text]
|
|
@@ -85,7 +90,7 @@
|
|
|
85
90
|
|
|
86
91
|
3. 引用目的是什么?
|
|
87
92
|
├─ 表达阅读顺序、先读建议或普通参见:
|
|
88
|
-
│ 写入普通 xref,例如 `xref
|
|
93
|
+
│ 写入普通 xref,例如 `xref:目标标题[显示文本]`。
|
|
89
94
|
│ 投影为默认谓词 `aat:references`。流程结束。
|
|
90
95
|
└─ 声明明确的逻辑关系边:选取 `rel` 谓词。
|
|
91
96
|
|
package/templates/default-workspace/books/07-structured-writing-conventions/backmatter/glossary.adoc
CHANGED
|
@@ -4,12 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
[glossary]
|
|
6
6
|
heading:: 使用等号标题创建的书稿结构单位。
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
7
|
+
规范名称:: 当前书稿采用的标题名称。
|
|
8
|
+
显式寻址标签:: 作者用 `[#label]` 附加给标题的地址标签。它用于找到标题。
|
|
9
|
+
别名:: 标题以外仍有检索、历史或语境价值的名称。
|
|
10
|
+
不透明记录键:: 工具层用于跨改名追踪同一条记录的机器键。
|
|
11
|
+
内容哈希:: 标识某次冻结内容的校验值。
|
|
11
12
|
source-order notation:: 写在源文件路径表面的排序符号。
|
|
12
|
-
role::
|
|
13
|
+
role:: 标题节点在书中承担的叙述作用,例如 `.concept`、`.rule` 或 `.example`。
|
|
13
14
|
ordinary reference:: 普通 xref。投影时使用默认谓词 `aat:references`。
|
|
14
15
|
relation predicate:: xref `rel` 字段选择的边谓词。
|
|
15
16
|
source heading:: xref 所在的标题。
|
|
@@ -36,18 +36,20 @@ include::parts/010-source-surface/_partintro.adoc[]
|
|
|
36
36
|
|
|
37
37
|
include::parts/010-source-surface/010-source-and-projection.adoc[]
|
|
38
38
|
|
|
39
|
-
include::parts/010-source-surface/020-
|
|
39
|
+
include::parts/010-source-surface/020-heading-address-and-xref.adoc[]
|
|
40
40
|
|
|
41
41
|
include::parts/010-source-surface/030-source-order-notation.adoc[]
|
|
42
42
|
|
|
43
|
-
=
|
|
43
|
+
= 名称、角色与关系
|
|
44
44
|
|
|
45
45
|
[partintro]
|
|
46
|
-
include::parts/020-
|
|
46
|
+
include::parts/020-names-roles-and-relations/_partintro.adoc[]
|
|
47
47
|
|
|
48
|
-
include::parts/020-
|
|
48
|
+
include::parts/020-names-roles-and-relations/010-names-and-address-labels.adoc[]
|
|
49
49
|
|
|
50
|
-
include::parts/020-
|
|
50
|
+
include::parts/020-names-roles-and-relations/020-heading-roles.adoc[]
|
|
51
|
+
|
|
52
|
+
include::parts/020-names-roles-and-relations/030-relation-predicate.adoc[]
|
|
51
53
|
|
|
52
54
|
= 字段与术语
|
|
53
55
|
|
package/templates/default-workspace/books/07-structured-writing-conventions/frontmatter/preface.adoc
CHANGED
|
@@ -1,14 +1,7 @@
|
|
|
1
1
|
== 前言
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
这本书把标题、引用、role、rel 和附加字段放在同一份 AsciiDoc 源文档中。标题给出当前规范名称;xref 找到标题;role 说明标题在书中的作用;rel 说明引用表达的关系。
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
长期引用且标题文本可能变更的标题使用稳定 ID;
|
|
7
|
-
若标题本身已是唯一且稳定的实体名称,标题文本直接作为引用地址。
|
|
8
|
-
带有明确身份的标题使用 role;表达关系的引用使用 rel;
|
|
9
|
-
随源稿保留的短字段使用 named attributes;字段较多或需要多行值的标题字段使用标题下描述列表。
|
|
5
|
+
显式寻址标签只保留已经存在的技术地址。旧称、俗称和历史名称写入别名,不隐藏在地址字符串中。字段较少且值较短时写在标题 attrlist;字段较多或需要多行值时写在标题下的连续描述列表。
|
|
10
6
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
通过展示标题、稳定 ID、role、xref、rel 和附加字段如何形成可读、可维护、可投影的源文档,让你能够理解,你可以拥有一种这样的表达方式,可以按照某种约定,就能够提升你书籍的质量,能够让下游的工具链继续消费你的书。 你可以参考本书里你所需要的结构。
|
|
14
|
-
合适的结构能够提升书籍的可阅读、可维护性。你可以按写作目的选择其中写法。
|
|
7
|
+
同一份源文档因此同时保留阅读结构、维护所需的名称和关系,以及工具可以继续投影的字段。
|
|
@@ -2,49 +2,49 @@
|
|
|
2
2
|
== 源文本与投影
|
|
3
3
|
|
|
4
4
|
本章用一段示例展示结构化书写约定。Turtle 片段列出关键投影事实;完整投影还会保留 raw、路径、行号和边证据。
|
|
5
|
-
|
|
5
|
+
本章节的演示展示文字如何形成清晰的查询与导航结构。
|
|
6
6
|
|
|
7
7
|
[source,asciidoc]
|
|
8
8
|
----
|
|
9
9
|
= 结构化写作样例
|
|
10
10
|
|
|
11
|
-
[
|
|
11
|
+
[.concept]
|
|
12
12
|
== 常规标题
|
|
13
13
|
|
|
14
14
|
常规标题提供可引用的阅读单位。
|
|
15
15
|
|
|
16
|
-
[
|
|
16
|
+
[.example]
|
|
17
17
|
=== 基本语法
|
|
18
18
|
|
|
19
19
|
基本语法是常规标题下的直接子标题。
|
|
20
20
|
|
|
21
|
-
[
|
|
21
|
+
[.rule]
|
|
22
22
|
== 引用规则
|
|
23
23
|
|
|
24
|
-
引用规则参见 xref
|
|
25
|
-
引用规则依赖 xref
|
|
24
|
+
引用规则参见 xref:常规标题[]。
|
|
25
|
+
引用规则依赖 xref:常规标题[常规标题, rel=depends-on, weight=strong]。
|
|
26
26
|
----
|
|
27
27
|
|
|
28
28
|
源文档把 `常规标题` 写成可引用的阅读单位,在其下写出 `基本语法` 子标题,把 `引用规则` 写成规则说明,并在正文里写出参见和依赖两种引用。
|
|
29
29
|
|
|
30
|
-
Turtle 示例中的 `<urn:aat:doc:...#heading-*>` 和 `<urn:aat:doc:...#xref-edge-*>`
|
|
30
|
+
Turtle 示例中的 `<urn:aat:doc:...#heading-*>` 和 `<urn:aat:doc:...#xref-edge-*>` 表示投影生成的文档节点 IRI。本例没有为标题附加显式寻址标签,因此 `aat:addressLabel` 与标题文字一致。
|
|
31
31
|
|
|
32
32
|
[source,turtle]
|
|
33
33
|
----
|
|
34
34
|
<urn:aat:doc:...#heading-l3-o0> a aat:Heading ;
|
|
35
35
|
aat:headline "常规标题" ;
|
|
36
|
-
aat:addressLabel "
|
|
36
|
+
aat:addressLabel "常规标题" ;
|
|
37
37
|
aat:role "concept" ;
|
|
38
38
|
aat:containsDirectly <urn:aat:doc:...#heading-l8-o0> .
|
|
39
39
|
|
|
40
40
|
<urn:aat:doc:...#heading-l8-o0> a aat:Heading ;
|
|
41
41
|
aat:headline "基本语法" ;
|
|
42
|
-
aat:addressLabel "
|
|
42
|
+
aat:addressLabel "基本语法" ;
|
|
43
43
|
aat:role "example" .
|
|
44
44
|
|
|
45
45
|
<urn:aat:doc:...#heading-l13-o0> a aat:Heading ;
|
|
46
46
|
aat:headline "引用规则" ;
|
|
47
|
-
aat:addressLabel "
|
|
47
|
+
aat:addressLabel "引用规则" ;
|
|
48
48
|
aat:role "rule" ;
|
|
49
49
|
aat:references <urn:aat:doc:...#heading-l3-o0> ;
|
|
50
50
|
rel:depends-on <urn:aat:doc:...#heading-l3-o0> .
|
|
@@ -54,7 +54,7 @@ Turtle 示例中的 `<urn:aat:doc:...#heading-*>` 和 `<urn:aat:doc:...#xref-edg
|
|
|
54
54
|
aat:weight "strong" .
|
|
55
55
|
----
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
源文档中的 [.concept]#常规标题# 是被引用的阅读单位,`基本语法` 是它的下级标题, [.rule]#引用规则# 说明引用写法。投影读取同一份源文档,为标题生成 IRI,并在标题节点上保留 `aat:headline`、`aat:addressLabel` 和 `aat:role`;标题层级投影为 `aat:containsDirectly`,xref 投影为 `aat:references` 和 `rel:depends-on`。
|
|
58
58
|
|
|
59
59
|
[source,asciidoc]
|
|
60
60
|
----
|
|
@@ -65,8 +65,8 @@ Turtle 示例中的 `<urn:aat:doc:...#heading-*>` 和 `<urn:aat:doc:...#xref-edg
|
|
|
65
65
|
----
|
|
66
66
|
|
|
67
67
|
此处的 `pass:[xref:贾宝玉]` 直接使用标题文本作为寻址地址,
|
|
68
|
-
|
|
69
|
-
交叉引用宏语法是 `pass:[xref
|
|
68
|
+
因为“贾宝玉”在当前书稿中作为唯一标题名称使用。
|
|
69
|
+
交叉引用宏语法是 `pass:[xref:目标标题[可选显示文本]]`,所以这里省略了显示文本,渲染引擎默认会展示标题文字。
|
|
70
70
|
|
|
71
71
|
'''
|
|
72
72
|
|
|
@@ -80,4 +80,4 @@ Turtle 示例中的 `<urn:aat:doc:...#heading-*>` 和 `<urn:aat:doc:...#xref-edg
|
|
|
80
80
|
== REQ-2024-0088
|
|
81
81
|
----
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
`REQ-2024-0088` 是本书采用的编号名称。编号制度负责分配和唯一性,引用直接使用该编号:`pass:[xref:REQ-2024-0088[REQ-2024-0088, rel=constrains]]`
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[#heading-address-and-xref]
|
|
2
|
+
== 标题、寻址与引用
|
|
3
|
+
|
|
4
|
+
等号行创建标题和层级。标题给出当前规范名称;标题前的 attrlist 可以承载 role 和字段。
|
|
5
|
+
|
|
6
|
+
[source,asciidoc]
|
|
7
|
+
----
|
|
8
|
+
[.concept]
|
|
9
|
+
== 常规标题
|
|
10
|
+
----
|
|
11
|
+
|
|
12
|
+
`.concept` 标明标题在书中的作用。`常规标题` 是当前规范名称。
|
|
13
|
+
|
|
14
|
+
[source,asciidoc]
|
|
15
|
+
----
|
|
16
|
+
引用规则参见 xref:常规标题[]。
|
|
17
|
+
----
|
|
18
|
+
|
|
19
|
+
该 xref 投影为 `aat:references`,即默认引用谓词。
|
|
20
|
+
|
|
21
|
+
[source,asciidoc]
|
|
22
|
+
----
|
|
23
|
+
引用规则依赖 xref:常规标题[常规标题, rel=depends-on]。
|
|
24
|
+
----
|
|
25
|
+
|
|
26
|
+
`rel=depends-on` 声明从当前标题到目标标题的依赖关系,投影为 `rel:depends-on`。
|
|
27
|
+
|
|
28
|
+
[source,asciidoc]
|
|
29
|
+
----
|
|
30
|
+
[#catalog-entry-482]
|
|
31
|
+
== 宿舍集中备考者
|
|
32
|
+
----
|
|
33
|
+
|
|
34
|
+
`catalog-entry-482` 是附加给标题的显式寻址标签。外部目录已经使用这个地址时,引用可以继续使用它;标题“宿舍集中备考者”仍是当前规范名称。本书各章开头的英文标签用于阅读器页面地址;它们负责找到章节。
|
|
35
|
+
|
|
36
|
+
[TIP]
|
|
37
|
+
====
|
|
38
|
+
1. 显式寻址标签只在已有技术地址、外部链接或阅读器页面需要保留时出现。没有这种需要时,标题直接承担引用地址。写法速查见 xref:structured-writing-quick-reference[附录 A:结构化写法速查];完整判断流程见 xref:structured-writing-decision-trees[附录 B:结构化写法决策树]。
|
|
39
|
+
2. 按照书籍结构,跨越 `= 书名`、`= 卷/部`、`== 章` 这些大跨度的指代均需要使用 `xref` 手动标注,平衡隐式上下文的阅读压力。
|
|
40
|
+
====
|
|
41
|
+
|
|
42
|
+
标题声明角色后,其下级标题默认属于同一角色范围。下级标题可声明不同角色以切换语境。
|
|
43
|
+
|
|
44
|
+
例如:
|
|
45
|
+
|
|
46
|
+
[source,asciidoc]
|
|
47
|
+
----
|
|
48
|
+
[.rule]
|
|
49
|
+
== 引用规则
|
|
50
|
+
|
|
51
|
+
=== 基本语法
|
|
52
|
+
|
|
53
|
+
[.example]
|
|
54
|
+
=== 一个完整示例
|
|
55
|
+
----
|
|
@@ -13,7 +13,7 @@ Part 目录和 Chapter 文件统一使用三位数 `0X0` 格式进行编排。
|
|
|
13
13
|
----
|
|
14
14
|
parts/010-source-surface/
|
|
15
15
|
parts/015-new-topic/ <1>
|
|
16
|
-
parts/020-
|
|
16
|
+
parts/020-names-roles-and-relations/
|
|
17
17
|
|
|
18
18
|
010-opening.adoc
|
|
19
19
|
015-new-context.adoc <2>
|
|
@@ -31,6 +31,6 @@ parts/020-identity-and-relation/
|
|
|
31
31
|
|
|
32
32
|
使用三位数 `0X0` 格式,能够解决书籍动态维护过程中编号格式的稳定。
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
编排号只安排源文件顺序。标题保存当前规范名称;引用用标题或已有的显式寻址标签找到标题。
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
编排号、标题和寻址标签承担不同职责,不互相替代。
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
标题、引用和文件路径同时构成书稿的阅读结构与可投影的源文档表面。
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
[#names-and-address-labels]
|
|
2
|
+
== 名称变化与寻址标签
|
|
3
|
+
|
|
4
|
+
标题不只是排版上的显示文字。它是当前书稿采用的名称,也是读者、项目和引用者正在使用的名称。
|
|
5
|
+
|
|
6
|
+
[.population]
|
|
7
|
+
=== 宿舍集中备考者
|
|
8
|
+
|
|
9
|
+
别名::
|
|
10
|
+
|
|
11
|
+
* 宿舍高强度备考者(旧称)
|
|
12
|
+
* 宿舍备考学生(常用称呼)
|
|
13
|
+
|
|
14
|
+
标题改成“宿舍集中备考者”后,书中的 xref 与装配引用随标题更新。“宿舍高强度备考者”仍有历史检索价值时,作为旧称保留在别名中。
|
|
15
|
+
|
|
16
|
+
名称变得更准确时,改标题并更新引用。概念边界改变时,同时检查描述、纳入条件、排除条件、相关标题和既有结论。旧概念被拆分或废止时,保留历史标题,写明后续应使用的标题。
|
|
17
|
+
|
|
18
|
+
显式寻址标签只保留已有的技术地址。带有语义的标签是地址别名,不替代标题,也不代替概念变化的审查。
|
|
19
|
+
|
|
20
|
+
工具若要跨改名追踪同一条记录,由工具层保存不透明记录键。某次冻结内容的校验,由内容哈希或快照承担。标题继续保存当前规范名称。
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
[#
|
|
2
|
-
== role
|
|
1
|
+
[#heading-roles]
|
|
2
|
+
== 标题的 role
|
|
3
3
|
|
|
4
4
|
role 写在标题 attrlist 的点号 token 位置。
|
|
5
5
|
|
|
6
6
|
[source,asciidoc]
|
|
7
7
|
----
|
|
8
|
-
[
|
|
8
|
+
[.concept]
|
|
9
9
|
== 常规标题
|
|
10
10
|
|
|
11
|
-
[
|
|
11
|
+
[.rule]
|
|
12
12
|
== 引用规则
|
|
13
13
|
----
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
`.concept` 和 `.rule` 是 role。它们说明标题在当前书中承担概念说明或规则说明的作用。
|
|
16
16
|
|
|
17
17
|
[cols="1,2", options="header"]
|
|
18
18
|
|===
|
|
19
|
-
|写法
|
|
19
|
+
|写法 |读者看到的作用
|
|
20
20
|
|
|
21
21
|
|`[.concept]`
|
|
22
22
|
|标记概念说明。
|
|
@@ -28,7 +28,7 @@ role 写在标题 attrlist 的点号 token 位置。
|
|
|
28
28
|
|标记示例。
|
|
29
29
|
|===
|
|
30
30
|
|
|
31
|
-
role
|
|
31
|
+
同一个 role 在全书中保持同一种叙述作用。
|
|
32
32
|
|
|
33
33
|
一本书使用的 role 种类和数量,取决于该领域的概念结构。每种 role 的语义在全书中保持唯一。
|
|
34
34
|
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
[source,asciidoc]
|
|
7
7
|
----
|
|
8
|
-
引用规则参见 xref
|
|
9
|
-
引用规则依赖 xref
|
|
8
|
+
引用规则参见 xref:常规标题[]。
|
|
9
|
+
引用规则依赖 xref:常规标题[常规标题, rel=depends-on]。
|
|
10
10
|
----
|
|
11
11
|
|
|
12
12
|
第一行投影为 `aat:references`,即默认引用谓词。第二行声明 `rel=depends-on`,投影为 `rel:depends-on`。
|
|
@@ -19,6 +19,6 @@ illustrates:: 当前标题提供目标标题的示例。
|
|
|
19
19
|
defines:: 当前标题给出目标标题所代表对象的定义。
|
|
20
20
|
constrains:: 当前标题对目标标题的合法写法或范围施加约束。
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
关系谓词描述标题之间的边。标题在书中的作用由 role 表达。
|
|
23
23
|
|
|
24
24
|
标题之间的阅读顺序和先读建议,使用普通 xref(默认 `aat:references`)表达。
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
标题给出当前名称;寻址标签提供已有的技术地址;role 说明标题节点在书中的作用;rel 说明标题之间的关系。
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
[source,asciidoc]
|
|
7
7
|
----
|
|
8
|
-
[
|
|
8
|
+
[.example, owner=writing-team]
|
|
9
9
|
== 示例
|
|
10
10
|
|
|
11
|
-
示例说明 xref
|
|
11
|
+
示例说明 xref:常规标题[rel=illustrates, weight=strong]。
|
|
12
12
|
----
|
|
13
13
|
|
|
14
14
|
`.example` 是 role。`owner=writing-team` 是标题附加字段。`weight=strong` 是 xref 边证据上的附加字段。
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
[source,asciidoc]
|
|
21
21
|
----
|
|
22
|
-
[
|
|
22
|
+
[.example, status=active]
|
|
23
23
|
== 示例规则
|
|
24
24
|
|
|
25
25
|
priority:: normal
|
|
@@ -33,3 +33,16 @@ summary::
|
|
|
33
33
|
`priority:: normal` 和 `summary::` 属于 `示例规则` 标题的附加字段。投影时它们成为标题字段,例如 `aat:priority` 和 `aat:summary`。
|
|
34
34
|
|
|
35
35
|
字段名和字段值来自本书自己的约定。同一本书使用附加字段时,应保持字段写法和字段含义稳定。
|
|
36
|
+
|
|
37
|
+
[source,asciidoc]
|
|
38
|
+
----
|
|
39
|
+
[.concept]
|
|
40
|
+
== 宿舍集中备考者
|
|
41
|
+
|
|
42
|
+
aliases::
|
|
43
|
+
|
|
44
|
+
* 宿舍高强度备考者(旧称)
|
|
45
|
+
* 宿舍备考学生(常用称呼)
|
|
46
|
+
----
|
|
47
|
+
|
|
48
|
+
`aliases` 记录其他名称;它不取代标题,也不作为隐藏的第二个规范名称。
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
字段补充标题与引用已经表达的内容;术语表统一全书采用的名称。
|
|
@@ -46,7 +46,7 @@ v0.1, 2026-05
|
|
|
46
46
|
|
|
47
47
|
|让源书稿保持可读,同时保留可被工具链读取的结构关系
|
|
48
48
|
|xref:books/07-structured-writing-conventions/book.adoc[07 结构化书写约定标本]
|
|
49
|
-
|
|
49
|
+
|它展示标题、引用、role、xref、rel 和附加字段如何形成结构化书稿表面。
|
|
50
50
|
|===
|
|
51
51
|
|
|
52
52
|
== 样本书
|
|
@@ -58,7 +58,7 @@ v0.1, 2026-05
|
|
|
58
58
|
* xref:books/04-reference-manual/book.adoc[04 参考手册]:结构选择、路径规则和引用模式。
|
|
59
59
|
* xref:books/05-upper-volume/book.adoc[05 上册]:独立分卷的上册。
|
|
60
60
|
* xref:books/06-lower-volume/book.adoc[06 下册]:独立分卷的下册,并用示例说明跨卷引用写法。
|
|
61
|
-
* xref:books/07-structured-writing-conventions/book.adoc[07 结构化书写约定标本]
|
|
61
|
+
* xref:books/07-structured-writing-conventions/book.adoc[07 结构化书写约定标本]:标题、引用、role、xref、rel 和附加字段的结构化写法。
|
|
62
62
|
|
|
63
63
|
== 工作区地图
|
|
64
64
|
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
[#heading-and-xref]
|
|
2
|
-
== 标题与引用
|
|
3
|
-
|
|
4
|
-
等号行声明标题和层级。标题前的 attrlist 承载地址、role 和字段。
|
|
5
|
-
|
|
6
|
-
[source,asciidoc]
|
|
7
|
-
----
|
|
8
|
-
[#regular-heading.concept]
|
|
9
|
-
== 常规标题
|
|
10
|
-
----
|
|
11
|
-
|
|
12
|
-
`[#regular-heading]` 声明一个稳定地址。 `.concept` 标明标题身份。 `常规标题` 是标题文本。
|
|
13
|
-
|
|
14
|
-
[source,asciidoc]
|
|
15
|
-
----
|
|
16
|
-
引用规则参见 xref:regular-heading[常规标题]。
|
|
17
|
-
----
|
|
18
|
-
|
|
19
|
-
该 xref 投影为 `aat:references`,即默认引用谓词。
|
|
20
|
-
|
|
21
|
-
[source,asciidoc]
|
|
22
|
-
----
|
|
23
|
-
引用规则依赖 xref:regular-heading[常规标题, rel=depends-on]。
|
|
24
|
-
----
|
|
25
|
-
|
|
26
|
-
`rel=depends-on` 声明从当前标题到目标标题的依赖关系,投影为 `rel:depends-on`。
|
|
27
|
-
|
|
28
|
-
[TIP]
|
|
29
|
-
====
|
|
30
|
-
1. 全书中手工声明的稳定地址至少需要一个 `xref` 消费。写法速查见 xref:structured-writing-quick-reference[附录 A:结构化写法速查];完整判断流程见 xref:structured-writing-decision-trees[附录 B:结构化写法决策树]。
|
|
31
|
-
2. 按照书籍结构,跨越 `= 书名`、`= 卷/部`、`== 章` 这些大跨度的指代均需要使用 `xref` 手动标注,平衡隐式上下文的阅读压力。
|
|
32
|
-
====
|
|
33
|
-
|
|
34
|
-
标题声明角色后,其下级标题默认属于同一角色范围。下级标题可声明不同角色以切换语境。
|
|
35
|
-
|
|
36
|
-
例如:
|
|
37
|
-
|
|
38
|
-
[source,asciidoc]
|
|
39
|
-
----
|
|
40
|
-
[.rule]
|
|
41
|
-
== 引用规则
|
|
42
|
-
|
|
43
|
-
=== 基本语法
|
|
44
|
-
|
|
45
|
-
[.example]
|
|
46
|
-
=== 一个完整示例
|
|
47
|
-
----
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
本部展示标题身份和引用关系。role 标明标题身份;rel 标明引用关系。 在书籍中,你需要主动根据你当前所建模的概念结构对各类词表(`role`、`rel` 或者其他更多)进行建模与约定,需要专门的词表约定章节清晰的写出你需要使用的受控词表,方便后续的使用。
|