@amaster.ai/pi-lark 0.1.6 → 0.1.7

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.
Files changed (178) hide show
  1. package/README.md +5 -1
  2. package/dist/config.d.ts +1 -1
  3. package/dist/config.d.ts.map +1 -1
  4. package/dist/config.js +2 -2
  5. package/dist/config.js.map +1 -1
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/index.js +2 -1
  8. package/dist/index.js.map +1 -1
  9. package/package.json +3 -3
  10. package/skills/lark-apps/SKILL.md +24 -12
  11. package/skills/lark-apps/creative-design/agents/assets/vision-probe.png +0 -0
  12. package/skills/lark-apps/creative-design/agents/fork-verifier-agent.md +71 -0
  13. package/skills/lark-apps/creative-design/agents/vision-probe-agent.md +41 -0
  14. package/skills/lark-apps/creative-design/assets/index.html +27 -0
  15. package/skills/lark-apps/creative-design/creative-design.md +239 -0
  16. package/skills/lark-apps/creative-design/references/aily.md +39 -0
  17. package/skills/lark-apps/creative-design/references/animated-video.md +34 -0
  18. package/skills/lark-apps/creative-design/references/charts.md +165 -0
  19. package/skills/lark-apps/creative-design/references/claude.md +36 -0
  20. package/skills/lark-apps/creative-design/references/codex.md +32 -0
  21. package/skills/lark-apps/creative-design/references/data-report.md +108 -0
  22. package/skills/lark-apps/creative-design/references/frontend-design.md +71 -0
  23. package/skills/lark-apps/creative-design/references/hi-fi-design.md +32 -0
  24. package/skills/lark-apps/creative-design/references/interactive-prototype.md +24 -0
  25. package/skills/lark-apps/creative-design/references/make-a-deck.md +133 -0
  26. package/skills/lark-apps/creative-design/references/visual-exposure.md +82 -0
  27. package/skills/lark-apps/creative-design/references/wireframe.md +14 -0
  28. package/skills/lark-apps/creative-design/starter-components/android-frame.jsx +188 -0
  29. package/skills/lark-apps/creative-design/starter-components/animations.jsx +773 -0
  30. package/skills/lark-apps/creative-design/starter-components/browser-window.jsx +122 -0
  31. package/skills/lark-apps/creative-design/starter-components/deck-stage.js +2483 -0
  32. package/skills/lark-apps/creative-design/starter-components/design-canvas.jsx +1432 -0
  33. package/skills/lark-apps/creative-design/starter-components/ios-frame.jsx +270 -0
  34. package/skills/lark-apps/creative-design/starter-components/macos-window.jsx +197 -0
  35. package/skills/lark-apps/creative-design/starter-components/tweaks-panel.jsx +752 -0
  36. package/skills/lark-apps/references/lark-apps-automation.md +80 -2
  37. package/skills/lark-apps/references/lark-apps-cache.md +61 -0
  38. package/skills/lark-apps/references/lark-apps-cloud-dev.md +0 -1
  39. package/skills/lark-apps/references/lark-apps-create.md +1 -2
  40. package/skills/lark-apps/references/lark-apps-db.md +1 -1
  41. package/skills/lark-apps/references/lark-apps-env-pull.md +1 -1
  42. package/skills/lark-apps/references/lark-apps-file.md +2 -2
  43. package/skills/lark-apps/references/lark-apps-git-credential.md +1 -1
  44. package/skills/lark-apps/references/lark-apps-html-publish.md +4 -8
  45. package/skills/lark-apps/references/lark-apps-init.md +1 -1
  46. package/skills/lark-apps/references/lark-apps-list.md +1 -1
  47. package/skills/lark-apps/references/lark-apps-local-dev.md +54 -11
  48. package/skills/lark-apps/references/lark-apps-openapi-key.md +1 -1
  49. package/skills/lark-apps/references/lark-apps-release-create.md +2 -2
  50. package/skills/lark-apps/references/lark-apps-release-get.md +3 -3
  51. package/skills/lark-base/SKILL.md +20 -13
  52. package/skills/lark-base/references/lark-base-cell-value.md +3 -3
  53. package/skills/lark-base/references/lark-base-data-query.md +11 -4
  54. package/skills/lark-base/references/lark-base-field-create.md +4 -0
  55. package/skills/lark-base/references/lark-base-field-json.md +4 -4
  56. package/skills/lark-base/references/lark-base-field-update.md +17 -1
  57. package/skills/lark-base/references/lark-base-filter-condition.md +179 -0
  58. package/skills/lark-base/references/lark-base-form-questions-create.md +40 -7
  59. package/skills/lark-base/references/lark-base-form-questions-update.md +73 -20
  60. package/skills/lark-base/references/lark-base-form-submit.md +16 -7
  61. package/skills/lark-base/references/lark-base-record-batch-create.md +12 -10
  62. package/skills/lark-base/references/lark-base-record-batch-update.md +11 -9
  63. package/skills/lark-base/references/lark-base-record-upsert.md +1 -1
  64. package/skills/lark-base/references/lark-base-role-guide.md +11 -0
  65. package/skills/lark-base/references/lark-base-view-set-filter.md +11 -137
  66. package/skills/lark-base/references/role-config.md +31 -5
  67. package/skills/lark-calendar/SKILL.md +14 -8
  68. package/skills/lark-calendar/references/lark-calendar-create.md +6 -5
  69. package/skills/lark-calendar/references/lark-calendar-recurring.md +1 -0
  70. package/skills/lark-calendar/references/lark-calendar-room-find.md +2 -1
  71. package/skills/lark-calendar/references/lark-calendar-schedule-clear-time.md +1 -0
  72. package/skills/lark-calendar/references/lark-calendar-suggestion.md +1 -1
  73. package/skills/lark-calendar/references/lark-calendar-update.md +10 -4
  74. package/skills/lark-contact/SKILL.md +19 -3
  75. package/skills/lark-contact/references/lark-contact-search-bot.md +60 -0
  76. package/skills/lark-doc/references/lark-doc-fetch.md +10 -2
  77. package/skills/lark-doc/references/lark-doc-whiteboard.md +9 -8
  78. package/skills/lark-doc/references/lark-doc-xml-extended-blocks.md +41 -0
  79. package/skills/lark-doc/references/lark-doc-xml.md +4 -3
  80. package/skills/lark-drive/SKILL.md +25 -45
  81. package/skills/lark-drive/references/lark-drive-add-comment.md +2 -4
  82. package/skills/lark-drive/references/lark-drive-add-reply.md +47 -0
  83. package/skills/lark-drive/references/lark-drive-apply-permission.md +2 -2
  84. package/skills/lark-drive/references/lark-drive-batch-query-comments.md +46 -0
  85. package/skills/lark-drive/references/lark-drive-comment-content.md +50 -0
  86. package/skills/lark-drive/references/lark-drive-comment-location.md +9 -15
  87. package/skills/lark-drive/references/lark-drive-delete-reply.md +48 -0
  88. package/skills/lark-drive/references/lark-drive-download.md +5 -1
  89. package/skills/lark-drive/references/lark-drive-list-comments.md +25 -68
  90. package/skills/lark-drive/references/lark-drive-list-replies.md +54 -0
  91. package/skills/lark-drive/references/lark-drive-member-add.md +2 -2
  92. package/skills/lark-drive/references/lark-drive-member-list.md +65 -0
  93. package/skills/lark-drive/references/lark-drive-permission-get-setting.md +48 -0
  94. package/skills/lark-drive/references/lark-drive-preview.md +11 -1
  95. package/skills/lark-drive/references/lark-drive-react-reply.md +51 -0
  96. package/skills/lark-drive/references/lark-drive-reactions.md +27 -25
  97. package/skills/lark-drive/references/lark-drive-resolve-comment.md +45 -0
  98. package/skills/lark-drive/references/lark-drive-restore-comment.md +46 -0
  99. package/skills/lark-drive/references/lark-drive-search.md +7 -1
  100. package/skills/lark-drive/references/lark-drive-secure-label.md +1 -1
  101. package/skills/lark-drive/references/lark-drive-update-reply.md +46 -0
  102. package/skills/lark-drive/references/lark-drive-upload.md +1 -0
  103. package/skills/lark-drive/references/lark-drive-workflow-permission-governance-commands.md +38 -8
  104. package/skills/lark-drive/references/lark-drive-workflow-permission-governance-outputs.md +10 -10
  105. package/skills/lark-drive/references/lark-drive-workflow-permission-governance.md +22 -20
  106. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-execute.md +273 -0
  107. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-recall.md +202 -0
  108. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-resolve-verify.md +231 -0
  109. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-review-plan.md +248 -0
  110. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector-setup.md +174 -0
  111. package/skills/lark-drive/references/lark-drive-workflow-topic-move-collector.md +202 -0
  112. package/skills/lark-drive/references/lark-drive-workflow.md +5 -4
  113. package/skills/lark-event/SKILL.md +1 -0
  114. package/skills/lark-event/references/lark-event-application.md +38 -0
  115. package/skills/lark-im/SKILL.md +1 -1
  116. package/skills/lark-im/references/card/card-2.0-schema.md +1 -1
  117. package/skills/lark-im/references/card/lark-im-card-style.md +4 -4
  118. package/skills/lark-im/references/card/resource/icons.md +14 -0
  119. package/skills/lark-im/references/lark-im-flag-list.md +8 -7
  120. package/skills/lark-okr/SKILL.md +71 -26
  121. package/skills/lark-okr/references/lark-okr-batch-create.md +19 -18
  122. package/skills/lark-okr/references/lark-okr-create.md +173 -0
  123. package/skills/lark-okr/references/lark-okr-cycle-list.md +17 -7
  124. package/skills/lark-okr/references/lark-okr-entities.md +1 -0
  125. package/skills/lark-okr/references/lark-okr-indicator-update.md +3 -1
  126. package/skills/lark-okr/references/lark-okr-indicators.md +61 -12
  127. package/skills/lark-okr/references/lark-okr-progress-list.md +21 -9
  128. package/skills/lark-slides/SKILL.md +115 -68
  129. package/skills/lark-slides/references/asset-planning.md +6 -4
  130. package/skills/lark-slides/references/iconpark.md +2 -2
  131. package/skills/lark-slides/references/lark-slides-create.md +16 -8
  132. package/skills/lark-slides/references/lark-slides-history.md +132 -0
  133. package/skills/lark-slides/references/lark-slides-media-upload.md +2 -3
  134. package/skills/lark-slides/references/lark-slides-pptx-template-workflows.md +7 -11
  135. package/skills/lark-slides/references/lark-slides-replace-slide.md +0 -3
  136. package/skills/lark-slides/references/lark-slides-screenshot.md +4 -4
  137. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-create.md +219 -0
  138. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-delete.md +6 -5
  139. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-get.md +2 -2
  140. package/skills/lark-slides/references/lark-slides-xml-presentation-slide-replace.md +2 -3
  141. package/skills/lark-slides/references/lark-slides-xml-presentations-get.md +65 -30
  142. package/skills/lark-slides/references/planning-layer.md +11 -10
  143. package/skills/lark-slides/references/slides_chart_demo.xml +1416 -1
  144. package/skills/lark-slides/references/slides_xml_schema_definition.xml +492 -76
  145. package/skills/lark-slides/references/troubleshooting.md +25 -7
  146. package/skills/lark-slides/references/validation-checklist.md +53 -16
  147. package/skills/lark-slides/references/visual-planning.md +25 -22
  148. package/skills/lark-slides/references/xml-schema-quick-ref.md +281 -45
  149. package/skills/lark-slides/scripts/sxsd_validator.py +908 -0
  150. package/skills/lark-slides/scripts/xml_text_overlap_lint.py +1650 -165
  151. package/skills/lark-slides/scripts/xml_text_overlap_lint_test.py +3139 -513
  152. package/skills/lark-task/SKILL.md +7 -0
  153. package/skills/lark-task/references/lark-task-complete.md +6 -2
  154. package/skills/lark-task/references/lark-task-create.md +9 -0
  155. package/skills/lark-task/references/lark-task-update.md +6 -2
  156. package/skills/lark-whiteboard/SKILL.md +13 -12
  157. package/skills/lark-whiteboard/elements/layout.md +1 -1
  158. package/skills/lark-whiteboard/elements/schema.md +2 -2
  159. package/skills/lark-whiteboard/references/{lark-whiteboard-query.md → lark-whiteboard-export.md} +15 -15
  160. package/skills/lark-whiteboard/references/lark-whiteboard-update.md +3 -3
  161. package/skills/lark-whiteboard/references/lark-whiteboard-workflow.md +7 -17
  162. package/skills/lark-whiteboard/routes/dsl.md +3 -3
  163. package/skills/lark-whiteboard/routes/mermaid.md +2 -2
  164. package/skills/lark-whiteboard/routes/svg-edit.md +4 -4
  165. package/skills/lark-whiteboard/routes/svg.md +11 -6
  166. package/skills/lark-whiteboard/scenes/bar-chart.md +1 -1
  167. package/skills/lark-whiteboard/scenes/fishbone.md +1 -1
  168. package/skills/lark-whiteboard/scenes/flywheel.md +1 -1
  169. package/skills/lark-whiteboard/scenes/line-chart.md +1 -1
  170. package/skills/lark-whiteboard/scenes/treemap.md +1 -1
  171. package/skills/lark-wiki/SKILL.md +1 -0
  172. package/skills/lark-drive/references/lark-drive-comments-guide.md +0 -80
  173. package/skills/lark-slides/references/examples.md +0 -91
  174. package/skills/lark-slides/references/lark-slides-whiteboard.md +0 -331
  175. package/skills/lark-slides/references/lark-slides-xml-get.md +0 -100
  176. package/skills/lark-slides/references/slide-templates.md +0 -201
  177. package/skills/lark-slides/references/slides_demo.xml +0 -226
  178. package/skills/lark-slides/references/xml-format-guide.md +0 -433
@@ -1,91 +0,0 @@
1
- # 完整操作示例
2
-
3
- 本文档提供与 CLI schema 一致的调用示例,XML 内容均遵循 [slides_xml_schema_definition.xml](slides_xml_schema_definition.xml)。
4
-
5
- > **重要**:新建 PPT 请使用 `slides +create --slides`,传入由 `<slide>` XML 字符串组成的 JSON 数组;每个元素必须是一页完整的 `<slide>`。复杂内容建议先创建空白 PPT,再通过 `xml_presentation.slide.create` 逐页添加。完整 `<presentation>` XML 可用于本地 lint 或读取,但不能直接作为 `+create` 的提交参数。
6
-
7
- ## 目录
8
-
9
- - [示例 1:可靠创建 6 页 PPT](#示例-1可靠创建-6-页-ppt)
10
- - [示例 7: +replace-slide + block_insert 给已有页加图](#示例-7-replace-slide--block_insert-给已有页加图)
11
- - [示例 8: +replace-slide + block_replace 替换一个块](#示例-8-replace-slide--block_replace-替换一个块)
12
-
13
- ## 示例 1:可靠创建 6 页 PPT
14
-
15
- ### 1. 写入规划文件
16
-
17
- ```bash
18
- DECK_DIR=".lark-slides/plan/reliable-six-page-ppt"
19
- mkdir -p "$DECK_DIR"
20
-
21
- # 按 planning-layer.md 写入 "$DECK_DIR/slide_plan.json",
22
- # 至少记录 6 页的顺序和标题。
23
- ```
24
-
25
- ### 2. 为每页保存独立 XML
26
-
27
- 每个文件都是完整的 `<slide>`。下面的循环会生成 6 个独立 XML 文件;实际项目中可将每页主体替换为规划内容。
28
-
29
- ```bash
30
- titles=("主题与结论" "问题背景" "核心方法" "关键数据" "执行计划" "总结与行动")
31
- for i in {1..6}; do
32
- printf -v page '%02d' "$i"
33
- cat > "$DECK_DIR/slide-$page.xml" <<XML
34
- <slide xmlns="http://www.larkoffice.com/sml/2.0"><style><fill><fillColor color="rgb(248,250,252)"/></fill></style><data><shape type="rect" topLeftX="56" topLeftY="56" width="12" height="428"><fill><fillColor color="rgb(37,99,235)"/></fill></shape><shape type="text" topLeftX="100" topLeftY="160" width="760" height="90"><content textType="title" autoFit="normal-auto-fit"><p>${titles[$((i-1))]}</p></content></shape><shape type="text" topLeftX="100" topLeftY="290" width="700" height="70"><content textType="body" autoFit="normal-auto-fit"><p>页面主体内容。</p></content></shape></data></slide>
35
- XML
36
- done
37
- ```
38
-
39
- ### 3. 逐页运行 lint
40
-
41
- 提交前检查每个独立 XML。`summary.error_count` 必须为 `0`,否则先修复 XML 或布局问题。
42
-
43
- ```bash
44
- for slide_xml in "$DECK_DIR"/slide-0{1,2,3,4,5,6}.xml; do
45
- python3 skills/lark-slides/scripts/xml_text_overlap_lint.py \
46
- --input "$slide_xml" | tee "${slide_xml%.xml}.lint.json"
47
- done
48
-
49
- test "$(jq -s 'map(.summary.error_count) | add' "$DECK_DIR"/slide-0{1,2,3,4,5,6}.lint.json)" = "0"
50
- ```
51
-
52
- ### 4. 使用 `+create` 创建 6 页 PPT
53
-
54
- `--slides` 接收由 6 个完整 `<slide>` XML 字符串组成的 JSON 数组;使用 `jq --rawfile` 避免手动处理 XML 引号和换行。
55
-
56
- ```bash
57
- lark-cli slides +create --as user \
58
- --title "可靠创建 6 页 PPT" \
59
- --slides "$(jq -n \
60
- --rawfile s1 "$DECK_DIR/slide-01.xml" \
61
- --rawfile s2 "$DECK_DIR/slide-02.xml" \
62
- --rawfile s3 "$DECK_DIR/slide-03.xml" \
63
- --rawfile s4 "$DECK_DIR/slide-04.xml" \
64
- --rawfile s5 "$DECK_DIR/slide-05.xml" \
65
- --rawfile s6 "$DECK_DIR/slide-06.xml" \
66
- '[$s1, $s2, $s3, $s4, $s5, $s6]')" \
67
- > "$DECK_DIR/create.json"
68
- create_status=$?
69
-
70
- if [ "$create_status" -ne 0 ]; then
71
- exit "$create_status"
72
- fi
73
-
74
- if ! PRESENTATION_ID=$(jq -er '.data.xml_presentation_id | strings | select(length > 0)' "$DECK_DIR/create.json"); then
75
- echo "missing non-empty data.xml_presentation_id in $DECK_DIR/create.json" >&2
76
- exit 1
77
- fi
78
- echo "$PRESENTATION_ID" > "$DECK_DIR/xml_presentation_id"
79
- ```
80
-
81
- 如果创建中途失败,先保存已经返回的 `xml_presentation_id`,再回读确认实际已创建页数。
82
-
83
- ### 5. 用 `+xml-get` 回读全文 XML
84
-
85
- ```bash
86
- lark-cli slides +xml-get --as user \
87
- --presentation "$PRESENTATION_ID" \
88
- --output "$DECK_DIR/readback.xml" \
89
- --json | tee "$DECK_DIR/readback.json"
90
- ```
91
-
@@ -1,331 +0,0 @@
1
- # Whiteboard 画板元素
2
-
3
- `<whiteboard>` 放在 `<data>` 内,内部可放 **SVG** 或 **Mermaid**,用于绘制流程图、时序图、架构图、散点图、漏斗图、自定义图标、装饰图案等 `<chart>` 和 `<shape>` 难以覆盖的视觉内容。
4
-
5
- 普通柱状图、条形图、折线图、面积图、雷达图、饼图 / 环图和组合图应优先使用原生 `<chart>`。除非用户明确要求像素级自定义,或图表类型确实不受 `<chart>` 支持,否则不要用 `<whiteboard>` + SVG / Mermaid 重画这些标准图表。
6
-
7
- > 前置条件:使用本文档前先阅读 [lark-slides SKILL.md](../SKILL.md)。
8
-
9
- ---
10
-
11
- ## `<chart>` 还是 `<whiteboard>`?
12
-
13
- **先判断内容类型,再进入本文档:**
14
-
15
- | 场景 | 推荐元素 |
16
- |------|---------|
17
- | 有结构化数据序列的柱/条/折线/面积/雷达/饼/环/组合图 | `<chart>` — 原生渲染,支持 legend / tooltip / 系列配色 |
18
- | 散点图、漏斗图(`<chart>` 不支持)或其他非原生数据视觉 | `<whiteboard>` SVG |
19
- | 流程图、时序图、架构图、类图、ER 图等拓扑图 | `<whiteboard>` Mermaid 或 SVG |
20
- | 自定义图标、徽标、示意性图形(需要 path/polygon 精确控制) | `<whiteboard>` SVG |
21
- | 进度条、波浪背景、装饰图案、像素级自定义可视化 | `<whiteboard>` SVG |
22
-
23
- > 适合 `<chart>` 的内容就用 `<chart>`,不要用 SVG / Mermaid 手绘——原生渲染更省力、结构更稳定,也更容易被回读和后续编辑。
24
-
25
- ---
26
-
27
- ## whiteboard 公共属性
28
-
29
- | 属性 | 必需 | 说明 |
30
- |------|------|------|
31
- | `topLeftX` | 是 | 左上角 X 坐标(slide 坐标系,slide 默认宽 960) |
32
- | `topLeftY` | 是 | 左上角 Y 坐标(slide 坐标系,slide 默认高 540) |
33
- | `width` | 是 | 画板宽度(像素) |
34
- | `height` | 是 | 画板高度(像素) |
35
-
36
- > SVG 模式下 `<svg>` 需声明 `xmlns="http://www.w3.org/2000/svg"`;内容大小由子元素包围盒决定,`width`/`height`/`viewBox` 不影响渲染(仅当元素属性使用百分比值时需要 `viewBox` 提供计算基准)。Mermaid 模式不需要额外属性。
37
-
38
- SVG 内的坐标相对于 whiteboard 自身左上角(0,0),与 slide 坐标系无关。
39
-
40
- ---
41
-
42
- ## SVG 还是 Mermaid?
43
-
44
- 选择分三步:**先排除原生 `<chart>`,再判断 whiteboard 类型,最后看当前模型身份**。
45
-
46
- ### 第一步:先确认是否应该使用 `<chart>`
47
-
48
- 如果内容是柱状图、条形图、折线图、面积图、雷达图、饼图 / 环图或组合图,返回使用原生 `<chart>`,不要继续套用本文档的 SVG / Mermaid 路径。
49
-
50
- ### 第二步:whiteboard 类型优先判断
51
-
52
- 以下类型**推荐 Mermaid**,自动布局、代码简洁;如需精确匹配品牌配色或自定义节点样式,可改用 SVG:
53
-
54
- | 图表类型 | Mermaid 关键字 |
55
- |----------|--------------|
56
- | 流程图、决策树、架构图 | `flowchart TD` / `flowchart LR` |
57
- | 时序图 | `sequenceDiagram` |
58
- | 类图 | `classDiagram` |
59
- | 甘特图 | `gantt` |
60
- | 状态图 | `stateDiagram-v2` |
61
- | 思维导图 | `mindmap` |
62
- | ER 图 | `erDiagram` |
63
-
64
- ### 第三步:非原生图表与装饰元素按模型身份选路径
65
-
66
- 上表以外的场景(散点图、漏斗图、进度条、时间线、波浪背景、星点纹理等)需要精确控制坐标和配色,SVG 表达力更强,但各模型生成 SVG 的能力有差异:
67
-
68
- | 模型身份 | 路径 |
69
- |----------|------|
70
- | Claude / Gemini / GPT / GLM | **SVG** — 精确控制坐标、颜色、透明度 |
71
- | Doubao / Seed / Other | **Mermaid** — 用 `gantt`、`flowchart` 等近似表达;确实无法用 Mermaid 表达时才回退到简单 SVG 矩形/线条 |
72
-
73
- > **先自报身份再选路径**:在决定使用 SVG 之前,确认当前模型属于哪一类。不要跳过这一步。
74
-
75
- ---
76
-
77
- ## 模式一:SVG
78
-
79
- ### ⚠️ 设计品质要求
80
-
81
- 在 slide 里嵌入 `<whiteboard>` 的目的是**表达原生 `<chart>` 或基础 `<shape>` 难以覆盖的视觉关系**,不是把标准数据图表手绘一遍。
82
-
83
- - **不要只用矩形加文字应付**:通篇纯白底色 + 方块 + 黑字等于白做,这是不及格输出
84
- - **非原生数据视觉必须有坐标系**:散点、漏斗等仍要有必要的坐标轴、刻度、数值标注或分段说明,不要只画点或色块
85
- - **字号必须有层级**:标题 ≠ 标签 ≠ 数值,混用同一字号会消灭视觉焦点
86
- - **配色要与 slide 主题呼应**:深色 slide 背景下图表用透明底或深色卡片;浅色背景下避免再加纯白底块
87
- - **每个 whiteboard 都是设计机会**:主动用圆角、半透明填充、清晰分组、节点状态等细节拉开与默认模板的差距
88
- - **写 SVG 前先判断背景亮度**:背景亮度 < 30% 时,装饰元素"对比不足"比"过强"危害更大,宁重勿轻;
89
- - **装饰层次用亮度跳跃,不用线性叠透明度**:`α=0.04→0.08→0.12` 的等差递增在深色底上几乎看不出差异(相邻层亮度差 ≈20);正确做法是非线性跳跃如 `0.10→0.40→0.70→1.0`,相邻层亮度差 ≥60。
90
-
91
- ### 语法
92
-
93
- ```xml
94
- <whiteboard width="400" height="300" topLeftX="500" topLeftY="120">
95
- <svg xmlns="http://www.w3.org/2000/svg">
96
- <rect x="50" y="50" width="80" height="200" rx="4" fill="rgba(59,130,246,0.85)"/>
97
- <text x="90" y="270" text-anchor="middle" font-size="12" fill="rgba(100,116,139,1)">ABC</text>
98
- </svg>
99
- </whiteboard>
100
- ```
101
-
102
- `<svg>` 需声明 `xmlns="http://www.w3.org/2000/svg"`;`width`/`height`/`viewBox` 无需填写,若元素属性使用百分比值则需额外声明 `viewBox`。
103
-
104
- ### ⚠️ 渲染包围盒规则
105
-
106
- whiteboard 渲染时以**所有子元素的几何包围盒合并结果**为内容区域,自适应缩放到容器。
107
-
108
- `<svg>` 上的 `width`、`height`、`viewBox` 不影响内容区域的计算,但 `viewBox` 有一个实际用途:**为百分比属性提供计算基准**。若元素使用 `width="50%"` 等百分比值,必须声明 `viewBox` 才能正确解析;绝对坐标元素则无需关心。推荐统一使用绝对坐标,避免引入百分比依赖。
109
-
110
- ### 支持的 SVG 元素
111
-
112
- | 元素 | 说明 | 典型用途 |
113
- |------|------|---------|
114
- | `<rect>` | 矩形,支持 `rx` 圆角 | 卡片、进度条、分段色块 |
115
- | `<circle>` | 圆 | 节点、装饰点、环形图 |
116
- | `<ellipse>` | 椭圆 | 自定义轮廓图形 |
117
- | `<line>` | 直线 | 轴线、分隔线、连接线 |
118
- | `<path>` | 任意路径(支持 Q/C 曲线) | 波浪、曲线、弧形 |
119
- | `<text>` | 文本,支持中文 | 标签、数值 |
120
- | `<polygon>` | 多边形 | 箭头、星形、面积填充 |
121
- | `<g>` | 分组 | 批量变换、语义分组 |
122
- | `<linearGradient>` | 线性渐变定义,配合 `fill="url(#id)"` 使用 | 渐变背景、渐变填充 |
123
-
124
- **颜色:** 统一用 `rgba(R,G,B,A)`,对深浅背景都友好。
125
- **虚线:** `stroke-dasharray="4,4"` 用于网格线 / 坐标轴。
126
- **变换:** `transform="translate(x,y)"` / `rotate(deg cx cy)` / `scale(n)` 均支持。
127
-
128
- ---
129
- ### 元素计算
130
-
131
- SVG 中只要涉及批量定位、等间距排布或数据映射,**建议额外运行一个 Python 脚本把坐标算出来再填入 SVG**,而不是手动估值。适用范围包括散点、漏斗、装饰性点阵、等间距圆、重复图案等;普通柱状图、折线图、饼图仍应回到原生 `<chart>`。
132
-
133
- > **主动去算**:写 SVG 之前先运行脚本,把输出当注释贴在 `<svg>` 开头,再照着填坐标。估值几乎每次都需要反复调整,跳过这步反而更慢。
134
-
135
- **散点图 / 装饰性点阵范式**
136
-
137
- ```python
138
- W, H = 360, 260
139
- origin_x, origin_y = 50, 216 # 左下角,SVG Y 轴向下
140
- cw, ch = 290, 184
141
-
142
- points = [(12, 40), (28, 80), (45, 65)]
143
- x_min, x_max, y_min, y_max = 0, 50, 0, 100
144
- for i, (xv, yv) in enumerate(points):
145
- x = round(origin_x + (xv - x_min) / (x_max - x_min) * cw)
146
- y = round(origin_y - (yv - y_min) / (y_max - y_min) * ch)
147
- print(f"point-{i}: cx={x} cy={y}")
148
- ```
149
-
150
- **装饰性元素(等间距范式)**
151
-
152
- ```python
153
- n, total_w, cy, r = 8, 340, 40, 4
154
- step = total_w / (n - 1)
155
- for i in range(n):
156
- print(f"circle-{i}: cx={round(i * step)} cy={cy} r={r}")
157
- ```
158
-
159
- **最大包围盒 → whiteboard 尺寸**
160
-
161
- 所有元素坐标算完后,汇总出整体包围盒,直接作为 whiteboard 的 `width`/`height`:
162
-
163
- ```python
164
- # 每个元素登记 (x, y, w, h),含 stroke 外扩
165
- elements = [
166
- (10, 20, 80, 160), # item-0
167
- (107, 10, 80, 170), # item-1
168
- (204, 40, 80, 140), # item-2
169
- (0, 0, 300, 1), # x-axis
170
- ]
171
-
172
- xs = [x for x, y, w, h in elements]
173
- ys = [y for x, y, w, h in elements]
174
- x2 = [x + w for x, y, w, h in elements]
175
- y2 = [y + h for x, y, w, h in elements]
176
-
177
- wb_w = max(x2) - min(xs)
178
- wb_h = max(y2) - min(ys)
179
- print(f"whiteboard width={wb_w} height={wb_h}")
180
- ```
181
-
182
- 输出即 `<whiteboard width=... height=...>` 的值,无需手动估算。
183
-
184
- ---
185
- ### 布局模式
186
-
187
- **全屏装饰层**
188
- ```xml
189
- <whiteboard width="960" height="540" topLeftX="0" topLeftY="0">
190
- <svg xmlns="http://www.w3.org/2000/svg">
191
- ...
192
- </svg>
193
- </whiteboard>
194
- ```
195
-
196
- > ⚠️ 全屏装饰 whiteboard 必须放在所有 `<shape>` / `<img>` / `<table>` 之前,否则会遮挡文字内容。XML 中元素位置越靠后,渲染层级越高。
197
-
198
- **侧栏图表(与文字 shape 并排)**
199
- ```xml
200
- <!-- 左侧文字 -->
201
- <shape type="text" topLeftX="60" topLeftY="120" width="500" height="340">...</shape>
202
- <!-- 右侧图表 -->
203
- <whiteboard width="340" height="340" topLeftX="580" topLeftY="120">
204
- <svg xmlns="http://www.w3.org/2000/svg">
205
- ...
206
- </svg>
207
- </whiteboard>
208
- ```
209
-
210
- **底部装饰条**
211
- ```xml
212
- <whiteboard width="960" height="100" topLeftX="0" topLeftY="440">
213
- <svg xmlns="http://www.w3.org/2000/svg">
214
- ...
215
- </svg>
216
- </whiteboard>
217
- ```
218
-
219
- ---
220
-
221
- ### 禁止使用的 SVG 特性
222
-
223
- 以下特性在 slide `<whiteboard>` 渲染端不支持或行为不可预测,必须避免:
224
-
225
- | 禁止 | 原因 | 替代方案 |
226
- |------|------|---------|
227
- | `<radialGradient>` | 渲染失败 | 用 `<linearGradient>` 或 `rgba()` 透明度模拟深浅层次 |
228
- | `<filter>`(阴影、模糊等) | 渲染失败 | 用半透明 `<rect>` 叠加模拟阴影 |
229
- | `<clipPath>` / `<mask>` | 渲染失败 | 调整元素坐标和尺寸自然裁切 |
230
- | `<pattern>` | 渲染失败 | 手动铺 `<circle>` / `<rect>` 点阵 |
231
- | `skewX` / `skewY` / `matrix(...)` | 空间扭曲,降级渲染 | 用 `rotate` + `translate` 替代 |
232
- | `<image>` 外链 URL | 不支持外链 | 先上传得到 file_token,再用 `<img>` 元素 |
233
-
234
- ---
235
-
236
-
237
- ## 模式二:Mermaid
238
-
239
- ### 语法
240
-
241
- ```xml
242
- <whiteboard topLeftX="72" topLeftY="60" width="816" height="360">
243
- <mermaid>
244
- <![CDATA[
245
- flowchart TD
246
- A[检查 lark-cli 与 jq] --> B[编写每页 slide XML]
247
- B --> C[通过 jq 生成 slides JSON]
248
- C --> D[执行 slides +create]
249
- D --> E[读取 xml_presentation_id]
250
- E --> F[回读并验证创建结果]
251
- ]]>
252
- </mermaid>
253
- </whiteboard>
254
- ```
255
-
256
- **关键点:**
257
- - 内容用 `<![CDATA[...]]>` 包裹——Mermaid 语法里的 `[`、`>`、`-->` 是 XML 特殊字符,CDATA 避免转义问题
258
- - whiteboard 只需 `topLeftX`、`topLeftY`、`width`、`height`
259
-
260
- ### 支持的 Mermaid 图表类型
261
-
262
- | 类型 | 关键字 | 适用场景 |
263
- |------|--------|---------|
264
- | 流程图 | `flowchart TD` / `flowchart LR` | 业务流程、决策树、工作流 |
265
- | 时序图 | `sequenceDiagram` | 系统交互、API 调用链 |
266
- | 甘特图 | `gantt` | 项目计划、里程碑 |
267
- | 类图 | `classDiagram` | 对象关系、架构设计 |
268
- | ER 图 | `erDiagram` | 数据库结构 |
269
- | 状态图 | `stateDiagram-v2` | 状态机、生命周期 |
270
- | 思维导图 | `mindmap` | 主题梳理、知识架构 |
271
- | 用户旅程 | `journey` | 用户体验路径 |
272
-
273
- ### Mermaid 布局建议
274
-
275
- Mermaid 图表会自动撑满 whiteboard 区域。建议:
276
- - 流程图留足高度,节点较多时适当增加 height(比如 400-480)
277
- - 避免一页放超过 15 个节点,内容太密时考虑分页
278
- - 推荐尺寸参考:
279
-
280
- | 图表类型 | 建议 width | 建议 height |
281
- |---------|-----------|------------|
282
- | 流程图(5-8 节点) | 720-816 | 300-400 |
283
- | 时序图(3-5 参与者) | 720-816 | 320-420 |
284
- | 甘特图 | 816 | 280-360 |
285
- | 思维导图 | 816 | 380-480 |
286
-
287
- ---
288
-
289
- ## 注意事项 & 已知问题
290
-
291
- ### z-order(SVG 模式)
292
-
293
- whiteboard 在 XML 中的位置决定渲染层级:在 shape 前 → 在下层;在 shape 后 → 在上层。全屏装饰 whiteboard 应放在所有 shape 之前。
294
-
295
- ### Mermaid CDATA 必要性
296
-
297
- Mermaid 语法包含 `[`、`>`、`-->`,不用 CDATA 直接写会破坏 XML 解析。始终使用 `<![CDATA[ ... ]]>`。
298
-
299
- ---
300
-
301
- ## 快速自检清单
302
-
303
- **SVG 模式——结构检查:**
304
- - [ ] `<svg>` 声明了 `xmlns="http://www.w3.org/2000/svg"`
305
- - [ ] whiteboard 的 `width`/`height` 由所有元素的最大包围盒(含 stroke 外扩)计算得出,不手动估值
306
- - [ ] `topLeftX + width ≤ 960`,`topLeftY + height ≤ 540`
307
- - [ ] 无 `<radialGradient>` / `<filter>` / `<clipPath>`
308
- - [ ] 文字 `y` 坐标为 baseline 位置,最小值 ≥ font-size(避免被裁切)
309
-
310
- **SVG 模式——视觉品质检查:**
311
- - [ ] 非原生数据视觉有必要的坐标轴、网格线、数值标注或分段说明,没有"裸点"或无解释色块
312
- - [ ] 字号有层级:标题 > 数值 > 轴标签,非全部相同
313
- - [ ] 单一数据系列用同一颜色,多系列用不同颜色且对比充足
314
- - [ ] 轴标签与图表元素互不遮挡,留有足够空间
315
- - [ ] 坐标推导有注释(写明 originX/Y、chartW/H、数据映射公式)
316
-
317
- **Mermaid 模式:**
318
- - [ ] 内容包在 `<![CDATA[...]]>` 内
319
- - [ ] CDATA 结束符 `]]>` 不出现在 Mermaid 代码本身中
320
- - [ ] `topLeftX + width ≤ 960`,`topLeftY + height ≤ 540`
321
- - [ ] 节点数量合理(单图不超过 15-20 个节点)
322
-
323
- **通用:**
324
- - [ ] XML 标签全部闭合,属性引号完整
325
- - [ ] 如果失败,检查是否是偶发 5001000,重试一次
326
-
327
- ---
328
-
329
- ## 参考
330
-
331
- - [lark-slides SKILL.md](../SKILL.md)
@@ -1,100 +0,0 @@
1
- # slides +xml-get(读取 XML)
2
-
3
- 读取已有演示文稿的完整 XML,或按 `slide_id` / 页码读取单页 XML。适合创建后验收、编辑前备份、获取 `slide_id` / `revision_id`,以及排查空白页、破图、文本溢出等问题。相比直接调用底层 `xml_presentations.get` / `xml_presentation.slide.get`,本 shortcut 会自动解析 Slides URL / Wiki URL,并可把 XML 保存到本地文件,避免终端输出被截断。
4
-
5
- ## 命令
6
-
7
-
8
- ```bash
9
- lark-cli slides +xml-get \
10
- --as user \
11
- --presentation <slides_url_or_xml_presentation_id> \
12
- --output .lark-slides/plan/<deck-id>/readback.xml
13
- ```
14
-
15
- ## 参数
16
-
17
- | 参数 | 必需 | 说明 |
18
- |------|------|------|
19
- | `--presentation` | 是 | `xml_presentation_id`、`/slides/` URL 或 `/wiki/` URL |
20
- | `--output` | 否 | 本地 XML 保存路径,必须是当前工作目录内的相对路径,不能传绝对路径。传入时 XML 内容保存到文件,stdout 只返回保存后的绝对路径、大小等简短元信息;省略时默认返回 JSON envelope |
21
- | `--slide-id` | 否 | 页面 short ID;传入后只读取该页 XML。不能和 `--slide-number` 同时使用 |
22
- | `--slide-number` | 否 | 1-based 页码;传入后只读取该页 XML。不能和 `--slide-id` 同时使用 |
23
- | `--revision-id` | 否 | 读取指定版本;默认 `-1`,表示最新版本 |
24
- | `--remove-attr-id` | 否 | 仅全文读取可用。移除返回 XML 中的 `id` 属性;适合只读检查,不适合精确块级编辑 |
25
- | `--raw` | 否 | 省略 `--output` 时直接把 XML 原文写到 stdout,不包 JSON envelope。不能和 `--output` / `--jq` / 非 json `--format` 同时使用 |
26
- | `--dry-run` | 否 | 预览将调用的 API 和输出方式,不读取真实 XML |
27
-
28
- ## 输出到文件
29
-
30
- 推荐普通工作流都传 `--output`,尤其是中大型 PPT。`--output` 必须是当前工作目录内的相对路径,例如 `.lark-slides/plan/$PID/readback.xml`,不要传 `/tmp/readback.xml` 这类绝对路径。XML 会写入本地文件,stdout 只保留元信息,便于后续脚本读取。
31
-
32
- ```bash
33
- lark-cli slides +xml-get --as user \
34
- --presentation "$PID" \
35
- --output .lark-slides/plan/$PID/readback.xml
36
- ```
37
-
38
- 成功输出中的 `data` 类似:
39
-
40
- ```json
41
- {
42
- "xml_presentation_id": "slides_example_presentation_id",
43
- "path": "/abs/path/.lark-slides/plan/slides_example_presentation_id/readback.xml",
44
- "size": 123456,
45
- "content_saved": true,
46
- "revision_id": 12
47
- }
48
- ```
49
-
50
- 其中 `path` 是 CLI 解析后的绝对路径。
51
-
52
- 如果传入 `--remove-attr-id`,返回元信息中会包含 `"remove_attr_id": true`。
53
-
54
- ## 读取单页
55
-
56
- 已知页面 short ID 时,用 `--slide-id`:
57
-
58
- ```bash
59
- lark-cli slides +xml-get --as user \
60
- --presentation "$PID" \
61
- --slide-id "$SID" \
62
- --output .lark-slides/plan/$PID/slide-$SID.xml
63
- ```
64
-
65
- 已知页码时,用 `--slide-number`(页码从 1 开始):
66
-
67
- ```bash
68
- lark-cli slides +xml-get --as user \
69
- --presentation "$PID" \
70
- --slide-number 2 \
71
- --output .lark-slides/plan/$PID/slide-2.xml
72
- ```
73
-
74
- 单页模式底层调用 `xml_presentation.slide.get`,返回或保存的是单个 `<slide>` XML 片段。`--slide-id` 和 `--slide-number` 不能同时传;`--remove-attr-id` 只支持全文读取。
75
-
76
- ## 输出到终端
77
-
78
- 省略 `--output` 时,CLI 默认输出 JSON envelope,XML 位于 `data.xml_presentation.content`(全文)或 `data.slide.content`(单页)。这个模式适合配合 `--jq` 临时提取:
79
-
80
- ```bash
81
- lark-cli slides +xml-get --as user \
82
- --presentation "$PID" \
83
- --jq '.data.xml_presentation.content'
84
- ```
85
-
86
- 需要把 XML 原文直接写到 stdout 时,加 `--raw`:
87
-
88
- ```bash
89
- lark-cli slides +xml-get --as user \
90
- --presentation "$PID" \
91
- --slide-number 2 \
92
- --raw
93
- ```
94
-
95
- ## 相关命令
96
-
97
- - [slides +screenshot](lark-slides-screenshot.md) - 获取页面截图做视觉验证
98
- - [slides +replace-slide](lark-slides-replace-slide.md) - 局部替换或插入页面元素
99
- - [slides +replace-pages](lark-slides-replace-pages.md) - 多页整页重建
100
- - [xml_presentations get](lark-slides-xml-presentations-get.md) - 底层原生 API 参考