@chengzhao-dev/dsh-quarto-book 0.3.4 → 0.4.0

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.
@@ -43,6 +43,18 @@
43
43
 
44
44
  不手跑 `quarto render`,也不手跑 `checking-output.py`、`checking-callouts.py`、`checking-dom.py`。工具已经按当前书配置调用它们。
45
45
 
46
+ ### 执行回执
47
+
48
+ 检查结论确定后,调用一次 `quarto_pass_report`,把这次执行的结论压成一张卡片:
49
+
50
+ - `skill` 填 `writing-quarto`,`mode` 填 `polish` 或 `rewrite`。
51
+ - `files` 写这次动过的章节路径和改动次数(最多 8 个);`steps` 只列有改动的步骤编号(1–9)与次数,两者合计必须一致。
52
+ - `held` 写围栏、事实这类明确没有改动的地方;没改就传 0。
53
+ - `checks` 抄内容与渲染的结论,名字只取 `content`、`html`、`layout`,状态只取 `pass`、`fail`、`skip`。
54
+ - 当前文件不是章节时传 `executed: false`、`mode: skipped`,并给一句 `skip_reason`。
55
+
56
+ 卡片就是回执,回复里不再复述;回执不保存到磁盘,也不贴改写后的句子,不根据回执改文章。
57
+
46
58
  ## 情况
47
59
 
48
60
  ### 情况:全仓重构
@@ -55,7 +67,7 @@
55
67
 
56
68
  ## 完成判据
57
69
 
58
- 内容命令通过,`dry_run: false` 返回 `render_result.ok: true`,且 `html_report.usable: true`,才算完成。任一条件不满足,回到报告指向的步骤。
70
+ 内容命令通过,`dry_run: false` 返回 `render_result.ok: true`,且 `html_report.usable: true`,并调用一次 `quarto_pass_report` 出回执,才算完成。任一条件不满足,回到报告指向的步骤。
59
71
 
60
72
  ## 正反例
61
73
 
@@ -1,22 +1,22 @@
1
- # 章节对照
2
-
3
- 本文件只收通用技能不知道的事实:每一章的文件名、类章或能力章、关键对象、
4
- YAML `title` 与二级标题。类章与能力章的定义、一章一个关键、标题分层与收尾节名
5
- 由插件 `writing-quarto` 的 `steps/02-structure.md` 负责,这里不抄。
6
-
7
- 章节顺序以根 `_quarto.yml` 的 `book.chapters` 为准;下表只用于核对章节骨架。
8
-
9
- | 路径 | 类章 / 能力章 | 关键(类或交付物) | `title` | 二级标题(按顺序) |
10
- | --- | --- | --- | --- | --- |
11
- | `content/.../01-....qmd` | 能力章 | | | |
12
- | `content/.../02-....qmd` | 类章 | | | |
13
-
14
- ## 写作约束
15
-
16
- - `title` 与 `_quarto.yml` 及正文 YAML 中的写法逐字一致;类章的 `title` 用读者名,
17
- 不写英文类名,除非关键对象本身只有一个英文名。
18
- - 二级标题是这一章关键的部分,顺序与「关键」一列对应;成员函数可以做三级标题,
19
- 不能做章标题。
20
- - 固定收尾 `常见错误`、`自测问题`、`本章回顾` 不改名,不升成关键。
21
- - 类型章的文件名镜像关键类;改文件名时同轮同步 `_quarto.yml`、本表、`title`、
22
- 已有链接与内容检查脚本里的章关键键,不留旧名孤儿。
1
+ # 章节对照
2
+
3
+ 本文件只收通用技能不知道的事实:每一章的文件名、类章或能力章、关键对象、
4
+ YAML `title` 与二级标题。类章与能力章的定义、一章一个关键、标题分层与收尾节名
5
+ 由插件 `writing-quarto` 的 `steps/02-structure.md` 负责,这里不抄。
6
+
7
+ 章节顺序以根 `_quarto.yml` 的 `book.chapters` 为准;下表只用于核对章节骨架。
8
+
9
+ | 路径 | 类章 / 能力章 | 关键(类或交付物) | `title` | 二级标题(按顺序) |
10
+ | --- | --- | --- | --- | --- |
11
+ | `content/.../01-....qmd` | 能力章 | | | |
12
+ | `content/.../02-....qmd` | 类章 | | | |
13
+
14
+ ## 写作约束
15
+
16
+ - `title` 与 `_quarto.yml` 及正文 YAML 中的写法逐字一致;类章的 `title` 用读者名,
17
+ 不写英文类名,除非关键对象本身只有一个英文名。
18
+ - 二级标题是这一章关键的部分,顺序与「关键」一列对应;成员函数可以做三级标题,
19
+ 不能做章标题。
20
+ - 固定收尾 `常见错误`、`自测问题`、`本章回顾` 不改名,不升成关键。
21
+ - 类型章的文件名镜像关键类;改文件名时同轮同步 `_quarto.yml`、本表、`title`、
22
+ 已有链接与内容检查脚本里的章关键键,不留旧名孤儿。