@vodailoc/kilo-kit-mcp 1.1.0 → 1.2.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.
Files changed (582) hide show
  1. package/.mcp/kilo-kit.codex-windows.toml +5 -0
  2. package/LICENSE +190 -190
  3. package/QUICKSTART.md +265 -255
  4. package/README.md +321 -267
  5. package/mcp/README.md +64 -12
  6. package/mcp/dist/formatters.js +142 -1
  7. package/mcp/dist/orchestration-audit.js +20 -0
  8. package/mcp/dist/orchestration-memory.js +258 -0
  9. package/mcp/dist/orchestration-types.js +1 -0
  10. package/mcp/dist/orchestrator.js +222 -0
  11. package/mcp/dist/question-templates.js +249 -0
  12. package/mcp/dist/route-analytics.js +149 -0
  13. package/mcp/dist/router.js +75 -82
  14. package/mcp/dist/routing-policy-data.js +241 -0
  15. package/mcp/dist/routing-policy.js +145 -0
  16. package/mcp/dist/server.js +93 -4
  17. package/mcp/dist/smoke-env.js +18 -0
  18. package/mcp/dist/smoke.js +68 -1
  19. package/mcp/package.json +1 -2
  20. package/package.json +3 -2
  21. package/skills/README.md +647 -647
  22. package/skills/SKILLS_INDEX.md +139 -139
  23. package/skills/ai-media/ai-multimodal/.env.example +97 -97
  24. package/skills/ai-media/ai-multimodal/SKILL.md +357 -357
  25. package/skills/ai-media/ai-multimodal/references/audio-processing.md +373 -373
  26. package/skills/ai-media/ai-multimodal/references/image-generation.md +558 -558
  27. package/skills/ai-media/ai-multimodal/references/video-analysis.md +502 -502
  28. package/skills/ai-media/ai-multimodal/references/vision-understanding.md +483 -483
  29. package/skills/ai-media/ai-multimodal/scripts/document_converter.py +395 -395
  30. package/skills/ai-media/ai-multimodal/scripts/gemini_batch_process.py +480 -480
  31. package/skills/ai-media/ai-multimodal/scripts/media_optimizer.py +506 -506
  32. package/skills/ai-media/ai-multimodal/scripts/requirements.txt +26 -26
  33. package/skills/ai-media/ai-multimodal/scripts/tests/requirements.txt +20 -20
  34. package/skills/ai-media/ai-multimodal/scripts/tests/test_document_converter.py +299 -299
  35. package/skills/ai-media/ai-multimodal/scripts/tests/test_gemini_batch_process.py +362 -362
  36. package/skills/ai-media/ai-multimodal/scripts/tests/test_media_optimizer.py +373 -373
  37. package/skills/ai-media/media-processing/SKILL.md +358 -358
  38. package/skills/ai-media/media-processing/references/ffmpeg-encoding.md +358 -358
  39. package/skills/ai-media/media-processing/references/ffmpeg-filters.md +503 -503
  40. package/skills/ai-media/media-processing/references/ffmpeg-streaming.md +403 -403
  41. package/skills/ai-media/media-processing/references/format-compatibility.md +375 -375
  42. package/skills/ai-media/media-processing/references/imagemagick-batch.md +612 -612
  43. package/skills/ai-media/media-processing/references/imagemagick-editing.md +623 -623
  44. package/skills/ai-media/media-processing/scripts/batch_resize.py +342 -342
  45. package/skills/ai-media/media-processing/scripts/media_convert.py +311 -311
  46. package/skills/ai-media/media-processing/scripts/requirements.txt +24 -24
  47. package/skills/ai-media/media-processing/scripts/tests/requirements.txt +2 -2
  48. package/skills/ai-media/media-processing/scripts/tests/test_batch_resize.py +372 -372
  49. package/skills/ai-media/media-processing/scripts/tests/test_media_convert.py +259 -259
  50. package/skills/ai-media/media-processing/scripts/tests/test_video_optimize.py +397 -397
  51. package/skills/ai-media/media-processing/scripts/video_optimize.py +414 -414
  52. package/skills/ai-media/screenshot/LICENSE.txt +201 -201
  53. package/skills/ai-media/screenshot/SKILL.md +267 -267
  54. package/skills/ai-media/screenshot/agents/openai.yaml +6 -6
  55. package/skills/ai-media/screenshot/assets/screenshot-small.svg +5 -5
  56. package/skills/ai-media/screenshot/scripts/ensure_macos_permissions.sh +54 -54
  57. package/skills/ai-media/screenshot/scripts/macos_display_info.swift +22 -22
  58. package/skills/ai-media/screenshot/scripts/macos_permissions.swift +40 -40
  59. package/skills/ai-media/screenshot/scripts/macos_window_info.swift +126 -126
  60. package/skills/ai-media/screenshot/scripts/take_screenshot.ps1 +163 -163
  61. package/skills/ai-media/screenshot/scripts/take_screenshot.py +585 -585
  62. package/skills/ai-media/sora/LICENSE.txt +201 -201
  63. package/skills/ai-media/sora/SKILL.md +153 -153
  64. package/skills/ai-media/sora/agents/openai.yaml +6 -6
  65. package/skills/ai-media/sora/assets/sora-small.svg +4 -4
  66. package/skills/ai-media/sora/references/cinematic-shots.md +53 -53
  67. package/skills/ai-media/sora/references/cli.md +248 -248
  68. package/skills/ai-media/sora/references/codex-network.md +28 -28
  69. package/skills/ai-media/sora/references/prompting.md +137 -137
  70. package/skills/ai-media/sora/references/sample-prompts.md +95 -95
  71. package/skills/ai-media/sora/references/social-ads.md +42 -42
  72. package/skills/ai-media/sora/references/troubleshooting.md +58 -58
  73. package/skills/ai-media/sora/references/video-api.md +45 -45
  74. package/skills/ai-media/sora/scripts/sora.py +970 -970
  75. package/skills/design/aesthetic/SKILL.md +121 -121
  76. package/skills/design/aesthetic/assets/design-guideline-template.md +163 -163
  77. package/skills/design/aesthetic/assets/design-story-template.md +135 -135
  78. package/skills/design/aesthetic/references/design-principles.md +62 -62
  79. package/skills/design/aesthetic/references/design-resources.md +75 -75
  80. package/skills/design/aesthetic/references/micro-interactions.md +53 -53
  81. package/skills/design/aesthetic/references/storytelling-design.md +50 -50
  82. package/skills/design/figma/LICENSE.txt +202 -202
  83. package/skills/design/figma/SKILL.md +42 -42
  84. package/skills/design/figma/agents/openai.yaml +14 -14
  85. package/skills/design/figma/assets/figma-small.svg +3 -3
  86. package/skills/design/figma/assets/icon.svg +28 -28
  87. package/skills/design/figma/references/figma-mcp-config.md +35 -35
  88. package/skills/design/figma/references/figma-tools-and-prompts.md +34 -34
  89. package/skills/design/figma-implement-design/LICENSE.txt +202 -202
  90. package/skills/design/figma-implement-design/SKILL.md +264 -264
  91. package/skills/design/figma-implement-design/agents/openai.yaml +14 -14
  92. package/skills/design/figma-implement-design/assets/figma-small.svg +3 -3
  93. package/skills/design/figma-implement-design/assets/icon.svg +28 -28
  94. package/skills/design/frontend-design/SKILL.md +41 -41
  95. package/skills/design/frontend-design/references/animejs.md +395 -395
  96. package/skills/design/ui-styling/LICENSE.txt +201 -201
  97. package/skills/design/ui-styling/SKILL.md +321 -321
  98. package/skills/design/ui-styling/canvas-fonts/ArsenalSC-OFL.txt +93 -93
  99. package/skills/design/ui-styling/canvas-fonts/BigShoulders-OFL.txt +93 -93
  100. package/skills/design/ui-styling/canvas-fonts/Boldonse-OFL.txt +93 -93
  101. package/skills/design/ui-styling/canvas-fonts/BricolageGrotesque-OFL.txt +93 -93
  102. package/skills/design/ui-styling/canvas-fonts/CrimsonPro-OFL.txt +93 -93
  103. package/skills/design/ui-styling/canvas-fonts/DMMono-OFL.txt +93 -93
  104. package/skills/design/ui-styling/canvas-fonts/EricaOne-OFL.txt +94 -94
  105. package/skills/design/ui-styling/canvas-fonts/GeistMono-OFL.txt +93 -93
  106. package/skills/design/ui-styling/canvas-fonts/Gloock-OFL.txt +93 -93
  107. package/skills/design/ui-styling/canvas-fonts/IBMPlexMono-OFL.txt +93 -93
  108. package/skills/design/ui-styling/canvas-fonts/InstrumentSans-OFL.txt +93 -93
  109. package/skills/design/ui-styling/canvas-fonts/Italiana-OFL.txt +93 -93
  110. package/skills/design/ui-styling/canvas-fonts/JetBrainsMono-OFL.txt +93 -93
  111. package/skills/design/ui-styling/canvas-fonts/Jura-OFL.txt +93 -93
  112. package/skills/design/ui-styling/canvas-fonts/LibreBaskerville-OFL.txt +93 -93
  113. package/skills/design/ui-styling/canvas-fonts/Lora-OFL.txt +93 -93
  114. package/skills/design/ui-styling/canvas-fonts/NationalPark-OFL.txt +93 -93
  115. package/skills/design/ui-styling/canvas-fonts/NothingYouCouldDo-OFL.txt +93 -93
  116. package/skills/design/ui-styling/canvas-fonts/Outfit-OFL.txt +93 -93
  117. package/skills/design/ui-styling/canvas-fonts/PixelifySans-OFL.txt +93 -93
  118. package/skills/design/ui-styling/canvas-fonts/PoiretOne-OFL.txt +93 -93
  119. package/skills/design/ui-styling/canvas-fonts/RedHatMono-OFL.txt +93 -93
  120. package/skills/design/ui-styling/canvas-fonts/Silkscreen-OFL.txt +93 -93
  121. package/skills/design/ui-styling/canvas-fonts/SmoochSans-OFL.txt +93 -93
  122. package/skills/design/ui-styling/canvas-fonts/Tektur-OFL.txt +93 -93
  123. package/skills/design/ui-styling/canvas-fonts/WorkSans-OFL.txt +93 -93
  124. package/skills/design/ui-styling/canvas-fonts/YoungSerif-OFL.txt +93 -93
  125. package/skills/design/ui-styling/references/canvas-design-system.md +320 -320
  126. package/skills/design/ui-styling/references/shadcn-accessibility.md +471 -471
  127. package/skills/design/ui-styling/references/shadcn-components.md +424 -424
  128. package/skills/design/ui-styling/references/shadcn-theming.md +373 -373
  129. package/skills/design/ui-styling/references/tailwind-customization.md +483 -483
  130. package/skills/design/ui-styling/references/tailwind-responsive.md +382 -382
  131. package/skills/design/ui-styling/references/tailwind-utilities.md +455 -455
  132. package/skills/design/ui-styling/scripts/requirements.txt +17 -17
  133. package/skills/design/ui-styling/scripts/shadcn_add.py +292 -292
  134. package/skills/design/ui-styling/scripts/tailwind_config_gen.py +456 -456
  135. package/skills/design/ui-styling/scripts/tests/requirements.txt +3 -3
  136. package/skills/design/ui-styling/scripts/tests/test_shadcn_add.py +266 -266
  137. package/skills/design/ui-styling/scripts/tests/test_tailwind_config_gen.py +336 -336
  138. package/skills/engineering/aspnet-core/LICENSE.txt +201 -201
  139. package/skills/engineering/aspnet-core/SKILL.md +61 -61
  140. package/skills/engineering/aspnet-core/agents/openai.yaml +5 -5
  141. package/skills/engineering/aspnet-core/references/_sections.md +40 -40
  142. package/skills/engineering/aspnet-core/references/apis-minimal-and-controllers.md +81 -81
  143. package/skills/engineering/aspnet-core/references/data-state-and-services.md +69 -69
  144. package/skills/engineering/aspnet-core/references/program-and-pipeline.md +103 -103
  145. package/skills/engineering/aspnet-core/references/realtime-grpc-and-background-work.md +58 -58
  146. package/skills/engineering/aspnet-core/references/security-and-identity.md +75 -75
  147. package/skills/engineering/aspnet-core/references/source-map.md +43 -43
  148. package/skills/engineering/aspnet-core/references/stack-selection.md +63 -63
  149. package/skills/engineering/aspnet-core/references/testing-performance-and-operations.md +92 -92
  150. package/skills/engineering/aspnet-core/references/ui-blazor.md +53 -53
  151. package/skills/engineering/aspnet-core/references/ui-mvc.md +56 -56
  152. package/skills/engineering/aspnet-core/references/ui-razor-pages.md +55 -55
  153. package/skills/engineering/aspnet-core/references/versioning-and-upgrades.md +51 -51
  154. package/skills/engineering/backend-development/SKILL.md +95 -95
  155. package/skills/engineering/backend-development/references/backend-api-design.md +495 -495
  156. package/skills/engineering/backend-development/references/backend-architecture.md +454 -454
  157. package/skills/engineering/backend-development/references/backend-authentication.md +338 -338
  158. package/skills/engineering/backend-development/references/backend-code-quality.md +659 -659
  159. package/skills/engineering/backend-development/references/backend-debugging.md +904 -904
  160. package/skills/engineering/backend-development/references/backend-devops.md +494 -494
  161. package/skills/engineering/backend-development/references/backend-mindset.md +387 -387
  162. package/skills/engineering/backend-development/references/backend-performance.md +397 -397
  163. package/skills/engineering/backend-development/references/backend-security.md +290 -290
  164. package/skills/engineering/backend-development/references/backend-technologies.md +256 -256
  165. package/skills/engineering/backend-development/references/backend-testing.md +429 -429
  166. package/skills/engineering/better-auth/SKILL.md +204 -204
  167. package/skills/engineering/better-auth/references/advanced-features.md +553 -553
  168. package/skills/engineering/better-auth/references/database-integration.md +577 -577
  169. package/skills/engineering/better-auth/references/email-password-auth.md +416 -416
  170. package/skills/engineering/better-auth/references/oauth-providers.md +430 -430
  171. package/skills/engineering/better-auth/scripts/better_auth_init.py +521 -521
  172. package/skills/engineering/better-auth/scripts/requirements.txt +15 -15
  173. package/skills/engineering/better-auth/scripts/tests/test_better_auth_init.py +421 -421
  174. package/skills/engineering/code-review/SKILL.md +140 -140
  175. package/skills/engineering/code-review/references/code-review-reception.md +208 -208
  176. package/skills/engineering/code-review/references/requesting-code-review.md +104 -104
  177. package/skills/engineering/code-review/references/verification-before-completion.md +138 -138
  178. package/skills/engineering/context-engineering/SKILL.md +86 -86
  179. package/skills/engineering/context-engineering/references/context-compression.md +84 -84
  180. package/skills/engineering/context-engineering/references/context-degradation.md +93 -93
  181. package/skills/engineering/context-engineering/references/context-fundamentals.md +75 -75
  182. package/skills/engineering/context-engineering/references/context-optimization.md +82 -82
  183. package/skills/engineering/context-engineering/references/evaluation.md +89 -89
  184. package/skills/engineering/context-engineering/references/memory-systems.md +88 -88
  185. package/skills/engineering/context-engineering/references/multi-agent-patterns.md +90 -90
  186. package/skills/engineering/context-engineering/references/project-development.md +97 -97
  187. package/skills/engineering/context-engineering/references/tool-design.md +86 -86
  188. package/skills/engineering/context-engineering/scripts/compression_evaluator.py +329 -329
  189. package/skills/engineering/context-engineering/scripts/context_analyzer.py +294 -294
  190. package/skills/engineering/databases/SKILL.md +232 -232
  191. package/skills/engineering/databases/references/mongodb-aggregation.md +447 -447
  192. package/skills/engineering/databases/references/mongodb-atlas.md +465 -465
  193. package/skills/engineering/databases/references/mongodb-crud.md +408 -408
  194. package/skills/engineering/databases/references/mongodb-indexing.md +442 -442
  195. package/skills/engineering/databases/references/postgresql-administration.md +594 -594
  196. package/skills/engineering/databases/references/postgresql-performance.md +527 -527
  197. package/skills/engineering/databases/references/postgresql-psql-cli.md +467 -467
  198. package/skills/engineering/databases/references/postgresql-queries.md +475 -475
  199. package/skills/engineering/databases/scripts/db_backup.py +502 -502
  200. package/skills/engineering/databases/scripts/db_migrate.py +414 -414
  201. package/skills/engineering/databases/scripts/db_performance_check.py +444 -444
  202. package/skills/engineering/databases/scripts/requirements.txt +20 -20
  203. package/skills/engineering/databases/scripts/tests/requirements.txt +4 -4
  204. package/skills/engineering/databases/scripts/tests/test_db_backup.py +340 -340
  205. package/skills/engineering/databases/scripts/tests/test_db_migrate.py +277 -277
  206. package/skills/engineering/databases/scripts/tests/test_db_performance_check.py +370 -370
  207. package/skills/engineering/diagnose/SKILL.md +117 -117
  208. package/skills/engineering/diagnose/scripts/hitl-loop.template.sh +41 -41
  209. package/skills/engineering/docs-seeker/SKILL.md +207 -207
  210. package/skills/engineering/docs-seeker/WORKFLOWS.md +505 -505
  211. package/skills/engineering/docs-seeker/references/best-practices.md +632 -632
  212. package/skills/engineering/docs-seeker/references/documentation-sources.md +461 -461
  213. package/skills/engineering/docs-seeker/references/error-handling.md +621 -621
  214. package/skills/engineering/docs-seeker/references/limitations.md +821 -821
  215. package/skills/engineering/docs-seeker/references/performance.md +574 -574
  216. package/skills/engineering/docs-seeker/references/tool-selection.md +262 -262
  217. package/skills/engineering/frontend-development/SKILL.md +398 -398
  218. package/skills/engineering/frontend-development/resources/common-patterns.md +330 -330
  219. package/skills/engineering/frontend-development/resources/complete-examples.md +871 -871
  220. package/skills/engineering/frontend-development/resources/component-patterns.md +501 -501
  221. package/skills/engineering/frontend-development/resources/data-fetching.md +766 -766
  222. package/skills/engineering/frontend-development/resources/file-organization.md +501 -501
  223. package/skills/engineering/frontend-development/resources/loading-and-error-states.md +500 -500
  224. package/skills/engineering/frontend-development/resources/performance.md +405 -405
  225. package/skills/engineering/frontend-development/resources/routing-guide.md +363 -363
  226. package/skills/engineering/frontend-development/resources/styling-guide.md +427 -427
  227. package/skills/engineering/frontend-development/resources/typescript-standards.md +417 -417
  228. package/skills/engineering/improve-codebase-architecture/DEEPENING.md +37 -37
  229. package/skills/engineering/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -44
  230. package/skills/engineering/improve-codebase-architecture/LANGUAGE.md +53 -53
  231. package/skills/engineering/improve-codebase-architecture/SKILL.md +71 -71
  232. package/skills/engineering/openai-docs/LICENSE.txt +201 -201
  233. package/skills/engineering/openai-docs/SKILL.md +69 -69
  234. package/skills/engineering/openai-docs/agents/openai.yaml +14 -14
  235. package/skills/engineering/openai-docs/assets/openai-small.svg +3 -3
  236. package/skills/engineering/openai-docs/references/gpt-5p4-prompting-guide.md +433 -433
  237. package/skills/engineering/openai-docs/references/latest-model.md +35 -35
  238. package/skills/engineering/openai-docs/references/upgrading-to-gpt-5p4.md +164 -164
  239. package/skills/engineering/playwright/LICENSE.txt +201 -201
  240. package/skills/engineering/playwright/NOTICE.txt +14 -14
  241. package/skills/engineering/playwright/SKILL.md +147 -147
  242. package/skills/engineering/playwright/agents/openai.yaml +6 -6
  243. package/skills/engineering/playwright/assets/playwright-small.svg +3 -3
  244. package/skills/engineering/playwright/references/cli.md +116 -116
  245. package/skills/engineering/playwright/references/workflows.md +95 -95
  246. package/skills/engineering/playwright/scripts/playwright_cli.sh +25 -25
  247. package/skills/engineering/playwright-interactive/LICENSE.txt +201 -201
  248. package/skills/engineering/playwright-interactive/NOTICE.txt +13 -13
  249. package/skills/engineering/playwright-interactive/SKILL.md +689 -689
  250. package/skills/engineering/playwright-interactive/agents/openai.yaml +6 -6
  251. package/skills/engineering/playwright-interactive/assets/playwright-small.svg +3 -3
  252. package/skills/engineering/render-deploy/LICENSE.txt +201 -201
  253. package/skills/engineering/render-deploy/SKILL.md +479 -479
  254. package/skills/engineering/render-deploy/agents/openai.yaml +14 -14
  255. package/skills/engineering/render-deploy/assets/docker.yaml +62 -62
  256. package/skills/engineering/render-deploy/assets/go-api.yaml +35 -35
  257. package/skills/engineering/render-deploy/assets/nextjs-postgres.yaml +35 -35
  258. package/skills/engineering/render-deploy/assets/node-express.yaml +25 -25
  259. package/skills/engineering/render-deploy/assets/python-django.yaml +89 -89
  260. package/skills/engineering/render-deploy/assets/render-small.svg +3 -3
  261. package/skills/engineering/render-deploy/assets/static-site.yaml +54 -54
  262. package/skills/engineering/render-deploy/references/blueprint-spec.md +718 -718
  263. package/skills/engineering/render-deploy/references/codebase-analysis.md +49 -49
  264. package/skills/engineering/render-deploy/references/configuration-guide.md +603 -603
  265. package/skills/engineering/render-deploy/references/deployment-details.md +224 -224
  266. package/skills/engineering/render-deploy/references/direct-creation.md +113 -113
  267. package/skills/engineering/render-deploy/references/error-patterns.md +13 -13
  268. package/skills/engineering/render-deploy/references/post-deploy-checks.md +36 -36
  269. package/skills/engineering/render-deploy/references/runtimes.md +473 -473
  270. package/skills/engineering/render-deploy/references/service-types.md +450 -450
  271. package/skills/engineering/render-deploy/references/troubleshooting-basics.md +36 -36
  272. package/skills/engineering/repomix/SKILL.md +215 -215
  273. package/skills/engineering/repomix/references/configuration.md +211 -211
  274. package/skills/engineering/repomix/references/usage-patterns.md +232 -232
  275. package/skills/engineering/repomix/scripts/README.md +179 -179
  276. package/skills/engineering/repomix/scripts/repomix_batch.py +455 -455
  277. package/skills/engineering/repomix/scripts/repos.example.json +15 -15
  278. package/skills/engineering/repomix/scripts/requirements.txt +15 -15
  279. package/skills/engineering/repomix/scripts/tests/test_repomix_batch.py +531 -531
  280. package/skills/engineering/setup-matt-pocock-skills/SKILL.md +121 -121
  281. package/skills/engineering/setup-matt-pocock-skills/domain.md +51 -51
  282. package/skills/engineering/setup-matt-pocock-skills/issue-tracker-github.md +22 -22
  283. package/skills/engineering/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -23
  284. package/skills/engineering/setup-matt-pocock-skills/issue-tracker-local.md +19 -19
  285. package/skills/engineering/setup-matt-pocock-skills/triage-labels.md +15 -15
  286. package/skills/engineering/shopify/README.md +66 -66
  287. package/skills/engineering/shopify/SKILL.md +319 -319
  288. package/skills/engineering/shopify/references/app-development.md +470 -470
  289. package/skills/engineering/shopify/references/extensions.md +493 -493
  290. package/skills/engineering/shopify/references/themes.md +498 -498
  291. package/skills/engineering/shopify/scripts/requirements.txt +19 -19
  292. package/skills/engineering/shopify/scripts/shopify_init.py +423 -423
  293. package/skills/engineering/shopify/scripts/tests/test_shopify_init.py +385 -385
  294. package/skills/engineering/tdd/SKILL.md +109 -109
  295. package/skills/engineering/tdd/deep-modules.md +33 -33
  296. package/skills/engineering/tdd/interface-design.md +31 -31
  297. package/skills/engineering/tdd/mocking.md +59 -59
  298. package/skills/engineering/tdd/refactoring.md +10 -10
  299. package/skills/engineering/tdd/tests.md +61 -61
  300. package/skills/engineering/to-issues/SKILL.md +81 -81
  301. package/skills/engineering/to-prd/SKILL.md +74 -74
  302. package/skills/engineering/triage/AGENT-BRIEF.md +168 -168
  303. package/skills/engineering/triage/OUT-OF-SCOPE.md +101 -101
  304. package/skills/engineering/triage/SKILL.md +103 -103
  305. package/skills/engineering/web-frameworks/SKILL.md +324 -324
  306. package/skills/engineering/web-frameworks/references/nextjs-app-router.md +465 -465
  307. package/skills/engineering/web-frameworks/references/nextjs-data-fetching.md +459 -459
  308. package/skills/engineering/web-frameworks/references/nextjs-optimization.md +511 -511
  309. package/skills/engineering/web-frameworks/references/nextjs-server-components.md +495 -495
  310. package/skills/engineering/web-frameworks/references/remix-icon-integration.md +603 -603
  311. package/skills/engineering/web-frameworks/references/turborepo-caching.md +551 -551
  312. package/skills/engineering/web-frameworks/references/turborepo-pipelines.md +517 -517
  313. package/skills/engineering/web-frameworks/references/turborepo-setup.md +542 -542
  314. package/skills/engineering/web-frameworks/scripts/nextjs_init.py +547 -547
  315. package/skills/engineering/web-frameworks/scripts/requirements.txt +16 -16
  316. package/skills/engineering/web-frameworks/scripts/tests/requirements.txt +3 -3
  317. package/skills/engineering/web-frameworks/scripts/tests/test_nextjs_init.py +319 -319
  318. package/skills/engineering/web-frameworks/scripts/tests/test_turborepo_migrate.py +374 -374
  319. package/skills/engineering/web-frameworks/scripts/turborepo_migrate.py +394 -394
  320. package/skills/engineering/write-a-skill/SKILL.md +117 -117
  321. package/skills/kilo-kit/SKILL.md +346 -346
  322. package/skills/kilo-kit/_template/SKILL.md +185 -185
  323. package/skills/kilo-kit/debugging/root-cause/SKILL.md +360 -360
  324. package/skills/kilo-kit/debugging/systematic/SKILL.md +339 -339
  325. package/skills/kilo-kit/debugging/verification/SKILL.md +424 -424
  326. package/skills/kilo-kit/development/backend/SKILL.md +540 -540
  327. package/skills/kilo-kit/development/security/SKILL.md +529 -529
  328. package/skills/kilo-kit/quality/code-review/SKILL.md +297 -297
  329. package/skills/kilo-kit/quality/testing/SKILL.md +540 -540
  330. package/skills/kilo-kit/references/output-formats.md +204 -204
  331. package/skills/kilo-kit/references/patterns.md +156 -156
  332. package/skills/kilo-kit/references/performance-benchmarks.md +90 -90
  333. package/skills/operations/chrome-devtools/SKILL.md +392 -392
  334. package/skills/operations/chrome-devtools/references/cdp-domains.md +694 -694
  335. package/skills/operations/chrome-devtools/references/performance-guide.md +940 -940
  336. package/skills/operations/chrome-devtools/references/puppeteer-reference.md +953 -953
  337. package/skills/operations/chrome-devtools/scripts/PERSISTENT-BROWSER.md +107 -107
  338. package/skills/operations/chrome-devtools/scripts/README.md +213 -213
  339. package/skills/operations/chrome-devtools/scripts/__tests__/selector.test.js +210 -210
  340. package/skills/operations/chrome-devtools/scripts/click.js +79 -79
  341. package/skills/operations/chrome-devtools/scripts/close-persistent.js +36 -36
  342. package/skills/operations/chrome-devtools/scripts/console.js +75 -75
  343. package/skills/operations/chrome-devtools/scripts/evaluate.js +49 -49
  344. package/skills/operations/chrome-devtools/scripts/fill.js +72 -72
  345. package/skills/operations/chrome-devtools/scripts/install-deps.sh +181 -181
  346. package/skills/operations/chrome-devtools/scripts/install.sh +83 -83
  347. package/skills/operations/chrome-devtools/scripts/launch-persistent.js +71 -71
  348. package/skills/operations/chrome-devtools/scripts/lib/browser.js +144 -144
  349. package/skills/operations/chrome-devtools/scripts/lib/selector.js +178 -178
  350. package/skills/operations/chrome-devtools/scripts/navigate.js +46 -46
  351. package/skills/operations/chrome-devtools/scripts/network.js +102 -102
  352. package/skills/operations/chrome-devtools/scripts/package-lock.json +1206 -1206
  353. package/skills/operations/chrome-devtools/scripts/package.json +15 -15
  354. package/skills/operations/chrome-devtools/scripts/performance.js +145 -145
  355. package/skills/operations/chrome-devtools/scripts/screenshot.js +180 -180
  356. package/skills/operations/chrome-devtools/scripts/snapshot.js +131 -131
  357. package/skills/operations/devops/.env.example +76 -76
  358. package/skills/operations/devops/SKILL.md +285 -285
  359. package/skills/operations/devops/references/browser-rendering.md +305 -305
  360. package/skills/operations/devops/references/cloudflare-d1-kv.md +123 -123
  361. package/skills/operations/devops/references/cloudflare-platform.md +271 -271
  362. package/skills/operations/devops/references/cloudflare-r2-storage.md +280 -280
  363. package/skills/operations/devops/references/cloudflare-workers-advanced.md +312 -312
  364. package/skills/operations/devops/references/cloudflare-workers-apis.md +309 -309
  365. package/skills/operations/devops/references/cloudflare-workers-basics.md +418 -418
  366. package/skills/operations/devops/references/docker-basics.md +297 -297
  367. package/skills/operations/devops/references/docker-compose.md +292 -292
  368. package/skills/operations/devops/references/gcloud-platform.md +297 -297
  369. package/skills/operations/devops/references/gcloud-services.md +304 -304
  370. package/skills/operations/devops/scripts/cloudflare_deploy.py +269 -269
  371. package/skills/operations/devops/scripts/docker_optimize.py +320 -320
  372. package/skills/operations/devops/scripts/requirements.txt +20 -20
  373. package/skills/operations/devops/scripts/tests/requirements.txt +3 -3
  374. package/skills/operations/devops/scripts/tests/test_cloudflare_deploy.py +285 -285
  375. package/skills/operations/devops/scripts/tests/test_docker_optimize.py +436 -436
  376. package/skills/operations/mcp-builder/LICENSE.txt +201 -201
  377. package/skills/operations/mcp-builder/SKILL.md +328 -328
  378. package/skills/operations/mcp-builder/reference/evaluation.md +601 -601
  379. package/skills/operations/mcp-builder/reference/mcp_best_practices.md +915 -915
  380. package/skills/operations/mcp-builder/reference/node_mcp_server.md +915 -915
  381. package/skills/operations/mcp-builder/reference/python_mcp_server.md +751 -751
  382. package/skills/operations/mcp-builder/scripts/connections.py +151 -151
  383. package/skills/operations/mcp-builder/scripts/evaluation.py +373 -373
  384. package/skills/operations/mcp-builder/scripts/example_evaluation.xml +22 -22
  385. package/skills/operations/mcp-builder/scripts/requirements.txt +2 -2
  386. package/skills/operations/mcp-management/README.md +219 -219
  387. package/skills/operations/mcp-management/SKILL.md +175 -175
  388. package/skills/operations/mcp-management/assets/tools.json +3043 -3043
  389. package/skills/operations/mcp-management/references/configuration.md +114 -114
  390. package/skills/operations/mcp-management/references/gemini-cli-integration.md +201 -201
  391. package/skills/operations/mcp-management/references/mcp-protocol.md +116 -116
  392. package/skills/operations/mcp-management/scripts/.env.example +10 -10
  393. package/skills/operations/mcp-management/scripts/cli.ts +155 -155
  394. package/skills/operations/mcp-management/scripts/dist/analyze-tools.js +70 -70
  395. package/skills/operations/mcp-management/scripts/dist/cli.js +131 -131
  396. package/skills/operations/mcp-management/scripts/dist/mcp-client.js +115 -115
  397. package/skills/operations/mcp-management/scripts/mcp-client.ts +163 -163
  398. package/skills/operations/mcp-management/scripts/package.json +18 -18
  399. package/skills/operations/mcp-management/scripts/tsconfig.json +15 -15
  400. package/skills/problem-solving/collision-zone-thinking/SKILL.md +62 -62
  401. package/skills/problem-solving/defense-in-depth/SKILL.md +130 -130
  402. package/skills/problem-solving/inversion-exercise/SKILL.md +58 -58
  403. package/skills/problem-solving/meta-pattern-recognition/SKILL.md +54 -54
  404. package/skills/problem-solving/root-cause-tracing/SKILL.md +177 -177
  405. package/skills/problem-solving/root-cause-tracing/find-polluter.sh +63 -63
  406. package/skills/problem-solving/scale-game/SKILL.md +63 -63
  407. package/skills/problem-solving/sequential-thinking/README.md +118 -118
  408. package/skills/problem-solving/sequential-thinking/SKILL.md +93 -93
  409. package/skills/problem-solving/sequential-thinking/references/advanced.md +122 -122
  410. package/skills/problem-solving/sequential-thinking/references/examples.md +274 -274
  411. package/skills/problem-solving/simplification-cascades/SKILL.md +76 -76
  412. package/skills/problem-solving/when-stuck/SKILL.md +88 -88
  413. package/skills/productivity/caveman/SKILL.md +49 -49
  414. package/skills/productivity/grill-me/SKILL.md +10 -10
  415. package/skills/productivity/grill-with-docs/ADR-FORMAT.md +47 -47
  416. package/skills/productivity/grill-with-docs/CONTEXT-FORMAT.md +77 -77
  417. package/skills/productivity/grill-with-docs/SKILL.md +88 -88
  418. package/skills/productivity/writing-skills/graphviz-conventions.dot +171 -171
  419. package/skills/productivity/zoom-out/SKILL.md +7 -7
  420. package/skills/writing-docs/doc/LICENSE.txt +201 -201
  421. package/skills/writing-docs/doc/SKILL.md +80 -80
  422. package/skills/writing-docs/doc/agents/openai.yaml +6 -6
  423. package/skills/writing-docs/doc/assets/doc-small.svg +3 -3
  424. package/skills/writing-docs/doc/scripts/render_docx.py +296 -296
  425. package/skills/writing-docs/docx/LICENSE.txt +30 -30
  426. package/skills/writing-docs/docx/SKILL.md +196 -196
  427. package/skills/writing-docs/docx/docx-js.md +349 -349
  428. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -1499
  429. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -146
  430. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -1085
  431. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -11
  432. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -3081
  433. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -23
  434. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -185
  435. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -287
  436. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -1676
  437. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -28
  438. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -144
  439. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -174
  440. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -25
  441. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -18
  442. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -59
  443. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -56
  444. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -195
  445. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -582
  446. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -25
  447. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -4439
  448. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -570
  449. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -509
  450. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -12
  451. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -108
  452. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -96
  453. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -3646
  454. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -116
  455. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -42
  456. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -50
  457. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -49
  458. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -33
  459. package/skills/writing-docs/docx/ooxml/schemas/mce/mc.xsd +75 -75
  460. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-2010.xsd +560 -560
  461. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-2012.xsd +67 -67
  462. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-2018.xsd +14 -14
  463. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -20
  464. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -13
  465. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -4
  466. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -8
  467. package/skills/writing-docs/docx/ooxml/scripts/pack.py +159 -159
  468. package/skills/writing-docs/docx/ooxml/scripts/unpack.py +29 -29
  469. package/skills/writing-docs/docx/ooxml/scripts/validate.py +69 -69
  470. package/skills/writing-docs/docx/ooxml/scripts/validation/__init__.py +15 -15
  471. package/skills/writing-docs/docx/ooxml/scripts/validation/base.py +951 -951
  472. package/skills/writing-docs/docx/ooxml/scripts/validation/docx.py +274 -274
  473. package/skills/writing-docs/docx/ooxml/scripts/validation/pptx.py +315 -315
  474. package/skills/writing-docs/docx/ooxml/scripts/validation/redlining.py +279 -279
  475. package/skills/writing-docs/docx/ooxml.md +609 -609
  476. package/skills/writing-docs/docx/scripts/__init__.py +1 -1
  477. package/skills/writing-docs/docx/scripts/document.py +1276 -1276
  478. package/skills/writing-docs/docx/scripts/templates/comments.xml +2 -2
  479. package/skills/writing-docs/docx/scripts/templates/commentsExtended.xml +2 -2
  480. package/skills/writing-docs/docx/scripts/templates/commentsExtensible.xml +2 -2
  481. package/skills/writing-docs/docx/scripts/templates/commentsIds.xml +2 -2
  482. package/skills/writing-docs/docx/scripts/templates/people.xml +2 -2
  483. package/skills/writing-docs/docx/scripts/utilities.py +374 -374
  484. package/skills/writing-docs/mermaidjs-v11/SKILL.md +115 -115
  485. package/skills/writing-docs/mermaidjs-v11/references/cli-usage.md +228 -228
  486. package/skills/writing-docs/mermaidjs-v11/references/configuration.md +232 -232
  487. package/skills/writing-docs/mermaidjs-v11/references/diagram-types.md +315 -315
  488. package/skills/writing-docs/mermaidjs-v11/references/examples.md +344 -344
  489. package/skills/writing-docs/mermaidjs-v11/references/integration.md +310 -310
  490. package/skills/writing-docs/pdf/LICENSE.txt +30 -30
  491. package/skills/writing-docs/pdf/SKILL.md +294 -294
  492. package/skills/writing-docs/pdf/forms.md +205 -205
  493. package/skills/writing-docs/pdf/reference.md +611 -611
  494. package/skills/writing-docs/pdf/scripts/check_bounding_boxes.py +70 -70
  495. package/skills/writing-docs/pdf/scripts/check_bounding_boxes_test.py +226 -226
  496. package/skills/writing-docs/pdf/scripts/check_fillable_fields.py +12 -12
  497. package/skills/writing-docs/pdf/scripts/convert_pdf_to_images.py +35 -35
  498. package/skills/writing-docs/pdf/scripts/create_validation_image.py +41 -41
  499. package/skills/writing-docs/pdf/scripts/extract_form_field_info.py +152 -152
  500. package/skills/writing-docs/pdf/scripts/fill_fillable_fields.py +114 -114
  501. package/skills/writing-docs/pdf/scripts/fill_pdf_form_with_annotations.py +107 -107
  502. package/skills/writing-docs/pptx/LICENSE.txt +30 -30
  503. package/skills/writing-docs/pptx/SKILL.md +483 -483
  504. package/skills/writing-docs/pptx/html2pptx.md +624 -624
  505. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -1499
  506. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -146
  507. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -1085
  508. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -11
  509. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -3081
  510. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -23
  511. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -185
  512. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -287
  513. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -1676
  514. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -28
  515. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -144
  516. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -174
  517. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -25
  518. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -18
  519. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -59
  520. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -56
  521. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -195
  522. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -582
  523. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -25
  524. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -4439
  525. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -570
  526. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -509
  527. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -12
  528. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -108
  529. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -96
  530. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -3646
  531. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -116
  532. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -42
  533. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -50
  534. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -49
  535. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -33
  536. package/skills/writing-docs/pptx/ooxml/schemas/mce/mc.xsd +75 -75
  537. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-2010.xsd +560 -560
  538. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-2012.xsd +67 -67
  539. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-2018.xsd +14 -14
  540. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -20
  541. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -13
  542. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -4
  543. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -8
  544. package/skills/writing-docs/pptx/ooxml/scripts/pack.py +159 -159
  545. package/skills/writing-docs/pptx/ooxml/scripts/unpack.py +29 -29
  546. package/skills/writing-docs/pptx/ooxml/scripts/validate.py +69 -69
  547. package/skills/writing-docs/pptx/ooxml/scripts/validation/__init__.py +15 -15
  548. package/skills/writing-docs/pptx/ooxml/scripts/validation/base.py +951 -951
  549. package/skills/writing-docs/pptx/ooxml/scripts/validation/docx.py +274 -274
  550. package/skills/writing-docs/pptx/ooxml/scripts/validation/pptx.py +315 -315
  551. package/skills/writing-docs/pptx/ooxml/scripts/validation/redlining.py +279 -279
  552. package/skills/writing-docs/pptx/ooxml.md +426 -426
  553. package/skills/writing-docs/pptx/scripts/html2pptx.js +978 -978
  554. package/skills/writing-docs/pptx/scripts/inventory.py +1020 -1020
  555. package/skills/writing-docs/pptx/scripts/rearrange.py +231 -231
  556. package/skills/writing-docs/pptx/scripts/replace.py +385 -385
  557. package/skills/writing-docs/pptx/scripts/thumbnail.py +450 -450
  558. package/skills/writing-docs/slides/LICENSE.txt +201 -201
  559. package/skills/writing-docs/slides/SKILL.md +71 -71
  560. package/skills/writing-docs/slides/agents/openai.yaml +6 -6
  561. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/code.js +104 -104
  562. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/image.js +333 -333
  563. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/index.js +33 -33
  564. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/latex.js +51 -51
  565. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/layout.js +643 -643
  566. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/layout_builders.js +358 -358
  567. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/svg.js +36 -36
  568. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/text.js +789 -789
  569. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/util.js +24 -24
  570. package/skills/writing-docs/slides/assets/slides-small.svg +3 -3
  571. package/skills/writing-docs/slides/references/pptxgenjs-helpers.md +61 -61
  572. package/skills/writing-docs/slides/scripts/create_montage.py +300 -300
  573. package/skills/writing-docs/slides/scripts/detect_font.py +873 -873
  574. package/skills/writing-docs/slides/scripts/ensure_raster_image.py +202 -202
  575. package/skills/writing-docs/slides/scripts/render_slides.py +273 -273
  576. package/skills/writing-docs/slides/scripts/slides_test.py +201 -201
  577. package/skills/writing-docs/template-skill/SKILL.md +26 -26
  578. package/skills/writing-docs/xlsx/LICENSE.txt +30 -30
  579. package/skills/writing-docs/xlsx/SKILL.md +288 -288
  580. package/skills/writing-docs/xlsx/recalc.py +177 -177
  581. package/src/core/KILO_MASTER.md +448 -448
  582. package/src/tools/validate-skill.js +421 -421
@@ -1,610 +1,610 @@
1
- # Office Open XML Technical Reference
2
-
3
- **Important: Read this entire document before starting.** This document covers:
4
- - [Technical Guidelines](#technical-guidelines) - Schema compliance rules and validation requirements
5
- - [Document Content Patterns](#document-content-patterns) - XML patterns for headings, lists, tables, formatting, etc.
6
- - [Document Library (Python)](#document-library-python) - Recommended approach for OOXML manipulation with automatic infrastructure setup
7
- - [Tracked Changes (Redlining)](#tracked-changes-redlining) - XML patterns for implementing tracked changes
8
-
9
- ## Technical Guidelines
10
-
11
- ### Schema Compliance
12
- - **Element ordering in `<w:pPr>`**: `<w:pStyle>`, `<w:numPr>`, `<w:spacing>`, `<w:ind>`, `<w:jc>`
13
- - **Whitespace**: Add `xml:space='preserve'` to `<w:t>` elements with leading/trailing spaces
14
- - **Unicode**: Escape characters in ASCII content: `"` becomes `&#8220;`
15
- - **Character encoding reference**: Curly quotes `""` become `&#8220;&#8221;`, apostrophe `'` becomes `&#8217;`, em-dash `—` becomes `&#8212;`
16
- - **Tracked changes**: Use `<w:del>` and `<w:ins>` tags with `w:author="Claude"` outside `<w:r>` elements
17
- - **Critical**: `<w:ins>` closes with `</w:ins>`, `<w:del>` closes with `</w:del>` - never mix
18
- - **RSIDs must be 8-digit hex**: Use values like `00AB1234` (only 0-9, A-F characters)
19
- - **trackRevisions placement**: Add `<w:trackRevisions/>` after `<w:proofState>` in settings.xml
20
- - **Images**: Add to `word/media/`, reference in `document.xml`, set dimensions to prevent overflow
21
-
22
- ## Document Content Patterns
23
-
24
- ### Basic Structure
25
- ```xml
26
- <w:p>
27
- <w:r><w:t>Text content</w:t></w:r>
28
- </w:p>
29
- ```
30
-
31
- ### Headings and Styles
32
- ```xml
33
- <w:p>
34
- <w:pPr>
35
- <w:pStyle w:val="Title"/>
36
- <w:jc w:val="center"/>
37
- </w:pPr>
38
- <w:r><w:t>Document Title</w:t></w:r>
39
- </w:p>
40
-
41
- <w:p>
42
- <w:pPr><w:pStyle w:val="Heading2"/></w:pPr>
43
- <w:r><w:t>Section Heading</w:t></w:r>
44
- </w:p>
45
- ```
46
-
47
- ### Text Formatting
48
- ```xml
49
- <!-- Bold -->
50
- <w:r><w:rPr><w:b/><w:bCs/></w:rPr><w:t>Bold</w:t></w:r>
51
- <!-- Italic -->
52
- <w:r><w:rPr><w:i/><w:iCs/></w:rPr><w:t>Italic</w:t></w:r>
53
- <!-- Underline -->
54
- <w:r><w:rPr><w:u w:val="single"/></w:rPr><w:t>Underlined</w:t></w:r>
55
- <!-- Highlight -->
56
- <w:r><w:rPr><w:highlight w:val="yellow"/></w:rPr><w:t>Highlighted</w:t></w:r>
57
- ```
58
-
59
- ### Lists
60
- ```xml
61
- <!-- Numbered list -->
62
- <w:p>
63
- <w:pPr>
64
- <w:pStyle w:val="ListParagraph"/>
65
- <w:numPr><w:ilvl w:val="0"/><w:numId w:val="1"/></w:numPr>
66
- <w:spacing w:before="240"/>
67
- </w:pPr>
68
- <w:r><w:t>First item</w:t></w:r>
69
- </w:p>
70
-
71
- <!-- Restart numbered list at 1 - use different numId -->
72
- <w:p>
73
- <w:pPr>
74
- <w:pStyle w:val="ListParagraph"/>
75
- <w:numPr><w:ilvl w:val="0"/><w:numId w:val="2"/></w:numPr>
76
- <w:spacing w:before="240"/>
77
- </w:pPr>
78
- <w:r><w:t>New list item 1</w:t></w:r>
79
- </w:p>
80
-
81
- <!-- Bullet list (level 2) -->
82
- <w:p>
83
- <w:pPr>
84
- <w:pStyle w:val="ListParagraph"/>
85
- <w:numPr><w:ilvl w:val="1"/><w:numId w:val="1"/></w:numPr>
86
- <w:spacing w:before="240"/>
87
- <w:ind w:left="900"/>
88
- </w:pPr>
89
- <w:r><w:t>Bullet item</w:t></w:r>
90
- </w:p>
91
- ```
92
-
93
- ### Tables
94
- ```xml
95
- <w:tbl>
96
- <w:tblPr>
97
- <w:tblStyle w:val="TableGrid"/>
98
- <w:tblW w:w="0" w:type="auto"/>
99
- </w:tblPr>
100
- <w:tblGrid>
101
- <w:gridCol w:w="4675"/><w:gridCol w:w="4675"/>
102
- </w:tblGrid>
103
- <w:tr>
104
- <w:tc>
105
- <w:tcPr><w:tcW w:w="4675" w:type="dxa"/></w:tcPr>
106
- <w:p><w:r><w:t>Cell 1</w:t></w:r></w:p>
107
- </w:tc>
108
- <w:tc>
109
- <w:tcPr><w:tcW w:w="4675" w:type="dxa"/></w:tcPr>
110
- <w:p><w:r><w:t>Cell 2</w:t></w:r></w:p>
111
- </w:tc>
112
- </w:tr>
113
- </w:tbl>
114
- ```
115
-
116
- ### Layout
117
- ```xml
118
- <!-- Page break before new section (common pattern) -->
119
- <w:p>
120
- <w:r>
121
- <w:br w:type="page"/>
122
- </w:r>
123
- </w:p>
124
- <w:p>
125
- <w:pPr>
126
- <w:pStyle w:val="Heading1"/>
127
- </w:pPr>
128
- <w:r>
129
- <w:t>New Section Title</w:t>
130
- </w:r>
131
- </w:p>
132
-
133
- <!-- Centered paragraph -->
134
- <w:p>
135
- <w:pPr>
136
- <w:spacing w:before="240" w:after="0"/>
137
- <w:jc w:val="center"/>
138
- </w:pPr>
139
- <w:r><w:t>Centered text</w:t></w:r>
140
- </w:p>
141
-
142
- <!-- Font change - paragraph level (applies to all runs) -->
143
- <w:p>
144
- <w:pPr>
145
- <w:rPr><w:rFonts w:ascii="Courier New" w:hAnsi="Courier New"/></w:rPr>
146
- </w:pPr>
147
- <w:r><w:t>Monospace text</w:t></w:r>
148
- </w:p>
149
-
150
- <!-- Font change - run level (specific to this text) -->
151
- <w:p>
152
- <w:r>
153
- <w:rPr><w:rFonts w:ascii="Courier New" w:hAnsi="Courier New"/></w:rPr>
154
- <w:t>This text is Courier New</w:t>
155
- </w:r>
156
- <w:r><w:t> and this text uses default font</w:t></w:r>
157
- </w:p>
158
- ```
159
-
160
- ## File Updates
161
-
162
- When adding content, update these files:
163
-
164
- **`word/_rels/document.xml.rels`:**
165
- ```xml
166
- <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" Target="numbering.xml"/>
167
- <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/image1.png"/>
168
- ```
169
-
170
- **`[Content_Types].xml`:**
171
- ```xml
172
- <Default Extension="png" ContentType="image/png"/>
173
- <Override PartName="/word/numbering.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml"/>
174
- ```
175
-
176
- ### Images
177
- **CRITICAL**: Calculate dimensions to prevent page overflow and maintain aspect ratio.
178
-
179
- ```xml
180
- <!-- Minimal required structure -->
181
- <w:p>
182
- <w:r>
183
- <w:drawing>
184
- <wp:inline>
185
- <wp:extent cx="2743200" cy="1828800"/>
186
- <wp:docPr id="1" name="Picture 1"/>
187
- <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
188
- <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
189
- <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
190
- <pic:nvPicPr>
191
- <pic:cNvPr id="0" name="image1.png"/>
192
- <pic:cNvPicPr/>
193
- </pic:nvPicPr>
194
- <pic:blipFill>
195
- <a:blip r:embed="rId5"/>
196
- <!-- Add for stretch fill with aspect ratio preservation -->
197
- <a:stretch>
198
- <a:fillRect/>
199
- </a:stretch>
200
- </pic:blipFill>
201
- <pic:spPr>
202
- <a:xfrm>
203
- <a:ext cx="2743200" cy="1828800"/>
204
- </a:xfrm>
205
- <a:prstGeom prst="rect"/>
206
- </pic:spPr>
207
- </pic:pic>
208
- </a:graphicData>
209
- </a:graphic>
210
- </wp:inline>
211
- </w:drawing>
212
- </w:r>
213
- </w:p>
214
- ```
215
-
216
- ### Links (Hyperlinks)
217
-
218
- **IMPORTANT**: All hyperlinks (both internal and external) require the Hyperlink style to be defined in styles.xml. Without this style, links will look like regular text instead of blue underlined clickable links.
219
-
220
- **External Links:**
221
- ```xml
222
- <!-- In document.xml -->
223
- <w:hyperlink r:id="rId5">
224
- <w:r>
225
- <w:rPr><w:rStyle w:val="Hyperlink"/></w:rPr>
226
- <w:t>Link Text</w:t>
227
- </w:r>
228
- </w:hyperlink>
229
-
230
- <!-- In word/_rels/document.xml.rels -->
231
- <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
232
- Target="https://www.example.com/" TargetMode="External"/>
233
- ```
234
-
235
- **Internal Links:**
236
-
237
- ```xml
238
- <!-- Link to bookmark -->
239
- <w:hyperlink w:anchor="myBookmark">
240
- <w:r>
241
- <w:rPr><w:rStyle w:val="Hyperlink"/></w:rPr>
242
- <w:t>Link Text</w:t>
243
- </w:r>
244
- </w:hyperlink>
245
-
246
- <!-- Bookmark target -->
247
- <w:bookmarkStart w:id="0" w:name="myBookmark"/>
248
- <w:r><w:t>Target content</w:t></w:r>
249
- <w:bookmarkEnd w:id="0"/>
250
- ```
251
-
252
- **Hyperlink Style (required in styles.xml):**
253
- ```xml
254
- <w:style w:type="character" w:styleId="Hyperlink">
255
- <w:name w:val="Hyperlink"/>
256
- <w:basedOn w:val="DefaultParagraphFont"/>
257
- <w:uiPriority w:val="99"/>
258
- <w:unhideWhenUsed/>
259
- <w:rPr>
260
- <w:color w:val="467886" w:themeColor="hyperlink"/>
261
- <w:u w:val="single"/>
262
- </w:rPr>
263
- </w:style>
264
- ```
265
-
266
- ## Document Library (Python)
267
-
268
- Use the Document class from `scripts/document.py` for all tracked changes and comments. It automatically handles infrastructure setup (people.xml, RSIDs, settings.xml, comment files, relationships, content types). Only use direct XML manipulation for complex scenarios not supported by the library.
269
-
270
- **Working with Unicode and Entities:**
271
- - **Searching**: Both entity notation and Unicode characters work - `contains="&#8220;Company"` and `contains="\u201cCompany"` find the same text
272
- - **Replacing**: Use either entities (`&#8220;`) or Unicode (`\u201c`) - both work and will be converted appropriately based on the file's encoding (ascii → entities, utf-8 → Unicode)
273
-
274
- ### Initialization
275
-
276
- **Find the docx skill root** (directory containing `scripts/` and `ooxml/`):
277
- ```bash
278
- # Search for document.py to locate the skill root
279
- # Note: /mnt/skills is used here as an example; check your context for the actual location
280
- find /mnt/skills -name "document.py" -path "*/docx/scripts/*" 2>/dev/null | head -1
281
- # Example output: /mnt/skills/docx/scripts/document.py
282
- # Skill root is: /mnt/skills/docx
283
- ```
284
-
285
- **Run your script with PYTHONPATH** set to the docx skill root:
286
- ```bash
287
- PYTHONPATH=/mnt/skills/docx python your_script.py
288
- ```
289
-
290
- **In your script**, import from the skill root:
291
- ```python
292
- from scripts.document import Document, DocxXMLEditor
293
-
294
- # Basic initialization (automatically creates temp copy and sets up infrastructure)
295
- doc = Document('unpacked')
296
-
297
- # Customize author and initials
298
- doc = Document('unpacked', author="John Doe", initials="JD")
299
-
300
- # Enable track revisions mode
301
- doc = Document('unpacked', track_revisions=True)
302
-
303
- # Specify custom RSID (auto-generated if not provided)
304
- doc = Document('unpacked', rsid="07DC5ECB")
305
- ```
306
-
307
- ### Creating Tracked Changes
308
-
309
- **CRITICAL**: Only mark text that actually changes. Keep ALL unchanged text outside `<w:del>`/`<w:ins>` tags. Marking unchanged text makes edits unprofessional and harder to review.
310
-
311
- **Attribute Handling**: The Document class auto-injects attributes (w:id, w:date, w:rsidR, w:rsidDel, w16du:dateUtc, xml:space) into new elements. When preserving unchanged text from the original document, copy the original `<w:r>` element with its existing attributes to maintain document integrity.
312
-
313
- **Method Selection Guide**:
314
- - **Adding your own changes to regular text**: Use `replace_node()` with `<w:del>`/`<w:ins>` tags, or `suggest_deletion()` for removing entire `<w:r>` or `<w:p>` elements
315
- - **Partially modifying another author's tracked change**: Use `replace_node()` to nest your changes inside their `<w:ins>`/`<w:del>`
316
- - **Completely rejecting another author's insertion**: Use `revert_insertion()` on the `<w:ins>` element (NOT `suggest_deletion()`)
317
- - **Completely rejecting another author's deletion**: Use `revert_deletion()` on the `<w:del>` element to restore deleted content using tracked changes
318
-
319
- ```python
320
- # Minimal edit - change one word: "The report is monthly" → "The report is quarterly"
321
- # Original: <w:r w:rsidR="00AB12CD"><w:rPr><w:rFonts w:ascii="Calibri"/></w:rPr><w:t>The report is monthly</w:t></w:r>
322
- node = doc["word/document.xml"].get_node(tag="w:r", contains="The report is monthly")
323
- rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
324
- replacement = f'<w:r w:rsidR="00AB12CD">{rpr}<w:t>The report is </w:t></w:r><w:del><w:r>{rpr}<w:delText>monthly</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>quarterly</w:t></w:r></w:ins>'
325
- doc["word/document.xml"].replace_node(node, replacement)
326
-
327
- # Minimal edit - change number: "within 30 days" → "within 45 days"
328
- # Original: <w:r w:rsidR="00XYZ789"><w:rPr><w:rFonts w:ascii="Calibri"/></w:rPr><w:t>within 30 days</w:t></w:r>
329
- node = doc["word/document.xml"].get_node(tag="w:r", contains="within 30 days")
330
- rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
331
- replacement = f'<w:r w:rsidR="00XYZ789">{rpr}<w:t>within </w:t></w:r><w:del><w:r>{rpr}<w:delText>30</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>45</w:t></w:r></w:ins><w:r w:rsidR="00XYZ789">{rpr}<w:t> days</w:t></w:r>'
332
- doc["word/document.xml"].replace_node(node, replacement)
333
-
334
- # Complete replacement - preserve formatting even when replacing all text
335
- node = doc["word/document.xml"].get_node(tag="w:r", contains="apple")
336
- rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
337
- replacement = f'<w:del><w:r>{rpr}<w:delText>apple</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>banana orange</w:t></w:r></w:ins>'
338
- doc["word/document.xml"].replace_node(node, replacement)
339
-
340
- # Insert new content (no attributes needed - auto-injected)
341
- node = doc["word/document.xml"].get_node(tag="w:r", contains="existing text")
342
- doc["word/document.xml"].insert_after(node, '<w:ins><w:r><w:t>new text</w:t></w:r></w:ins>')
343
-
344
- # Partially delete another author's insertion
345
- # Original: <w:ins w:author="Jane Smith" w:date="..."><w:r><w:t>quarterly financial report</w:t></w:r></w:ins>
346
- # Goal: Delete only "financial" to make it "quarterly report"
347
- node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
348
- # IMPORTANT: Preserve w:author="Jane Smith" on the outer <w:ins> to maintain authorship
349
- replacement = '''<w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
350
- <w:r><w:t>quarterly </w:t></w:r>
351
- <w:del><w:r><w:delText>financial </w:delText></w:r></w:del>
352
- <w:r><w:t>report</w:t></w:r>
353
- </w:ins>'''
354
- doc["word/document.xml"].replace_node(node, replacement)
355
-
356
- # Change part of another author's insertion
357
- # Original: <w:ins w:author="Jane Smith"><w:r><w:t>in silence, safe and sound</w:t></w:r></w:ins>
358
- # Goal: Change "safe and sound" to "soft and unbound"
359
- node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "8"})
360
- replacement = f'''<w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
361
- <w:r><w:t>in silence, </w:t></w:r>
362
- </w:ins>
363
- <w:ins>
364
- <w:r><w:t>soft and unbound</w:t></w:r>
365
- </w:ins>
366
- <w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
367
- <w:del><w:r><w:delText>safe and sound</w:delText></w:r></w:del>
368
- </w:ins>'''
369
- doc["word/document.xml"].replace_node(node, replacement)
370
-
371
- # Delete entire run (use only when deleting all content; use replace_node for partial deletions)
372
- node = doc["word/document.xml"].get_node(tag="w:r", contains="text to delete")
373
- doc["word/document.xml"].suggest_deletion(node)
374
-
375
- # Delete entire paragraph (in-place, handles both regular and numbered list paragraphs)
376
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph to delete")
377
- doc["word/document.xml"].suggest_deletion(para)
378
-
379
- # Add new numbered list item
380
- target_para = doc["word/document.xml"].get_node(tag="w:p", contains="existing list item")
381
- pPr = tags[0].toxml() if (tags := target_para.getElementsByTagName("w:pPr")) else ""
382
- new_item = f'<w:p>{pPr}<w:r><w:t>New item</w:t></w:r></w:p>'
383
- tracked_para = DocxXMLEditor.suggest_paragraph(new_item)
384
- doc["word/document.xml"].insert_after(target_para, tracked_para)
385
- # Optional: add spacing paragraph before content for better visual separation
386
- # spacing = DocxXMLEditor.suggest_paragraph('<w:p><w:pPr><w:pStyle w:val="ListParagraph"/></w:pPr></w:p>')
387
- # doc["word/document.xml"].insert_after(target_para, spacing + tracked_para)
388
- ```
389
-
390
- ### Adding Comments
391
-
392
- ```python
393
- # Add comment spanning two existing tracked changes
394
- # Note: w:id is auto-generated. Only search by w:id if you know it from XML inspection
395
- start_node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
396
- end_node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "2"})
397
- doc.add_comment(start=start_node, end=end_node, text="Explanation of this change")
398
-
399
- # Add comment on a paragraph
400
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
401
- doc.add_comment(start=para, end=para, text="Comment on this paragraph")
402
-
403
- # Add comment on newly created tracked change
404
- # First create the tracked change
405
- node = doc["word/document.xml"].get_node(tag="w:r", contains="old")
406
- new_nodes = doc["word/document.xml"].replace_node(
407
- node,
408
- '<w:del><w:r><w:delText>old</w:delText></w:r></w:del><w:ins><w:r><w:t>new</w:t></w:r></w:ins>'
409
- )
410
- # Then add comment on the newly created elements
411
- # new_nodes[0] is the <w:del>, new_nodes[1] is the <w:ins>
412
- doc.add_comment(start=new_nodes[0], end=new_nodes[1], text="Changed old to new per requirements")
413
-
414
- # Reply to existing comment
415
- doc.reply_to_comment(parent_comment_id=0, text="I agree with this change")
416
- ```
417
-
418
- ### Rejecting Tracked Changes
419
-
420
- **IMPORTANT**: Use `revert_insertion()` to reject insertions and `revert_deletion()` to restore deletions using tracked changes. Use `suggest_deletion()` only for regular unmarked content.
421
-
422
- ```python
423
- # Reject insertion (wraps it in deletion)
424
- # Use this when another author inserted text that you want to delete
425
- ins = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
426
- nodes = doc["word/document.xml"].revert_insertion(ins) # Returns [ins]
427
-
428
- # Reject deletion (creates insertion to restore deleted content)
429
- # Use this when another author deleted text that you want to restore
430
- del_elem = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "3"})
431
- nodes = doc["word/document.xml"].revert_deletion(del_elem) # Returns [del_elem, new_ins]
432
-
433
- # Reject all insertions in a paragraph
434
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
435
- nodes = doc["word/document.xml"].revert_insertion(para) # Returns [para]
436
-
437
- # Reject all deletions in a paragraph
438
- para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
439
- nodes = doc["word/document.xml"].revert_deletion(para) # Returns [para]
440
- ```
441
-
442
- ### Inserting Images
443
-
444
- **CRITICAL**: The Document class works with a temporary copy at `doc.unpacked_path`. Always copy images to this temp directory, not the original unpacked folder.
445
-
446
- ```python
447
- from PIL import Image
448
- import shutil, os
449
-
450
- # Initialize document first
451
- doc = Document('unpacked')
452
-
453
- # Copy image and calculate full-width dimensions with aspect ratio
454
- media_dir = os.path.join(doc.unpacked_path, 'word/media')
455
- os.makedirs(media_dir, exist_ok=True)
456
- shutil.copy('image.png', os.path.join(media_dir, 'image1.png'))
457
- img = Image.open(os.path.join(media_dir, 'image1.png'))
458
- width_emus = int(6.5 * 914400) # 6.5" usable width, 914400 EMUs/inch
459
- height_emus = int(width_emus * img.size[1] / img.size[0])
460
-
461
- # Add relationship and content type
462
- rels_editor = doc['word/_rels/document.xml.rels']
463
- next_rid = rels_editor.get_next_rid()
464
- rels_editor.append_to(rels_editor.dom.documentElement,
465
- f'<Relationship Id="{next_rid}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/image1.png"/>')
466
- doc['[Content_Types].xml'].append_to(doc['[Content_Types].xml'].dom.documentElement,
467
- '<Default Extension="png" ContentType="image/png"/>')
468
-
469
- # Insert image
470
- node = doc["word/document.xml"].get_node(tag="w:p", line_number=100)
471
- doc["word/document.xml"].insert_after(node, f'''<w:p>
472
- <w:r>
473
- <w:drawing>
474
- <wp:inline distT="0" distB="0" distL="0" distR="0">
475
- <wp:extent cx="{width_emus}" cy="{height_emus}"/>
476
- <wp:docPr id="1" name="Picture 1"/>
477
- <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
478
- <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
479
- <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
480
- <pic:nvPicPr><pic:cNvPr id="1" name="image1.png"/><pic:cNvPicPr/></pic:nvPicPr>
481
- <pic:blipFill><a:blip r:embed="{next_rid}"/><a:stretch><a:fillRect/></a:stretch></pic:blipFill>
482
- <pic:spPr><a:xfrm><a:ext cx="{width_emus}" cy="{height_emus}"/></a:xfrm><a:prstGeom prst="rect"><a:avLst/></a:prstGeom></pic:spPr>
483
- </pic:pic>
484
- </a:graphicData>
485
- </a:graphic>
486
- </wp:inline>
487
- </w:drawing>
488
- </w:r>
489
- </w:p>''')
490
- ```
491
-
492
- ### Getting Nodes
493
-
494
- ```python
495
- # By text content
496
- node = doc["word/document.xml"].get_node(tag="w:p", contains="specific text")
497
-
498
- # By line range
499
- para = doc["word/document.xml"].get_node(tag="w:p", line_number=range(100, 150))
500
-
501
- # By attributes
502
- node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
503
-
504
- # By exact line number (must be line number where tag opens)
505
- para = doc["word/document.xml"].get_node(tag="w:p", line_number=42)
506
-
507
- # Combine filters
508
- node = doc["word/document.xml"].get_node(tag="w:r", line_number=range(40, 60), contains="text")
509
-
510
- # Disambiguate when text appears multiple times - add line_number range
511
- node = doc["word/document.xml"].get_node(tag="w:r", contains="Section", line_number=range(2400, 2500))
512
- ```
513
-
514
- ### Saving
515
-
516
- ```python
517
- # Save with automatic validation (copies back to original directory)
518
- doc.save() # Validates by default, raises error if validation fails
519
-
520
- # Save to different location
521
- doc.save('modified-unpacked')
522
-
523
- # Skip validation (debugging only - needing this in production indicates XML issues)
524
- doc.save(validate=False)
525
- ```
526
-
527
- ### Direct DOM Manipulation
528
-
529
- For complex scenarios not covered by the library:
530
-
531
- ```python
532
- # Access any XML file
533
- editor = doc["word/document.xml"]
534
- editor = doc["word/comments.xml"]
535
-
536
- # Direct DOM access (defusedxml.minidom.Document)
537
- node = doc["word/document.xml"].get_node(tag="w:p", line_number=5)
538
- parent = node.parentNode
539
- parent.removeChild(node)
540
- parent.appendChild(node) # Move to end
541
-
542
- # General document manipulation (without tracked changes)
543
- old_node = doc["word/document.xml"].get_node(tag="w:p", contains="original text")
544
- doc["word/document.xml"].replace_node(old_node, "<w:p><w:r><w:t>replacement text</w:t></w:r></w:p>")
545
-
546
- # Multiple insertions - use return value to maintain order
547
- node = doc["word/document.xml"].get_node(tag="w:r", line_number=100)
548
- nodes = doc["word/document.xml"].insert_after(node, "<w:r><w:t>A</w:t></w:r>")
549
- nodes = doc["word/document.xml"].insert_after(nodes[-1], "<w:r><w:t>B</w:t></w:r>")
550
- nodes = doc["word/document.xml"].insert_after(nodes[-1], "<w:r><w:t>C</w:t></w:r>")
551
- # Results in: original_node, A, B, C
552
- ```
553
-
554
- ## Tracked Changes (Redlining)
555
-
556
- **Use the Document class above for all tracked changes.** The patterns below are for reference when constructing replacement XML strings.
557
-
558
- ### Validation Rules
559
- The validator checks that the document text matches the original after reverting Claude's changes. This means:
560
- - **NEVER modify text inside another author's `<w:ins>` or `<w:del>` tags**
561
- - **ALWAYS use nested deletions** to remove another author's insertions
562
- - **Every edit must be properly tracked** with `<w:ins>` or `<w:del>` tags
563
-
564
- ### Tracked Change Patterns
565
-
566
- **CRITICAL RULES**:
567
- 1. Never modify the content inside another author's tracked changes. Always use nested deletions.
568
- 2. **XML Structure**: Always place `<w:del>` and `<w:ins>` at paragraph level containing complete `<w:r>` elements. Never nest inside `<w:r>` elements - this creates invalid XML that breaks document processing.
569
-
570
- **Text Insertion:**
571
- ```xml
572
- <w:ins w:id="1" w:author="Claude" w:date="2025-07-30T23:05:00Z" w16du:dateUtc="2025-07-31T06:05:00Z">
573
- <w:r w:rsidR="00792858">
574
- <w:t>inserted text</w:t>
575
- </w:r>
576
- </w:ins>
577
- ```
578
-
579
- **Text Deletion:**
580
- ```xml
581
- <w:del w:id="2" w:author="Claude" w:date="2025-07-30T23:05:00Z" w16du:dateUtc="2025-07-31T06:05:00Z">
582
- <w:r w:rsidDel="00792858">
583
- <w:delText>deleted text</w:delText>
584
- </w:r>
585
- </w:del>
586
- ```
587
-
588
- **Deleting Another Author's Insertion (MUST use nested structure):**
589
- ```xml
590
- <!-- Nest deletion inside the original insertion -->
591
- <w:ins w:author="Jane Smith" w:id="16">
592
- <w:del w:author="Claude" w:id="40">
593
- <w:r><w:delText>monthly</w:delText></w:r>
594
- </w:del>
595
- </w:ins>
596
- <w:ins w:author="Claude" w:id="41">
597
- <w:r><w:t>weekly</w:t></w:r>
598
- </w:ins>
599
- ```
600
-
601
- **Restoring Another Author's Deletion:**
602
- ```xml
603
- <!-- Leave their deletion unchanged, add new insertion after it -->
604
- <w:del w:author="Jane Smith" w:id="50">
605
- <w:r><w:delText>within 30 days</w:delText></w:r>
606
- </w:del>
607
- <w:ins w:author="Claude" w:id="51">
608
- <w:r><w:t>within 30 days</w:t></w:r>
609
- </w:ins>
1
+ # Office Open XML Technical Reference
2
+
3
+ **Important: Read this entire document before starting.** This document covers:
4
+ - [Technical Guidelines](#technical-guidelines) - Schema compliance rules and validation requirements
5
+ - [Document Content Patterns](#document-content-patterns) - XML patterns for headings, lists, tables, formatting, etc.
6
+ - [Document Library (Python)](#document-library-python) - Recommended approach for OOXML manipulation with automatic infrastructure setup
7
+ - [Tracked Changes (Redlining)](#tracked-changes-redlining) - XML patterns for implementing tracked changes
8
+
9
+ ## Technical Guidelines
10
+
11
+ ### Schema Compliance
12
+ - **Element ordering in `<w:pPr>`**: `<w:pStyle>`, `<w:numPr>`, `<w:spacing>`, `<w:ind>`, `<w:jc>`
13
+ - **Whitespace**: Add `xml:space='preserve'` to `<w:t>` elements with leading/trailing spaces
14
+ - **Unicode**: Escape characters in ASCII content: `"` becomes `&#8220;`
15
+ - **Character encoding reference**: Curly quotes `""` become `&#8220;&#8221;`, apostrophe `'` becomes `&#8217;`, em-dash `—` becomes `&#8212;`
16
+ - **Tracked changes**: Use `<w:del>` and `<w:ins>` tags with `w:author="Claude"` outside `<w:r>` elements
17
+ - **Critical**: `<w:ins>` closes with `</w:ins>`, `<w:del>` closes with `</w:del>` - never mix
18
+ - **RSIDs must be 8-digit hex**: Use values like `00AB1234` (only 0-9, A-F characters)
19
+ - **trackRevisions placement**: Add `<w:trackRevisions/>` after `<w:proofState>` in settings.xml
20
+ - **Images**: Add to `word/media/`, reference in `document.xml`, set dimensions to prevent overflow
21
+
22
+ ## Document Content Patterns
23
+
24
+ ### Basic Structure
25
+ ```xml
26
+ <w:p>
27
+ <w:r><w:t>Text content</w:t></w:r>
28
+ </w:p>
29
+ ```
30
+
31
+ ### Headings and Styles
32
+ ```xml
33
+ <w:p>
34
+ <w:pPr>
35
+ <w:pStyle w:val="Title"/>
36
+ <w:jc w:val="center"/>
37
+ </w:pPr>
38
+ <w:r><w:t>Document Title</w:t></w:r>
39
+ </w:p>
40
+
41
+ <w:p>
42
+ <w:pPr><w:pStyle w:val="Heading2"/></w:pPr>
43
+ <w:r><w:t>Section Heading</w:t></w:r>
44
+ </w:p>
45
+ ```
46
+
47
+ ### Text Formatting
48
+ ```xml
49
+ <!-- Bold -->
50
+ <w:r><w:rPr><w:b/><w:bCs/></w:rPr><w:t>Bold</w:t></w:r>
51
+ <!-- Italic -->
52
+ <w:r><w:rPr><w:i/><w:iCs/></w:rPr><w:t>Italic</w:t></w:r>
53
+ <!-- Underline -->
54
+ <w:r><w:rPr><w:u w:val="single"/></w:rPr><w:t>Underlined</w:t></w:r>
55
+ <!-- Highlight -->
56
+ <w:r><w:rPr><w:highlight w:val="yellow"/></w:rPr><w:t>Highlighted</w:t></w:r>
57
+ ```
58
+
59
+ ### Lists
60
+ ```xml
61
+ <!-- Numbered list -->
62
+ <w:p>
63
+ <w:pPr>
64
+ <w:pStyle w:val="ListParagraph"/>
65
+ <w:numPr><w:ilvl w:val="0"/><w:numId w:val="1"/></w:numPr>
66
+ <w:spacing w:before="240"/>
67
+ </w:pPr>
68
+ <w:r><w:t>First item</w:t></w:r>
69
+ </w:p>
70
+
71
+ <!-- Restart numbered list at 1 - use different numId -->
72
+ <w:p>
73
+ <w:pPr>
74
+ <w:pStyle w:val="ListParagraph"/>
75
+ <w:numPr><w:ilvl w:val="0"/><w:numId w:val="2"/></w:numPr>
76
+ <w:spacing w:before="240"/>
77
+ </w:pPr>
78
+ <w:r><w:t>New list item 1</w:t></w:r>
79
+ </w:p>
80
+
81
+ <!-- Bullet list (level 2) -->
82
+ <w:p>
83
+ <w:pPr>
84
+ <w:pStyle w:val="ListParagraph"/>
85
+ <w:numPr><w:ilvl w:val="1"/><w:numId w:val="1"/></w:numPr>
86
+ <w:spacing w:before="240"/>
87
+ <w:ind w:left="900"/>
88
+ </w:pPr>
89
+ <w:r><w:t>Bullet item</w:t></w:r>
90
+ </w:p>
91
+ ```
92
+
93
+ ### Tables
94
+ ```xml
95
+ <w:tbl>
96
+ <w:tblPr>
97
+ <w:tblStyle w:val="TableGrid"/>
98
+ <w:tblW w:w="0" w:type="auto"/>
99
+ </w:tblPr>
100
+ <w:tblGrid>
101
+ <w:gridCol w:w="4675"/><w:gridCol w:w="4675"/>
102
+ </w:tblGrid>
103
+ <w:tr>
104
+ <w:tc>
105
+ <w:tcPr><w:tcW w:w="4675" w:type="dxa"/></w:tcPr>
106
+ <w:p><w:r><w:t>Cell 1</w:t></w:r></w:p>
107
+ </w:tc>
108
+ <w:tc>
109
+ <w:tcPr><w:tcW w:w="4675" w:type="dxa"/></w:tcPr>
110
+ <w:p><w:r><w:t>Cell 2</w:t></w:r></w:p>
111
+ </w:tc>
112
+ </w:tr>
113
+ </w:tbl>
114
+ ```
115
+
116
+ ### Layout
117
+ ```xml
118
+ <!-- Page break before new section (common pattern) -->
119
+ <w:p>
120
+ <w:r>
121
+ <w:br w:type="page"/>
122
+ </w:r>
123
+ </w:p>
124
+ <w:p>
125
+ <w:pPr>
126
+ <w:pStyle w:val="Heading1"/>
127
+ </w:pPr>
128
+ <w:r>
129
+ <w:t>New Section Title</w:t>
130
+ </w:r>
131
+ </w:p>
132
+
133
+ <!-- Centered paragraph -->
134
+ <w:p>
135
+ <w:pPr>
136
+ <w:spacing w:before="240" w:after="0"/>
137
+ <w:jc w:val="center"/>
138
+ </w:pPr>
139
+ <w:r><w:t>Centered text</w:t></w:r>
140
+ </w:p>
141
+
142
+ <!-- Font change - paragraph level (applies to all runs) -->
143
+ <w:p>
144
+ <w:pPr>
145
+ <w:rPr><w:rFonts w:ascii="Courier New" w:hAnsi="Courier New"/></w:rPr>
146
+ </w:pPr>
147
+ <w:r><w:t>Monospace text</w:t></w:r>
148
+ </w:p>
149
+
150
+ <!-- Font change - run level (specific to this text) -->
151
+ <w:p>
152
+ <w:r>
153
+ <w:rPr><w:rFonts w:ascii="Courier New" w:hAnsi="Courier New"/></w:rPr>
154
+ <w:t>This text is Courier New</w:t>
155
+ </w:r>
156
+ <w:r><w:t> and this text uses default font</w:t></w:r>
157
+ </w:p>
158
+ ```
159
+
160
+ ## File Updates
161
+
162
+ When adding content, update these files:
163
+
164
+ **`word/_rels/document.xml.rels`:**
165
+ ```xml
166
+ <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" Target="numbering.xml"/>
167
+ <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/image1.png"/>
168
+ ```
169
+
170
+ **`[Content_Types].xml`:**
171
+ ```xml
172
+ <Default Extension="png" ContentType="image/png"/>
173
+ <Override PartName="/word/numbering.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml"/>
174
+ ```
175
+
176
+ ### Images
177
+ **CRITICAL**: Calculate dimensions to prevent page overflow and maintain aspect ratio.
178
+
179
+ ```xml
180
+ <!-- Minimal required structure -->
181
+ <w:p>
182
+ <w:r>
183
+ <w:drawing>
184
+ <wp:inline>
185
+ <wp:extent cx="2743200" cy="1828800"/>
186
+ <wp:docPr id="1" name="Picture 1"/>
187
+ <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
188
+ <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
189
+ <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
190
+ <pic:nvPicPr>
191
+ <pic:cNvPr id="0" name="image1.png"/>
192
+ <pic:cNvPicPr/>
193
+ </pic:nvPicPr>
194
+ <pic:blipFill>
195
+ <a:blip r:embed="rId5"/>
196
+ <!-- Add for stretch fill with aspect ratio preservation -->
197
+ <a:stretch>
198
+ <a:fillRect/>
199
+ </a:stretch>
200
+ </pic:blipFill>
201
+ <pic:spPr>
202
+ <a:xfrm>
203
+ <a:ext cx="2743200" cy="1828800"/>
204
+ </a:xfrm>
205
+ <a:prstGeom prst="rect"/>
206
+ </pic:spPr>
207
+ </pic:pic>
208
+ </a:graphicData>
209
+ </a:graphic>
210
+ </wp:inline>
211
+ </w:drawing>
212
+ </w:r>
213
+ </w:p>
214
+ ```
215
+
216
+ ### Links (Hyperlinks)
217
+
218
+ **IMPORTANT**: All hyperlinks (both internal and external) require the Hyperlink style to be defined in styles.xml. Without this style, links will look like regular text instead of blue underlined clickable links.
219
+
220
+ **External Links:**
221
+ ```xml
222
+ <!-- In document.xml -->
223
+ <w:hyperlink r:id="rId5">
224
+ <w:r>
225
+ <w:rPr><w:rStyle w:val="Hyperlink"/></w:rPr>
226
+ <w:t>Link Text</w:t>
227
+ </w:r>
228
+ </w:hyperlink>
229
+
230
+ <!-- In word/_rels/document.xml.rels -->
231
+ <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
232
+ Target="https://www.example.com/" TargetMode="External"/>
233
+ ```
234
+
235
+ **Internal Links:**
236
+
237
+ ```xml
238
+ <!-- Link to bookmark -->
239
+ <w:hyperlink w:anchor="myBookmark">
240
+ <w:r>
241
+ <w:rPr><w:rStyle w:val="Hyperlink"/></w:rPr>
242
+ <w:t>Link Text</w:t>
243
+ </w:r>
244
+ </w:hyperlink>
245
+
246
+ <!-- Bookmark target -->
247
+ <w:bookmarkStart w:id="0" w:name="myBookmark"/>
248
+ <w:r><w:t>Target content</w:t></w:r>
249
+ <w:bookmarkEnd w:id="0"/>
250
+ ```
251
+
252
+ **Hyperlink Style (required in styles.xml):**
253
+ ```xml
254
+ <w:style w:type="character" w:styleId="Hyperlink">
255
+ <w:name w:val="Hyperlink"/>
256
+ <w:basedOn w:val="DefaultParagraphFont"/>
257
+ <w:uiPriority w:val="99"/>
258
+ <w:unhideWhenUsed/>
259
+ <w:rPr>
260
+ <w:color w:val="467886" w:themeColor="hyperlink"/>
261
+ <w:u w:val="single"/>
262
+ </w:rPr>
263
+ </w:style>
264
+ ```
265
+
266
+ ## Document Library (Python)
267
+
268
+ Use the Document class from `scripts/document.py` for all tracked changes and comments. It automatically handles infrastructure setup (people.xml, RSIDs, settings.xml, comment files, relationships, content types). Only use direct XML manipulation for complex scenarios not supported by the library.
269
+
270
+ **Working with Unicode and Entities:**
271
+ - **Searching**: Both entity notation and Unicode characters work - `contains="&#8220;Company"` and `contains="\u201cCompany"` find the same text
272
+ - **Replacing**: Use either entities (`&#8220;`) or Unicode (`\u201c`) - both work and will be converted appropriately based on the file's encoding (ascii → entities, utf-8 → Unicode)
273
+
274
+ ### Initialization
275
+
276
+ **Find the docx skill root** (directory containing `scripts/` and `ooxml/`):
277
+ ```bash
278
+ # Search for document.py to locate the skill root
279
+ # Note: /mnt/skills is used here as an example; check your context for the actual location
280
+ find /mnt/skills -name "document.py" -path "*/docx/scripts/*" 2>/dev/null | head -1
281
+ # Example output: /mnt/skills/docx/scripts/document.py
282
+ # Skill root is: /mnt/skills/docx
283
+ ```
284
+
285
+ **Run your script with PYTHONPATH** set to the docx skill root:
286
+ ```bash
287
+ PYTHONPATH=/mnt/skills/docx python your_script.py
288
+ ```
289
+
290
+ **In your script**, import from the skill root:
291
+ ```python
292
+ from scripts.document import Document, DocxXMLEditor
293
+
294
+ # Basic initialization (automatically creates temp copy and sets up infrastructure)
295
+ doc = Document('unpacked')
296
+
297
+ # Customize author and initials
298
+ doc = Document('unpacked', author="John Doe", initials="JD")
299
+
300
+ # Enable track revisions mode
301
+ doc = Document('unpacked', track_revisions=True)
302
+
303
+ # Specify custom RSID (auto-generated if not provided)
304
+ doc = Document('unpacked', rsid="07DC5ECB")
305
+ ```
306
+
307
+ ### Creating Tracked Changes
308
+
309
+ **CRITICAL**: Only mark text that actually changes. Keep ALL unchanged text outside `<w:del>`/`<w:ins>` tags. Marking unchanged text makes edits unprofessional and harder to review.
310
+
311
+ **Attribute Handling**: The Document class auto-injects attributes (w:id, w:date, w:rsidR, w:rsidDel, w16du:dateUtc, xml:space) into new elements. When preserving unchanged text from the original document, copy the original `<w:r>` element with its existing attributes to maintain document integrity.
312
+
313
+ **Method Selection Guide**:
314
+ - **Adding your own changes to regular text**: Use `replace_node()` with `<w:del>`/`<w:ins>` tags, or `suggest_deletion()` for removing entire `<w:r>` or `<w:p>` elements
315
+ - **Partially modifying another author's tracked change**: Use `replace_node()` to nest your changes inside their `<w:ins>`/`<w:del>`
316
+ - **Completely rejecting another author's insertion**: Use `revert_insertion()` on the `<w:ins>` element (NOT `suggest_deletion()`)
317
+ - **Completely rejecting another author's deletion**: Use `revert_deletion()` on the `<w:del>` element to restore deleted content using tracked changes
318
+
319
+ ```python
320
+ # Minimal edit - change one word: "The report is monthly" → "The report is quarterly"
321
+ # Original: <w:r w:rsidR="00AB12CD"><w:rPr><w:rFonts w:ascii="Calibri"/></w:rPr><w:t>The report is monthly</w:t></w:r>
322
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="The report is monthly")
323
+ rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
324
+ replacement = f'<w:r w:rsidR="00AB12CD">{rpr}<w:t>The report is </w:t></w:r><w:del><w:r>{rpr}<w:delText>monthly</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>quarterly</w:t></w:r></w:ins>'
325
+ doc["word/document.xml"].replace_node(node, replacement)
326
+
327
+ # Minimal edit - change number: "within 30 days" → "within 45 days"
328
+ # Original: <w:r w:rsidR="00XYZ789"><w:rPr><w:rFonts w:ascii="Calibri"/></w:rPr><w:t>within 30 days</w:t></w:r>
329
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="within 30 days")
330
+ rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
331
+ replacement = f'<w:r w:rsidR="00XYZ789">{rpr}<w:t>within </w:t></w:r><w:del><w:r>{rpr}<w:delText>30</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>45</w:t></w:r></w:ins><w:r w:rsidR="00XYZ789">{rpr}<w:t> days</w:t></w:r>'
332
+ doc["word/document.xml"].replace_node(node, replacement)
333
+
334
+ # Complete replacement - preserve formatting even when replacing all text
335
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="apple")
336
+ rpr = tags[0].toxml() if (tags := node.getElementsByTagName("w:rPr")) else ""
337
+ replacement = f'<w:del><w:r>{rpr}<w:delText>apple</w:delText></w:r></w:del><w:ins><w:r>{rpr}<w:t>banana orange</w:t></w:r></w:ins>'
338
+ doc["word/document.xml"].replace_node(node, replacement)
339
+
340
+ # Insert new content (no attributes needed - auto-injected)
341
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="existing text")
342
+ doc["word/document.xml"].insert_after(node, '<w:ins><w:r><w:t>new text</w:t></w:r></w:ins>')
343
+
344
+ # Partially delete another author's insertion
345
+ # Original: <w:ins w:author="Jane Smith" w:date="..."><w:r><w:t>quarterly financial report</w:t></w:r></w:ins>
346
+ # Goal: Delete only "financial" to make it "quarterly report"
347
+ node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
348
+ # IMPORTANT: Preserve w:author="Jane Smith" on the outer <w:ins> to maintain authorship
349
+ replacement = '''<w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
350
+ <w:r><w:t>quarterly </w:t></w:r>
351
+ <w:del><w:r><w:delText>financial </w:delText></w:r></w:del>
352
+ <w:r><w:t>report</w:t></w:r>
353
+ </w:ins>'''
354
+ doc["word/document.xml"].replace_node(node, replacement)
355
+
356
+ # Change part of another author's insertion
357
+ # Original: <w:ins w:author="Jane Smith"><w:r><w:t>in silence, safe and sound</w:t></w:r></w:ins>
358
+ # Goal: Change "safe and sound" to "soft and unbound"
359
+ node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "8"})
360
+ replacement = f'''<w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
361
+ <w:r><w:t>in silence, </w:t></w:r>
362
+ </w:ins>
363
+ <w:ins>
364
+ <w:r><w:t>soft and unbound</w:t></w:r>
365
+ </w:ins>
366
+ <w:ins w:author="Jane Smith" w:date="2025-01-15T10:00:00Z">
367
+ <w:del><w:r><w:delText>safe and sound</w:delText></w:r></w:del>
368
+ </w:ins>'''
369
+ doc["word/document.xml"].replace_node(node, replacement)
370
+
371
+ # Delete entire run (use only when deleting all content; use replace_node for partial deletions)
372
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="text to delete")
373
+ doc["word/document.xml"].suggest_deletion(node)
374
+
375
+ # Delete entire paragraph (in-place, handles both regular and numbered list paragraphs)
376
+ para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph to delete")
377
+ doc["word/document.xml"].suggest_deletion(para)
378
+
379
+ # Add new numbered list item
380
+ target_para = doc["word/document.xml"].get_node(tag="w:p", contains="existing list item")
381
+ pPr = tags[0].toxml() if (tags := target_para.getElementsByTagName("w:pPr")) else ""
382
+ new_item = f'<w:p>{pPr}<w:r><w:t>New item</w:t></w:r></w:p>'
383
+ tracked_para = DocxXMLEditor.suggest_paragraph(new_item)
384
+ doc["word/document.xml"].insert_after(target_para, tracked_para)
385
+ # Optional: add spacing paragraph before content for better visual separation
386
+ # spacing = DocxXMLEditor.suggest_paragraph('<w:p><w:pPr><w:pStyle w:val="ListParagraph"/></w:pPr></w:p>')
387
+ # doc["word/document.xml"].insert_after(target_para, spacing + tracked_para)
388
+ ```
389
+
390
+ ### Adding Comments
391
+
392
+ ```python
393
+ # Add comment spanning two existing tracked changes
394
+ # Note: w:id is auto-generated. Only search by w:id if you know it from XML inspection
395
+ start_node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
396
+ end_node = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "2"})
397
+ doc.add_comment(start=start_node, end=end_node, text="Explanation of this change")
398
+
399
+ # Add comment on a paragraph
400
+ para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
401
+ doc.add_comment(start=para, end=para, text="Comment on this paragraph")
402
+
403
+ # Add comment on newly created tracked change
404
+ # First create the tracked change
405
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="old")
406
+ new_nodes = doc["word/document.xml"].replace_node(
407
+ node,
408
+ '<w:del><w:r><w:delText>old</w:delText></w:r></w:del><w:ins><w:r><w:t>new</w:t></w:r></w:ins>'
409
+ )
410
+ # Then add comment on the newly created elements
411
+ # new_nodes[0] is the <w:del>, new_nodes[1] is the <w:ins>
412
+ doc.add_comment(start=new_nodes[0], end=new_nodes[1], text="Changed old to new per requirements")
413
+
414
+ # Reply to existing comment
415
+ doc.reply_to_comment(parent_comment_id=0, text="I agree with this change")
416
+ ```
417
+
418
+ ### Rejecting Tracked Changes
419
+
420
+ **IMPORTANT**: Use `revert_insertion()` to reject insertions and `revert_deletion()` to restore deletions using tracked changes. Use `suggest_deletion()` only for regular unmarked content.
421
+
422
+ ```python
423
+ # Reject insertion (wraps it in deletion)
424
+ # Use this when another author inserted text that you want to delete
425
+ ins = doc["word/document.xml"].get_node(tag="w:ins", attrs={"w:id": "5"})
426
+ nodes = doc["word/document.xml"].revert_insertion(ins) # Returns [ins]
427
+
428
+ # Reject deletion (creates insertion to restore deleted content)
429
+ # Use this when another author deleted text that you want to restore
430
+ del_elem = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "3"})
431
+ nodes = doc["word/document.xml"].revert_deletion(del_elem) # Returns [del_elem, new_ins]
432
+
433
+ # Reject all insertions in a paragraph
434
+ para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
435
+ nodes = doc["word/document.xml"].revert_insertion(para) # Returns [para]
436
+
437
+ # Reject all deletions in a paragraph
438
+ para = doc["word/document.xml"].get_node(tag="w:p", contains="paragraph text")
439
+ nodes = doc["word/document.xml"].revert_deletion(para) # Returns [para]
440
+ ```
441
+
442
+ ### Inserting Images
443
+
444
+ **CRITICAL**: The Document class works with a temporary copy at `doc.unpacked_path`. Always copy images to this temp directory, not the original unpacked folder.
445
+
446
+ ```python
447
+ from PIL import Image
448
+ import shutil, os
449
+
450
+ # Initialize document first
451
+ doc = Document('unpacked')
452
+
453
+ # Copy image and calculate full-width dimensions with aspect ratio
454
+ media_dir = os.path.join(doc.unpacked_path, 'word/media')
455
+ os.makedirs(media_dir, exist_ok=True)
456
+ shutil.copy('image.png', os.path.join(media_dir, 'image1.png'))
457
+ img = Image.open(os.path.join(media_dir, 'image1.png'))
458
+ width_emus = int(6.5 * 914400) # 6.5" usable width, 914400 EMUs/inch
459
+ height_emus = int(width_emus * img.size[1] / img.size[0])
460
+
461
+ # Add relationship and content type
462
+ rels_editor = doc['word/_rels/document.xml.rels']
463
+ next_rid = rels_editor.get_next_rid()
464
+ rels_editor.append_to(rels_editor.dom.documentElement,
465
+ f'<Relationship Id="{next_rid}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/image1.png"/>')
466
+ doc['[Content_Types].xml'].append_to(doc['[Content_Types].xml'].dom.documentElement,
467
+ '<Default Extension="png" ContentType="image/png"/>')
468
+
469
+ # Insert image
470
+ node = doc["word/document.xml"].get_node(tag="w:p", line_number=100)
471
+ doc["word/document.xml"].insert_after(node, f'''<w:p>
472
+ <w:r>
473
+ <w:drawing>
474
+ <wp:inline distT="0" distB="0" distL="0" distR="0">
475
+ <wp:extent cx="{width_emus}" cy="{height_emus}"/>
476
+ <wp:docPr id="1" name="Picture 1"/>
477
+ <a:graphic xmlns:a="http://schemas.openxmlformats.org/drawingml/2006/main">
478
+ <a:graphicData uri="http://schemas.openxmlformats.org/drawingml/2006/picture">
479
+ <pic:pic xmlns:pic="http://schemas.openxmlformats.org/drawingml/2006/picture">
480
+ <pic:nvPicPr><pic:cNvPr id="1" name="image1.png"/><pic:cNvPicPr/></pic:nvPicPr>
481
+ <pic:blipFill><a:blip r:embed="{next_rid}"/><a:stretch><a:fillRect/></a:stretch></pic:blipFill>
482
+ <pic:spPr><a:xfrm><a:ext cx="{width_emus}" cy="{height_emus}"/></a:xfrm><a:prstGeom prst="rect"><a:avLst/></a:prstGeom></pic:spPr>
483
+ </pic:pic>
484
+ </a:graphicData>
485
+ </a:graphic>
486
+ </wp:inline>
487
+ </w:drawing>
488
+ </w:r>
489
+ </w:p>''')
490
+ ```
491
+
492
+ ### Getting Nodes
493
+
494
+ ```python
495
+ # By text content
496
+ node = doc["word/document.xml"].get_node(tag="w:p", contains="specific text")
497
+
498
+ # By line range
499
+ para = doc["word/document.xml"].get_node(tag="w:p", line_number=range(100, 150))
500
+
501
+ # By attributes
502
+ node = doc["word/document.xml"].get_node(tag="w:del", attrs={"w:id": "1"})
503
+
504
+ # By exact line number (must be line number where tag opens)
505
+ para = doc["word/document.xml"].get_node(tag="w:p", line_number=42)
506
+
507
+ # Combine filters
508
+ node = doc["word/document.xml"].get_node(tag="w:r", line_number=range(40, 60), contains="text")
509
+
510
+ # Disambiguate when text appears multiple times - add line_number range
511
+ node = doc["word/document.xml"].get_node(tag="w:r", contains="Section", line_number=range(2400, 2500))
512
+ ```
513
+
514
+ ### Saving
515
+
516
+ ```python
517
+ # Save with automatic validation (copies back to original directory)
518
+ doc.save() # Validates by default, raises error if validation fails
519
+
520
+ # Save to different location
521
+ doc.save('modified-unpacked')
522
+
523
+ # Skip validation (debugging only - needing this in production indicates XML issues)
524
+ doc.save(validate=False)
525
+ ```
526
+
527
+ ### Direct DOM Manipulation
528
+
529
+ For complex scenarios not covered by the library:
530
+
531
+ ```python
532
+ # Access any XML file
533
+ editor = doc["word/document.xml"]
534
+ editor = doc["word/comments.xml"]
535
+
536
+ # Direct DOM access (defusedxml.minidom.Document)
537
+ node = doc["word/document.xml"].get_node(tag="w:p", line_number=5)
538
+ parent = node.parentNode
539
+ parent.removeChild(node)
540
+ parent.appendChild(node) # Move to end
541
+
542
+ # General document manipulation (without tracked changes)
543
+ old_node = doc["word/document.xml"].get_node(tag="w:p", contains="original text")
544
+ doc["word/document.xml"].replace_node(old_node, "<w:p><w:r><w:t>replacement text</w:t></w:r></w:p>")
545
+
546
+ # Multiple insertions - use return value to maintain order
547
+ node = doc["word/document.xml"].get_node(tag="w:r", line_number=100)
548
+ nodes = doc["word/document.xml"].insert_after(node, "<w:r><w:t>A</w:t></w:r>")
549
+ nodes = doc["word/document.xml"].insert_after(nodes[-1], "<w:r><w:t>B</w:t></w:r>")
550
+ nodes = doc["word/document.xml"].insert_after(nodes[-1], "<w:r><w:t>C</w:t></w:r>")
551
+ # Results in: original_node, A, B, C
552
+ ```
553
+
554
+ ## Tracked Changes (Redlining)
555
+
556
+ **Use the Document class above for all tracked changes.** The patterns below are for reference when constructing replacement XML strings.
557
+
558
+ ### Validation Rules
559
+ The validator checks that the document text matches the original after reverting Claude's changes. This means:
560
+ - **NEVER modify text inside another author's `<w:ins>` or `<w:del>` tags**
561
+ - **ALWAYS use nested deletions** to remove another author's insertions
562
+ - **Every edit must be properly tracked** with `<w:ins>` or `<w:del>` tags
563
+
564
+ ### Tracked Change Patterns
565
+
566
+ **CRITICAL RULES**:
567
+ 1. Never modify the content inside another author's tracked changes. Always use nested deletions.
568
+ 2. **XML Structure**: Always place `<w:del>` and `<w:ins>` at paragraph level containing complete `<w:r>` elements. Never nest inside `<w:r>` elements - this creates invalid XML that breaks document processing.
569
+
570
+ **Text Insertion:**
571
+ ```xml
572
+ <w:ins w:id="1" w:author="Claude" w:date="2025-07-30T23:05:00Z" w16du:dateUtc="2025-07-31T06:05:00Z">
573
+ <w:r w:rsidR="00792858">
574
+ <w:t>inserted text</w:t>
575
+ </w:r>
576
+ </w:ins>
577
+ ```
578
+
579
+ **Text Deletion:**
580
+ ```xml
581
+ <w:del w:id="2" w:author="Claude" w:date="2025-07-30T23:05:00Z" w16du:dateUtc="2025-07-31T06:05:00Z">
582
+ <w:r w:rsidDel="00792858">
583
+ <w:delText>deleted text</w:delText>
584
+ </w:r>
585
+ </w:del>
586
+ ```
587
+
588
+ **Deleting Another Author's Insertion (MUST use nested structure):**
589
+ ```xml
590
+ <!-- Nest deletion inside the original insertion -->
591
+ <w:ins w:author="Jane Smith" w:id="16">
592
+ <w:del w:author="Claude" w:id="40">
593
+ <w:r><w:delText>monthly</w:delText></w:r>
594
+ </w:del>
595
+ </w:ins>
596
+ <w:ins w:author="Claude" w:id="41">
597
+ <w:r><w:t>weekly</w:t></w:r>
598
+ </w:ins>
599
+ ```
600
+
601
+ **Restoring Another Author's Deletion:**
602
+ ```xml
603
+ <!-- Leave their deletion unchanged, add new insertion after it -->
604
+ <w:del w:author="Jane Smith" w:id="50">
605
+ <w:r><w:delText>within 30 days</w:delText></w:r>
606
+ </w:del>
607
+ <w:ins w:author="Claude" w:id="51">
608
+ <w:r><w:t>within 30 days</w:t></w:r>
609
+ </w:ins>
610
610
  ```