@uipath/delegate-sdk 1.203.0 → 1.203.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -3
- package/dist/index.mjs +2 -2
- package/dist/skills/business-analysis/SKILL.md +722 -0
- package/dist/skills/business-analysis/as-is-capture.md +440 -0
- package/dist/skills/business-analysis/assets/progress.yaml +19 -0
- package/dist/skills/business-analysis/assets/task-list.md +34 -0
- package/dist/skills/business-analysis/automation-hub-publishing.md +47 -0
- package/dist/skills/business-analysis/bpmn-to-be-design.md +274 -0
- package/dist/skills/business-analysis/case-to-be-design.md +223 -0
- package/dist/skills/business-analysis/diagram-authoring.md +215 -0
- package/dist/skills/business-analysis/industry-gaps.md +134 -0
- package/dist/skills/business-analysis/interview-spine.md +297 -0
- package/dist/skills/business-analysis/locales/de.json +54 -0
- package/dist/skills/business-analysis/locales/en.json +54 -0
- package/dist/skills/business-analysis/locales/es-MX.json +54 -0
- package/dist/skills/business-analysis/locales/es.json +54 -0
- package/dist/skills/business-analysis/locales/fr.json +54 -0
- package/dist/skills/business-analysis/locales/ja.json +54 -0
- package/dist/skills/business-analysis/locales/ko.json +54 -0
- package/dist/skills/business-analysis/locales/pt-BR.json +54 -0
- package/dist/skills/business-analysis/locales/pt.json +54 -0
- package/dist/skills/business-analysis/locales/ro.json +54 -0
- package/dist/skills/business-analysis/locales/tr.json +54 -0
- package/dist/skills/business-analysis/locales/zh-CN.json +54 -0
- package/dist/skills/business-analysis/locales/zh-TW.json +54 -0
- package/dist/skills/business-analysis/pdd-generation.md +204 -0
- package/dist/skills/business-analysis/pdd-template.md +562 -0
- package/dist/skills/business-analysis/progress-presentation.json +13 -0
- package/dist/skills/business-analysis/recording-first.md +19 -0
- package/dist/skills/business-analysis/recording-processing.md +152 -0
- package/dist/skills/business-analysis/references/automation-hub-open-api.md +57 -0
- package/dist/skills/business-analysis/references/case-definition-spec.md +90 -0
- package/dist/skills/business-analysis/references/case-design-patterns/loan-origination-spec.md +86 -0
- package/dist/skills/business-analysis/references/component-type-mapping.md +52 -0
- package/dist/skills/business-analysis/references/uipath-products/case-management-schema.md +62 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-framework.md +65 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-management.md +49 -0
- package/dist/skills/business-analysis/research-offer.md +104 -0
- package/dist/skills/business-analysis/research-pass.md +149 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.ps1 +294 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.sh +453 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.ps1 +72 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.sh +98 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.ps1 +524 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.sh +519 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.ps1 +363 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.sh +360 -0
- package/dist/skills/business-analysis/to-be-design.md +199 -0
- package/dist/skills/confluence/SKILL.md +386 -0
- package/dist/skills/doc-coauthoring/SKILL.md +295 -0
- package/dist/skills/excel-architect/SKILL.macos.md +161 -0
- package/dist/skills/excel-architect/SKILL.md +180 -0
- package/dist/skills/excel-architect/SKILL.windows.md +61 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model-advanced.md +332 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model.md +248 -0
- package/dist/skills/excel-architect/archetypes/02-data-analysis.md +171 -0
- package/dist/skills/excel-architect/archetypes/03-tracking-dashboard.md +160 -0
- package/dist/skills/excel-architect/archetypes/04-project-planning.md +193 -0
- package/dist/skills/excel-architect/archetypes/05-simple-table.md +111 -0
- package/dist/skills/excel-architect/building.md +279 -0
- package/dist/skills/excel-architect/create.md +64 -0
- package/dist/skills/excel-architect/data-and-formulas.md +186 -0
- package/dist/skills/excel-architect/generator.md +272 -0
- package/dist/skills/excel-architect/macos/scripts/add-data-validation.applescript +242 -0
- package/dist/skills/excel-architect/macos/scripts/append-rows.applescript +310 -0
- package/dist/skills/excel-architect/macos/scripts/apply-conditional-format.applescript +565 -0
- package/dist/skills/excel-architect/macos/scripts/autofit-columns.applescript +79 -0
- package/dist/skills/excel-architect/macos/scripts/benchmark.sh +135 -0
- package/dist/skills/excel-architect/macos/scripts/check-compile.sh +30 -0
- package/dist/skills/excel-architect/macos/scripts/clear-range.applescript +152 -0
- package/dist/skills/excel-architect/macos/scripts/copy-paste.applescript +179 -0
- package/dist/skills/excel-architect/macos/scripts/create-chart.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/create-pivot.applescript +443 -0
- package/dist/skills/excel-architect/macos/scripts/create-sheets.applescript +264 -0
- package/dist/skills/excel-architect/macos/scripts/create-workbook.applescript +92 -0
- package/dist/skills/excel-architect/macos/scripts/delete-chart.applescript +105 -0
- package/dist/skills/excel-architect/macos/scripts/delete-sheet.applescript +127 -0
- package/dist/skills/excel-architect/macos/scripts/filter-data.applescript +213 -0
- package/dist/skills/excel-architect/macos/scripts/find-replace.applescript +238 -0
- package/dist/skills/excel-architect/macos/scripts/format-range.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/freeze-panes.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/get-current-file.applescript +24 -0
- package/dist/skills/excel-architect/macos/scripts/get-sheet-dimensions.applescript +115 -0
- package/dist/skills/excel-architect/macos/scripts/health-check.applescript +704 -0
- package/dist/skills/excel-architect/macos/scripts/list-open-workbooks.applescript +80 -0
- package/dist/skills/excel-architect/macos/scripts/maximize-window.applescript +47 -0
- package/dist/skills/excel-architect/macos/scripts/merge-cells.applescript +227 -0
- package/dist/skills/excel-architect/macos/scripts/open-workbook.applescript +139 -0
- package/dist/skills/excel-architect/macos/scripts/read-range.applescript +267 -0
- package/dist/skills/excel-architect/macos/scripts/rename-sheet.applescript +231 -0
- package/dist/skills/excel-architect/macos/scripts/select-sheet.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/set-tab-color.applescript +109 -0
- package/dist/skills/excel-architect/macos/scripts/sort-data.applescript +136 -0
- package/dist/skills/excel-architect/macos/scripts/undo.applescript +59 -0
- package/dist/skills/excel-architect/macos/scripts/workbook-lifecycle.applescript +149 -0
- package/dist/skills/excel-architect/macos/scripts/write-formula.applescript +225 -0
- package/dist/skills/excel-architect/macos/scripts/write-range.applescript +351 -0
- package/dist/skills/excel-architect/reference/api/advanced.md +381 -0
- package/dist/skills/excel-architect/reference/api/basic.md +747 -0
- package/dist/skills/excel-architect/reference/guides.md +348 -0
- package/dist/skills/excel-architect/reference/repair.md +174 -0
- package/dist/skills/excel-architect/reference/troubleshooting.md +46 -0
- package/dist/skills/excel-architect/scripting.md +266 -0
- package/dist/skills/excel-architect/styling-and-features.md +433 -0
- package/dist/skills/excel-architect/windows/api/composites.md +337 -0
- package/dist/skills/excel-architect/windows/api/scripting.md +139 -0
- package/dist/skills/excel-architect/windows/examples/level-1-workflows.md +485 -0
- package/dist/skills/excel-architect/windows/examples/level-2-advanced.md +690 -0
- package/dist/skills/excel-architect/windows/examples/level-3-scripting.md +337 -0
- package/dist/skills/github/SKILL.md +446 -0
- package/dist/skills/github/recipes/add-comment.md +85 -0
- package/dist/skills/github/recipes/check-pr-status.md +122 -0
- package/dist/skills/github/recipes/compare-branches.md +79 -0
- package/dist/skills/github/recipes/create-issue.md +103 -0
- package/dist/skills/github/recipes/create-pr.md +97 -0
- package/dist/skills/github/recipes/get-file-contents.md +76 -0
- package/dist/skills/github/recipes/get-last-commit.md +128 -0
- package/dist/skills/github/recipes/list-my-open-prs.md +105 -0
- package/dist/skills/github/recipes/list-recent-commits.md +84 -0
- package/dist/skills/github/recipes/search-issues.md +115 -0
- package/dist/skills/google-workspace/SKILL.md +217 -0
- package/dist/skills/google-workspace/services/calendar.md +311 -0
- package/dist/skills/google-workspace/services/docs.md +426 -0
- package/dist/skills/google-workspace/services/drive.md +504 -0
- package/dist/skills/google-workspace/services/gmail.md +466 -0
- package/dist/skills/google-workspace/services/sheets.md +370 -0
- package/dist/skills/internal-comms/SKILL.md +35 -0
- package/dist/skills/internal-comms/examples/3p-updates.md +47 -0
- package/dist/skills/internal-comms/examples/company-newsletter.md +65 -0
- package/dist/skills/internal-comms/examples/faq-answers.md +30 -0
- package/dist/skills/internal-comms/examples/general-comms.md +15 -0
- package/dist/skills/jira/SKILL.md +397 -0
- package/dist/skills/jira/recipes/add-comment.md +123 -0
- package/dist/skills/jira/recipes/assign-issue.md +157 -0
- package/dist/skills/jira/recipes/create-issue.md +274 -0
- package/dist/skills/jira/recipes/get-issue-details.md +154 -0
- package/dist/skills/jira/recipes/list-projects.md +151 -0
- package/dist/skills/jira/recipes/my-issues.md +180 -0
- package/dist/skills/jira/recipes/search-issues.md +215 -0
- package/dist/skills/jira/recipes/transition-issue.md +154 -0
- package/dist/skills/jira/recipes/troubleshooting.md +387 -0
- package/dist/skills/knowledge-base/SKILL.md +289 -0
- package/dist/skills/media-tools/SKILL.md +204 -0
- package/dist/skills/media-tools/references/encode-runbook.md +24 -0
- package/dist/skills/media-tools/references/resolve-binaries.md +81 -0
- package/dist/skills/media-tools/scripts/macos/ff-launch.sh +22 -0
- package/dist/skills/media-tools/scripts/macos/ff-poll.sh +10 -0
- package/dist/skills/media-tools/scripts/windows/ff-launch.ps1 +34 -0
- package/dist/skills/media-tools/scripts/windows/ff-poll.ps1 +20 -0
- package/dist/skills/office-download/SKILL.md +161 -0
- package/dist/skills/outlook-365/SKILL.macos.md +331 -0
- package/dist/skills/outlook-365/SKILL.md +171 -0
- package/dist/skills/outlook-365/SKILL.windows.md +124 -0
- package/dist/skills/outlook-365/api/bulk-email-operations.md +178 -0
- package/dist/skills/outlook-365/api/check-availability.md +87 -0
- package/dist/skills/outlook-365/api/create-inbox-rule.md +182 -0
- package/dist/skills/outlook-365/api/download-attachments.md +149 -0
- package/dist/skills/outlook-365/api/find-and-email-contact.md +185 -0
- package/dist/skills/outlook-365/api/manage-calendar-events.md +189 -0
- package/dist/skills/outlook-365/api/organize-with-folders.md +178 -0
- package/dist/skills/outlook-365/api/reply-to-conversation.md +68 -0
- package/dist/skills/outlook-365/api/schedule-meeting.md +73 -0
- package/dist/skills/outlook-365/api/search-and-read-email.md +93 -0
- package/dist/skills/outlook-365/api/send-email-with-attachments.md +94 -0
- package/dist/skills/outlook-365/api/send-email.md +396 -0
- package/dist/skills/outlook-365/api/set-out-of-office.md +196 -0
- package/dist/skills/outlook-365/macos/scripts/bulk-operations.applescript +429 -0
- package/dist/skills/outlook-365/macos/scripts/calendar.applescript +642 -0
- package/dist/skills/outlook-365/macos/scripts/contacts.applescript +635 -0
- package/dist/skills/outlook-365/macos/scripts/helpers.applescript +227 -0
- package/dist/skills/outlook-365/macos/scripts/read-emails.applescript +299 -0
- package/dist/skills/outlook-365/macos/scripts/search-emails.applescript +339 -0
- package/dist/skills/outlook-365/macos/scripts/send-email.applescript +245 -0
- package/dist/skills/outlook-365/uia/BASIC_OPERATIONS.md +278 -0
- package/dist/skills/outlook-365/uia/CALENDAR_OPERATIONS.md +386 -0
- package/dist/skills/outlook-365/uia/COMPOSE_EMAIL.md +426 -0
- package/dist/skills/outlook-365/uia/README.md +75 -0
- package/dist/skills/outlook-365/windows/com/bulk-operations.ps1 +241 -0
- package/dist/skills/outlook-365/windows/com/calendar.ps1 +227 -0
- package/dist/skills/outlook-365/windows/com/contacts.ps1 +270 -0
- package/dist/skills/outlook-365/windows/com/helpers.ps1 +158 -0
- package/dist/skills/outlook-365/windows/com/read-emails.ps1 +115 -0
- package/dist/skills/outlook-365/windows/com/search-emails.ps1 +141 -0
- package/dist/skills/outlook-365/windows/com/send-email.ps1 +121 -0
- package/dist/skills/pdf-architect/SKILL.md +640 -0
- package/dist/skills/powerpoint-architect/SKILL.macos.md +271 -0
- package/dist/skills/powerpoint-architect/SKILL.md +853 -0
- package/dist/skills/powerpoint-architect/SKILL.windows.md +458 -0
- package/dist/skills/powerpoint-architect/custom_themes.md +141 -0
- package/dist/skills/powerpoint-architect/editing-guide.md +424 -0
- package/dist/skills/powerpoint-architect/generator-reference.md +668 -0
- package/dist/skills/powerpoint-architect/images-guide.md +207 -0
- package/dist/skills/powerpoint-architect/issue-fix-mapping.md +768 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-html-to-slide.applescript +389 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-slide.applescript +255 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-speaker-notes.applescript +132 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-text.applescript +245 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-slide-layout.applescript +80 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-theme.applescript +122 -0
- package/dist/skills/powerpoint-architect/macos/scripts/autofit-placeholders.applescript +62 -0
- package/dist/skills/powerpoint-architect/macos/scripts/close-presentation.applescript +24 -0
- package/dist/skills/powerpoint-architect/macos/scripts/copy-slides.applescript +303 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-chart-with-data.applescript +305 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-with-theme.applescript +56 -0
- package/dist/skills/powerpoint-architect/macos/scripts/delete-slides.applescript +137 -0
- package/dist/skills/powerpoint-architect/macos/scripts/export-presentation.applescript +100 -0
- package/dist/skills/powerpoint-architect/macos/scripts/extract-slide-data.applescript +138 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-shape.applescript +192 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-slide-content.applescript +336 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-current-slide-number.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-file-path.applescript +94 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layout-elements.applescript +141 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layouts.applescript +58 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-opened-files.applescript +50 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-presentation-info.applescript +150 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-recent-files.applescript +68 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-count.applescript +37 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-info.applescript +105 -0
- package/dist/skills/powerpoint-architect/macos/scripts/health-check.applescript +690 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-shape.applescript +188 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-table.applescript +112 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-text-box.applescript +225 -0
- package/dist/skills/powerpoint-architect/macos/scripts/manage-image.applescript +486 -0
- package/dist/skills/powerpoint-architect/macos/scripts/maximize-window.applescript +48 -0
- package/dist/skills/powerpoint-architect/macos/scripts/navigate-to-slide.applescript +84 -0
- package/dist/skills/powerpoint-architect/macos/scripts/open-presentation.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/reorder-slides.applescript +106 -0
- package/dist/skills/powerpoint-architect/macos/scripts/replace-text.applescript +193 -0
- package/dist/skills/powerpoint-architect/macos/scripts/save-presentation.applescript +54 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-animation.applescript +203 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-transition.applescript +130 -0
- package/dist/skills/powerpoint-architect/visual-styling-guide.md +206 -0
- package/dist/skills/powerpoint-architect/windows/api/advanced.md +317 -0
- package/dist/skills/powerpoint-architect/windows/api/basic.md +392 -0
- package/dist/skills/powerpoint-architect/windows/examples/10-slide-presentation.md +140 -0
- package/dist/skills/powerpoint-architect/windows/examples/custom-theme-workflow.md +219 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-1-workflows.md +531 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-2-scripting.md +239 -0
- package/dist/skills/powerpoint-architect/windows/scripts/create-with-theme.ps1 +81 -0
- package/dist/skills/project-task-list/SKILL.md +174 -0
- package/dist/skills/slack-operation/SKILL.md +97 -0
- package/dist/skills/slack-operation/api/advanced-api/GUIDE.md +277 -0
- package/dist/skills/slack-operation/api/search-and-read/EXAMPLE.md +75 -0
- package/dist/skills/slack-operation/api/search-and-read/GUIDE.md +108 -0
- package/dist/skills/slack-operation/api/send-message/EXAMPLE.md +112 -0
- package/dist/skills/slack-operation/api/send-message/GUIDE.md +63 -0
- package/dist/skills/slack-operation/api/share-files/EXAMPLE.md +94 -0
- package/dist/skills/slack-operation/api/share-files/GUIDE.md +63 -0
- package/dist/skills/slack-operation/ui/desktop-automation/GUIDE.md +55 -0
- package/dist/skills/system-diagnostics/SKILL.md +263 -0
- package/dist/skills/teams-operation/SKILL.md +79 -0
- package/dist/skills/teams-operation/api/advanced-api/GUIDE.md +234 -0
- package/dist/skills/teams-operation/api/meetings/EXAMPLE.md +63 -0
- package/dist/skills/teams-operation/api/meetings/GUIDE.md +52 -0
- package/dist/skills/teams-operation/api/search-and-read/EXAMPLE.md +72 -0
- package/dist/skills/teams-operation/api/search-and-read/GUIDE.md +54 -0
- package/dist/skills/teams-operation/api/send-message/EXAMPLE.md +92 -0
- package/dist/skills/teams-operation/api/send-message/GUIDE.md +60 -0
- package/dist/skills/teams-operation/ui/desktop-automation/GUIDE.md +66 -0
- package/dist/skills/transcribe-media/SKILL.md +142 -0
- package/dist/skills/uipath-integrations/SKILL.md +370 -0
- package/dist/skills/uipath-integrations/reference/connectors.md +331 -0
- package/dist/skills/uipath-integrations/reference/endpoints.md +220 -0
- package/dist/skills/uipath-integrations/reference/errors.md +211 -0
- package/dist/skills/uipath-integrations/reference/metadata.md +317 -0
- package/dist/skills/uipath-integrations/reference/operations.md +297 -0
- package/dist/skills/uipath-orchestrator/SKILL.md +312 -0
- package/dist/skills/uipath-orchestrator/recipes/assets.md +282 -0
- package/dist/skills/uipath-orchestrator/recipes/audit-logs.md +215 -0
- package/dist/skills/uipath-orchestrator/recipes/buckets.md +205 -0
- package/dist/skills/uipath-orchestrator/recipes/jobs.md +286 -0
- package/dist/skills/uipath-orchestrator/recipes/list-folders.md +207 -0
- package/dist/skills/uipath-orchestrator/recipes/queue-items.md +292 -0
- package/dist/skills/uipath-orchestrator/recipes/queues.md +232 -0
- package/dist/skills/uipath-orchestrator/recipes/releases.md +212 -0
- package/dist/skills/uipath-orchestrator/recipes/robots-sessions.md +274 -0
- package/dist/skills/uipath-orchestrator/recipes/schedules.md +280 -0
- package/dist/skills/uipath-orchestrator/reference/endpoints.md +85 -0
- package/dist/skills/uipath-orchestrator/reference/schemas.md +153 -0
- package/dist/skills/uipath-taskautomation/SKILL.md +310 -0
- package/dist/skills/uipath-taskautomation/assets/CodedWorkflow.template.cs +98 -0
- package/dist/skills/uipath-taskautomation/assets/ExampleWorkflow.cs +146 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.json +32 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.md +44 -0
- package/dist/skills/uipath-taskautomation/references/app-profiles.md +63 -0
- package/dist/skills/uipath-taskautomation/references/automation-spec.md +88 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/before-after-hooks-template.md +115 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/codedworkflow-template.md +186 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/helper-utility-template.md +22 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/json-template.md +91 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/testcase-template.md +92 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/cli-reference.md +249 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/codedworkflow-reference.md +275 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/coding-guidelines.md +229 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/inspect-package-guide.md +81 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/integration-service-guide.md +507 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/operations-guide.md +410 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/third-party-packages-guide.md +67 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/data-manipulation-guide.md +110 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/environment-setup.md +194 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/error-handling-guide.md +195 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/powershell-interop-guide.md +57 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure-guide.md +114 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure.md +126 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/uia-elements-interaction-guide.md +109 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/validation-guide.md +147 -0
- package/dist/skills/uipath-taskautomation/references/coded-workflow-authoring.md +219 -0
- package/dist/skills/uipath-taskautomation/references/profiling-output.md +80 -0
- package/dist/skills/uipath-taskautomation/references/reliability-guide.md +83 -0
- package/dist/skills/uipath-taskautomation/references/task-automation-cheatsheet.md +272 -0
- package/dist/skills/uipath-taskautomation/references/template-preflight.md +17 -0
- package/dist/skills/uipath-workflow-documenter/SKILL.md +430 -0
- package/dist/skills/uipath-workflow-documenter/layouts/pdd-template.md +265 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-orchestrator.md +11 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-workflow.md +11 -0
- package/dist/skills/word-architect/SKILL.macos.md +147 -0
- package/dist/skills/word-architect/SKILL.md +502 -0
- package/dist/skills/word-architect/SKILL.windows.md +55 -0
- package/dist/skills/word-architect/api/advanced.md +522 -0
- package/dist/skills/word-architect/api/basic.md +378 -0
- package/dist/skills/word-architect/api/expert.md +302 -0
- package/dist/skills/word-architect/generation.md +308 -0
- package/dist/skills/word-architect/layouts/01-professional.md +168 -0
- package/dist/skills/word-architect/layouts/02-educational-kids.md +354 -0
- package/dist/skills/word-architect/layouts/03-academic.md +83 -0
- package/dist/skills/word-architect/layouts/04-creative.md +242 -0
- package/dist/skills/word-architect/layouts/05-operational.md +94 -0
- package/dist/skills/word-architect/macos/scripts/apply-heading-style.applescript +215 -0
- package/dist/skills/word-architect/macos/scripts/apply-style.applescript +272 -0
- package/dist/skills/word-architect/macos/scripts/autofit-tables.applescript +53 -0
- package/dist/skills/word-architect/macos/scripts/close-document.applescript +287 -0
- package/dist/skills/word-architect/macos/scripts/create-chart-with-data.applescript +379 -0
- package/dist/skills/word-architect/macos/scripts/create-chart.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/delete-selection.applescript +223 -0
- package/dist/skills/word-architect/macos/scripts/export-document.applescript +167 -0
- package/dist/skills/word-architect/macos/scripts/extract-table.applescript +168 -0
- package/dist/skills/word-architect/macos/scripts/find-by-style.applescript +173 -0
- package/dist/skills/word-architect/macos/scripts/find-text.applescript +199 -0
- package/dist/skills/word-architect/macos/scripts/format-table.applescript +234 -0
- package/dist/skills/word-architect/macos/scripts/format-text.applescript +431 -0
- package/dist/skills/word-architect/macos/scripts/get-document-properties.applescript +95 -0
- package/dist/skills/word-architect/macos/scripts/get-document-structure.applescript +371 -0
- package/dist/skills/word-architect/macos/scripts/get-header-footer-text.applescript +106 -0
- package/dist/skills/word-architect/macos/scripts/get-images.applescript +166 -0
- package/dist/skills/word-architect/macos/scripts/get-opened-files.applescript +103 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-bounds.applescript +133 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-format.applescript +134 -0
- package/dist/skills/word-architect/macos/scripts/get-recent-files.applescript +82 -0
- package/dist/skills/word-architect/macos/scripts/get-styled-text.applescript +256 -0
- package/dist/skills/word-architect/macos/scripts/get-tables.applescript +126 -0
- package/dist/skills/word-architect/macos/scripts/get-text-formatting.applescript +224 -0
- package/dist/skills/word-architect/macos/scripts/get-text.applescript +383 -0
- package/dist/skills/word-architect/macos/scripts/get-theme-colors.applescript +123 -0
- package/dist/skills/word-architect/macos/scripts/health-check.applescript +606 -0
- package/dist/skills/word-architect/macos/scripts/insert-cover-page.applescript +77 -0
- package/dist/skills/word-architect/macos/scripts/insert-header-footer.applescript +87 -0
- package/dist/skills/word-architect/macos/scripts/insert-horizontal-line.applescript +112 -0
- package/dist/skills/word-architect/macos/scripts/insert-html.applescript +440 -0
- package/dist/skills/word-architect/macos/scripts/insert-hyperlink.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/insert-image.applescript +320 -0
- package/dist/skills/word-architect/macos/scripts/insert-list.applescript +317 -0
- package/dist/skills/word-architect/macos/scripts/insert-pagebreak.applescript +181 -0
- package/dist/skills/word-architect/macos/scripts/insert-smartart.applescript +104 -0
- package/dist/skills/word-architect/macos/scripts/insert-table.applescript +238 -0
- package/dist/skills/word-architect/macos/scripts/insert-text.applescript +677 -0
- package/dist/skills/word-architect/macos/scripts/insert-textbox.applescript +261 -0
- package/dist/skills/word-architect/macos/scripts/maximize-window.applescript +67 -0
- package/dist/skills/word-architect/macos/scripts/normalize-formatting.applescript +56 -0
- package/dist/skills/word-architect/macos/scripts/open-document.applescript +222 -0
- package/dist/skills/word-architect/macos/scripts/replace-text.applescript +390 -0
- package/dist/skills/word-architect/macos/scripts/save-document.applescript +230 -0
- package/dist/skills/word-architect/macos/scripts/select-range.applescript +142 -0
- package/dist/skills/word-architect/macos/scripts/set-document-properties.applescript +195 -0
- package/dist/skills/word-architect/macos/scripts/set-page-layout.applescript +273 -0
- package/dist/skills/word-architect/macos/scripts/set-theme-colors.applescript +264 -0
- package/dist/skills/word-architect/macos/scripts/undo-redo.applescript +61 -0
- package/dist/skills/word-architect/macos/scripts/update-toc.applescript +112 -0
- package/dist/skills/word-architect/reference/formatting.md +119 -0
- package/dist/skills/word-architect/reference/html-layouts/01-executive-summary-box.md +36 -0
- package/dist/skills/word-architect/reference/html-layouts/02-kpi-summary-table.md +68 -0
- package/dist/skills/word-architect/reference/html-layouts/03-comparison-table.md +63 -0
- package/dist/skills/word-architect/reference/html-layouts/04-pros-cons-table.md +86 -0
- package/dist/skills/word-architect/reference/html-layouts/05-timeline-table.md +114 -0
- package/dist/skills/word-architect/reference/html-layouts/06-raci-matrix.md +95 -0
- package/dist/skills/word-architect/reference/html-layouts/07-data-table-alternating.md +84 -0
- package/dist/skills/word-architect/reference/html-layouts/08-callout-box.md +102 -0
- package/dist/skills/word-architect/reference/html-layouts/09-vertical-milestone.md +100 -0
- package/dist/skills/word-architect/reference/quality-assurance.md +102 -0
- package/dist/skills/word-architect/reference/tables.md +62 -0
- package/dist/skills/word-architect/reference/tracked-changes.md +34 -0
- package/dist/skills/word-architect/reference/uia-fallback.md +231 -0
- package/dist/skills/word-architect/reference/visual-elements.md +82 -0
- package/dist/skills/word-architect/windows/scripts/apply-heading-style.ps1 +190 -0
- package/dist/skills/word-architect/windows/scripts/autofit-tables.ps1 +64 -0
- package/dist/skills/word-architect/windows/scripts/create-chart-with-data.ps1 +133 -0
- package/dist/skills/word-architect/windows/scripts/create-chart.ps1 +73 -0
- package/dist/skills/word-architect/windows/scripts/export-document.ps1 +86 -0
- package/dist/skills/word-architect/windows/scripts/get-current-file.ps1 +27 -0
- package/dist/skills/word-architect/windows/scripts/insert-cover-page.ps1 +79 -0
- package/dist/skills/word-architect/windows/scripts/insert-horizontal-line.ps1 +74 -0
- package/dist/skills/word-architect/windows/scripts/insert-image.ps1 +98 -0
- package/dist/skills/word-architect/windows/scripts/insert-smartart.ps1 +118 -0
- package/dist/skills/word-architect/windows/scripts/insert-text-box.ps1 +90 -0
- package/dist/skills/word-architect/windows/scripts/normalize-formatting.ps1 +63 -0
- package/package.json +5 -4
|
@@ -0,0 +1,502 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: word-architect
|
|
3
|
+
friendly_name: Word Architect
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
description: Create Word documents across 5 templates (Professional, Educational/Kids, Academic, Creative, Operational). Use this when the user needs to create, structure, or format Word documents.
|
|
6
|
+
icon: word
|
|
7
|
+
color: 2B579A
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Word Architect
|
|
11
|
+
|
|
12
|
+
## Large generate payloads → `bodyFromFile`
|
|
13
|
+
|
|
14
|
+
For `/doc-gen/generate` with > 30 blocks, multi-page tables, or content arrays > ~3500 tokens of inline JSON: put the spec on disk, pass the path. Don't inline, don't pre-draft in `<thinking>`.
|
|
15
|
+
|
|
16
|
+
```json
|
|
17
|
+
{ "operations": [{ "endpoint": "/doc-gen/generate", "bodyFromFile": "/tmp/doc.json" }],
|
|
18
|
+
"toolName": "Generate Document", "description": "..." }
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Executor reads the file. Don't `ReadFile` it back.
|
|
22
|
+
|
|
23
|
+
**The `bodyFromFile` path MUST be under the OS temp dir** — Windows `%TEMP%\...` (= `C:\Users\<user>\AppData\Local\Temp\...`), macOS/Linux `/tmp/...`. NEVER write the spec to Documents, Desktop, Downloads, or any other user folder. (`outputPath`, `templatePath`, and other user-facing files DO go to user folders — this rule is only for the internal `bodyFromFile` spec.) The executor auto-deletes temp spec files after a successful call; files outside temp linger forever and clutter the user's machine.
|
|
24
|
+
|
|
25
|
+
**Use a unique filename per run.** Suffix with a timestamp or short tag — e.g. `/tmp/doc-1714838400.json`, `%TEMP%\doc-1714838400.json`, `/tmp/build-doc-1714838400.js`. Reusing the same name (`doc.json`, `build-doc.js`) collides with leftover files from previous runs.
|
|
26
|
+
|
|
27
|
+
**Never expose internal terminology to the user — anywhere in chat, ever.** Forbidden list: `bodyFromFile`, `JSON`, `Node script`, `spec`, `payload`, `temp file`, `inline body`, `WriteFile`, `ExecuteSkillApi`, `endpoint`, `staging`, `payload limits`. The user asked for a document; they don't need to know HOW it gets built. **Never ask the user to choose between implementation paths** ("should I draft a script?", "do you want bodyFromFile?") — you decide silently. The only acceptable user-facing chat about the build is one short plain-language status update: *"Setting up your document."* / *"Building it now."* / *"Putting it together."*
|
|
28
|
+
|
|
29
|
+
Two ways — pick by shape:
|
|
30
|
+
|
|
31
|
+
1. **Static** (explicit headings/paragraphs, no loops): `WriteFile` JSON straight to `/tmp/doc.json` (`%TEMP%\doc.json` on Windows).
|
|
32
|
+
2. **Repetitive/programmatic** (generated tables, looped sections, research-driven content): `WriteFile` a Node script `/tmp/build-doc.js` that builds `{ options, content }`, then `ExecuteBashCommand` → `node /tmp/build-doc.js > /tmp/doc.json`.
|
|
33
|
+
|
|
34
|
+
Tweak one field (`outputPath`, `theme`, `templatePath`) without rewriting → pass `bodyFromFile` + small inline `body`; inline wins on collision.
|
|
35
|
+
|
|
36
|
+
≤ 30 blocks → build inline.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Step 1: Generate or Edit?
|
|
41
|
+
|
|
42
|
+
**First, determine what the user needs.** This decides the entire workflow AND what you must load.
|
|
43
|
+
|
|
44
|
+
**CRITICAL — Does the user provide a .docx file to use as a template?**
|
|
45
|
+
If YES (phrases: "use this as a template", "based on this template", "follow this format/style", "make a document like this one but about X"), you MUST pass the template file path as `templatePath` in the `/doc-gen/generate` or `/doc-gen/start` options. The generator will automatically extract the template's theme (fonts, colors, sizes, spacing), page setup (margins, page size, orientation), and headers/footers. Do NOT set a named `theme` when using `templatePath`. Skip "Pick a Template" (Step 2) entirely.
|
|
46
|
+
|
|
47
|
+
Example (full `ExecuteSkillApi` shape — `operations[]` wrapper + per-op `endpoint`+`body`, plus `toolName`/`description`):
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"operations": [{
|
|
51
|
+
"endpoint": "/doc-gen/start",
|
|
52
|
+
"body": {
|
|
53
|
+
"options": {
|
|
54
|
+
"title": "My Document",
|
|
55
|
+
"templatePath": "/Users/.../Downloads/template.docx",
|
|
56
|
+
"outputPath": "/Users/.../Documents/output.docx"
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}],
|
|
60
|
+
"toolName": "Generate Document",
|
|
61
|
+
"description": "Starting document from template"
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Other `endpoint:` / `body:` snippets in this skill describe the per-op shape only — always wrap them in `operations[]` with `toolName`+`description` when calling `ExecuteSkillApi`.
|
|
66
|
+
|
|
67
|
+
### Path A: CREATE new document
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
1. If user provides a .docx template → pass templatePath in options (see above), skip Step 2
|
|
71
|
+
If no template → Pick a template → READ the matching layouts/*.md file
|
|
72
|
+
2. READ generation.md for the doc-gen workflow and block types
|
|
73
|
+
3. Research the topic (WebSearch — MANDATORY, DO NOT SKIP)
|
|
74
|
+
4. Plan page budget → see "Page Budget" section below. Count H1 sections, compute budget_per_section, plan blocks per section to hit the target.
|
|
75
|
+
5. Generate (ALWAYS include coverPage → toc → pageBreak before content sections):
|
|
76
|
+
- ≤30 blocks → /doc-gen/generate (single call)
|
|
77
|
+
- >30 blocks → /doc-gen/start → /doc-gen/add-content → /doc-gen/finish
|
|
78
|
+
6. After generation → open with /word/open-attach → if it has a toc block, fill it with /word/update/toc `{"action":"update"}` → verify with /word/get/document-structure
|
|
79
|
+
7. Fix issues → switch to EDIT path below
|
|
80
|
+
8. Quality check → READ reference/quality-assurance.md → run `/word/get-status` (macOS) or manual checks (Windows) → fix issues → save
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Path B: EDIT existing document
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
1. Resolve file path (file_discovery if needed) → /word/open-attach
|
|
87
|
+
│
|
|
88
|
+
2. MANDATORY LOAD — before ANY edit operation, read:
|
|
89
|
+
│ └─ api/basic.md (open, save, get text, get structure, find, replace, insert, delete, format, apply style, position rules)
|
|
90
|
+
│
|
|
91
|
+
3. Understand the document:
|
|
92
|
+
│ ├─ /word/get/document-structure → see headings + paragraph numbers
|
|
93
|
+
│ ├─ /word/get/text (on target area) → see actual content before editing
|
|
94
|
+
│ └─ Note the formatting of existing headings, body text, and tables (font, size, color)
|
|
95
|
+
│
|
|
96
|
+
3b. READ FORMATTING FROM THE DOCUMENT (MANDATORY before inserting ANY new content):
|
|
97
|
+
│
|
|
98
|
+
│ You MUST read the existing heading and body formatting BEFORE inserting anything.
|
|
99
|
+
│ This is required for step 4 — without these values, new content will have wrong styling.
|
|
100
|
+
│
|
|
101
|
+
│ HOW: Use `/word/find/by-style` to locate paragraphs of the right type — DO NOT pick
|
|
102
|
+
│ arbitrary paragraph numbers from the structure (TOC entries, headers/footers, and
|
|
103
|
+
│ newly-inserted unstyled paragraphs all return wrong values).
|
|
104
|
+
│
|
|
105
|
+
│ /word/find/by-style { styleName: "Heading 1", maxResults: 1 }
|
|
106
|
+
│ → take the first match's paragraphNumber, then:
|
|
107
|
+
│ /word/get/textformatting { paragraphNumber: <H1 paragraph> }
|
|
108
|
+
│ → save the fontName, fontSize, textColorHex, bold values for HEADINGS
|
|
109
|
+
│
|
|
110
|
+
│ /word/find/by-style { styleName: "Normal", maxResults: 1 }
|
|
111
|
+
│ → take the first match's paragraphNumber, then:
|
|
112
|
+
│ /word/get/textformatting { paragraphNumber: <Normal paragraph> }
|
|
113
|
+
│ → save the fontName, fontSize, textColorHex values for BODY TEXT
|
|
114
|
+
│
|
|
115
|
+
│ CHECK the response: if `styleName` is "TOC ...", "Caption", "Header", "Footer", or
|
|
116
|
+
│ "Default Paragraph Font", the values are NOT body text — pick a different paragraph.
|
|
117
|
+
│ If the response includes a `message` warning the style is wrong, follow that warning.
|
|
118
|
+
│
|
|
119
|
+
│ These values will be used in step 4 (Step B) to format every inserted paragraph.
|
|
120
|
+
│ Do NOT skip this step. Do NOT use hardcoded formatting values.
|
|
121
|
+
│
|
|
122
|
+
│ ONLY if /word/get/textformatting fails, fall back to the theme table below.
|
|
123
|
+
│ If theme is not in the table → default to consulting values.
|
|
124
|
+
│
|
|
125
|
+
│ Theme formatting reference (from generator):
|
|
126
|
+
│ ┌──────────────┬──────────────────┬────────┬──────────┬──────────────────┬────────┬──────────┐
|
|
127
|
+
│ │ Theme │ Heading font │ H1 pt │ H1 color │ Body font │ Body pt│ Body clr │
|
|
128
|
+
│ ├──────────────┼──────────────────┼────────┼──────────┼──────────────────┼────────┼──────────┤
|
|
129
|
+
│ │ consulting │ Calibri │ 22 │ 2F5496 │ Calibri │ 11 │ 333333 │
|
|
130
|
+
│ │ modern │ Aptos │ 24 │ 0F7B6C │ Aptos │ 11 │ 374151 │
|
|
131
|
+
│ │ corporate │ Cambria │ 22 │ 1B3A5C │ Calibri │ 11 │ 2D2D2D │
|
|
132
|
+
│ │ academic │ Times New Roman │ 20 │ 1A1A1A │ Georgia │ 12 │ 1A1A1A │
|
|
133
|
+
│ │ minimal │ Helvetica Neue │ 21 │ 2D2D2D │ Helvetica Neue │ 11 │ 4A4A4A │
|
|
134
|
+
│ │ playful │ Comic Sans MS │ 24 │ E65100 │ Calibri │ 12 │ 37474F │
|
|
135
|
+
│ │ vibrant │ Georgia │ 23 │ B22222 │ Calibri │ 11 │ 3E2723 │
|
|
136
|
+
│ │ nature │ Trebuchet MS │ 23 │ 2E7D32 │ Calibri │ 11 │ 333333 │
|
|
137
|
+
│ │ ocean │ Verdana │ 23 │ 01579B │ Calibri │ 11 │ 263238 │
|
|
138
|
+
│ └──────────────┴──────────────────┴────────┴──────────┴──────────────────┴────────┴──────────┘
|
|
139
|
+
│
|
|
140
|
+
4. Edit via /word/* API
|
|
141
|
+
│ ├─ For NEW content (adding sections, paragraphs, tables) — TWO-STEP process:
|
|
142
|
+
│ │
|
|
143
|
+
│ │ Step A: Insert structure with /word/insert/html
|
|
144
|
+
│ │ Use HTML for structure (headings, paragraphs, tables, lists).
|
|
145
|
+
│ │ DO NOT rely on inline CSS font-size or color — they are NOT reliably applied.
|
|
146
|
+
│ │ USE HTML ENTITIES for special characters — ONLY inside the `html` field
|
|
147
|
+
│ │ of /word/insert/html (textutil corrupts raw Unicode on macOS):
|
|
148
|
+
│ │ em dash: — en dash: – right quote: ’
|
|
149
|
+
│ │ left quote: ‘ left double: “ right double: ”
|
|
150
|
+
│ │ Do NOT use raw —, ', ", etc. inside HTML content for /word/insert/html.
|
|
151
|
+
│ │ Do NOT use these entities in /doc-gen/* content blocks or in any other
|
|
152
|
+
│ │ /word/* `text` / `searchText` / `replacementText` field — those take
|
|
153
|
+
│ │ RAW Unicode (write — ' " directly).
|
|
154
|
+
│ │ Example:
|
|
155
|
+
│ │ <h1>8. Conclusion</h1>
|
|
156
|
+
│ │ <p>The market—driven by strong demand—is growing.</p>
|
|
157
|
+
│ │
|
|
158
|
+
│ │ Step B: Apply styles and format after insert (macOS: batch, one call each)
|
|
159
|
+
│ │ insert/html produces WRONG font sizes and NO colors. Fix every inserted paragraph.
|
|
160
|
+
│ │ Apply style FIRST, format AFTER — apply/style resets formatting to style defaults.
|
|
161
|
+
│ │
|
|
162
|
+
│ │ Insertion invalidates every paragraph number and character index you held. Re-query
|
|
163
|
+
│ │ after inserting; never reuse a pre-insertion position.
|
|
164
|
+
│ │
|
|
165
|
+
│ │ macOS — 3 calls total, regardless of paragraph count:
|
|
166
|
+
│ │ 1. /word/get/document-structure { includeParagraphBounds: true } (macOS only)
|
|
167
|
+
│ │ → returns paragraphBounds: [{paragraphNumber, paragraphStart, paragraphEnd}, ...]
|
|
168
|
+
│ │ for EVERY paragraph. This is the only position read you need; do NOT call
|
|
169
|
+
│ │ /word/get/paragraph-bounds per paragraph.
|
|
170
|
+
│ │ Bounds carry positions, not text: only headings come back with their text. If
|
|
171
|
+
│ │ you generated the whole document, paragraph order tells you which is which.
|
|
172
|
+
│ │ If you inserted body-only content, or inserted among paragraphs that were
|
|
173
|
+
│ │ already there, first find your new paragraphs with /word/find/text — its
|
|
174
|
+
│ │ paragraphNumber indexes straight into paragraphBounds — and batch those.
|
|
175
|
+
│ │ Do NOT count paragraphs out of includeContent: each section's text is
|
|
176
|
+
│ │ capped at 500 characters, so the count silently drifts in longer sections.
|
|
177
|
+
│ │ 2. /word/apply/style ONE batch — character ranges taken from step 1:
|
|
178
|
+
│ │ { batch: [ { styleName: "Heading 1", range: { start: <paragraphStart>, end: <paragraphEnd> } },
|
|
179
|
+
│ │ { styleName: "Heading 2", range: { start: ..., end: ... } } ] }
|
|
180
|
+
│ │ 3. /word/format/text ONE batch, same range shape:
|
|
181
|
+
│ │ { batch: [ { range: { start: ..., end: ... }, fontName: ..., fontSize: ...,
|
|
182
|
+
│ │ textColorHex: ..., bold: ... } ] }
|
|
183
|
+
│ │
|
|
184
|
+
│ │ Windows — no batch endpoint, and no includeParagraphBounds. Per paragraph:
|
|
185
|
+
│ │ 1. /word/find/text { searchText: "<paragraph text>" } → the FRESH paragraph
|
|
186
|
+
│ │ number from the response. NEVER guess or reuse a pre-insertion number.
|
|
187
|
+
│ │ 2. /word/apply/style { range: { start: { anchor: "paragraphStart", paragraph: N },
|
|
188
|
+
│ │ end: { anchor: "paragraphEnd", paragraph: N },
|
|
189
|
+
│ │ expectedText: "<paragraph text>" },
|
|
190
|
+
│ │ styleName: "Heading 1" }
|
|
191
|
+
│ │ Use paragraphStart/paragraphEnd anchors, NEVER characterIndex — character
|
|
192
|
+
│ │ offsets go stale after any edit.
|
|
193
|
+
│ │ 3. /word/get/paragraph-bounds { paragraphNumber: N } → paragraphStart, paragraphEnd
|
|
194
|
+
│ │ 4. /word/format/text AFTER the style, same range shape as step 2, carrying the
|
|
195
|
+
│ │ font values from step 3b: fontName, fontSize, textColorHex, bold.
|
|
196
|
+
│ │
|
|
197
|
+
│ │ macOS only — styling a single paragraph → skip the range entirely:
|
|
198
|
+
│ │ /word/apply/style { paragraphNumber: N, styleName: "Heading 1" }
|
|
199
|
+
│ │ This resolves no positions and costs one native call. Windows has no
|
|
200
|
+
│ │ paragraphNumber field and requires range, so keep the anchored range
|
|
201
|
+
│ │ from step 2 above there.
|
|
202
|
+
│ │
|
|
203
|
+
│ │ A batch that applied nothing returns success:false with operationsCompleted:0 and
|
|
204
|
+
│ │ doNotRetry:true → re-read the document and rebuild the batch; never replay the payload.
|
|
205
|
+
│ │
|
|
206
|
+
│ │ Character offsets go stale on any insert or delete. Safe inside one batch built from a
|
|
207
|
+
│ │ fresh structure read (styling and formatting do not change character counts). After
|
|
208
|
+
│ │ any insert/delete, re-read the structure before building the next batch.
|
|
209
|
+
│ │ Use the EXACT font values captured in step 3b, never hardcoded ones.
|
|
210
|
+
│ │ Never fix formatting via UIA/AppAct — always /word/format/text.
|
|
211
|
+
│ ├─ For EXISTING content (replacing, formatting): /word/* API as normal
|
|
212
|
+
│ ├─ Success → continue
|
|
213
|
+
│ └─ API fails once → retry with corrected params (check error message)
|
|
214
|
+
│ └─ Fails again → LOAD reference/uia-fallback.md → AppAct (LAST RESORT)
|
|
215
|
+
│
|
|
216
|
+
4b. If headings were added/removed/renamed → UPDATE TOC:
|
|
217
|
+
│ ├─ macOS: /word/update/toc { "action": "update" }
|
|
218
|
+
│ └─ Windows: /word/update/toc
|
|
219
|
+
│
|
|
220
|
+
5. LOAD MORE based on what the task requires:
|
|
221
|
+
├─ Tables, images, charts, lists, hyperlinks, **diagrams**,
|
|
222
|
+
│ headers/footers, page layout, textboxes, PDF export? → READ api/advanced.md
|
|
223
|
+
├─ C# scripting (Windows), position errors,
|
|
224
|
+
│ shape management? → READ api/expert.md
|
|
225
|
+
├─ Table overflow or column-limit issues? → READ reference/tables.md
|
|
226
|
+
├─ Chart design, SmartArt, cover pages? → READ reference/visual-elements.md
|
|
227
|
+
├─ Typography, image sizing, page breaks, TOC, page numbering? → READ reference/formatting.md
|
|
228
|
+
└─ Track changes or comments (Windows only)? → READ reference/tracked-changes.md
|
|
229
|
+
│
|
|
230
|
+
6. Quality check → READ reference/quality-assurance.md → run `/word/get-status` (macOS) or manual checks (Windows) → fix issues → save
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
**Key rules:**
|
|
234
|
+
- **On Windows, NEVER put Word on screen unless the user asked to see it.** See "Windowless by Default (Windows)" below — and read the macOS note there before telling the user anything about what is or is not visible.
|
|
235
|
+
- **ALWAYS pass `filePath` to EVERY `/word/*` API call.** After `/word/open-attach` returns, reuse that exact `filePath` in all subsequent calls. Do NOT omit it, guess it, or reconstruct it. If you don't have it, call `/word/get-opened-files` or `file_discovery` first.
|
|
236
|
+
- **`/word/open-attach` must be its own standalone call** — NEVER batch it with other operations. The document context from one operation does not carry into the next operation in the same batch.
|
|
237
|
+
- **Never run native Word calls in parallel.** For multiple documents, finish one document's open → read → edit → save sequence before touching the next.
|
|
238
|
+
- **NEVER edit without reading the document first** (get structure + get text)
|
|
239
|
+
- **NEVER call an API endpoint you haven't read the docs for** — load the api/*.md file first
|
|
240
|
+
- **NEVER switch to UIA without loading reference/uia-fallback.md** — it has shortcuts, paste_content patterns, and gotchas
|
|
241
|
+
- **Fallback order: API → retry with corrected params → UIA.** On Windows, C# scripting and PowerShell scripts come before UIA (see platform notes below). UIA (AppAct) is always the LAST resort.
|
|
242
|
+
- **NEVER expose internals** — no endpoint names or JSON in user-facing messages.
|
|
243
|
+
- **ALWAYS update the TOC after adding, removing, or renaming headings:**
|
|
244
|
+
- Both platforms: `/word/update/toc` with `{"action":"update"}`
|
|
245
|
+
- **MAINTAIN DESIGN when adding content to a generated document** — follow steps 3b→4 (theme lookup → insert HTML → format/text). Skipping format/text produces wrong fonts/sizes/colors.
|
|
246
|
+
|
|
247
|
+
**Diagrams (EDIT path):** To insert a diagram into an existing document, ALWAYS use `/diagram/render-mermaid` to render Mermaid code to a PNG file, then `/word/insert/picture` to place it. See api/advanced.md for full details. NEVER use UIA or shape-by-shape insertion for diagrams.
|
|
248
|
+
**Diagrams (CREATE path):** Use `diagram` block type with diagram definition syntax. See generation.md for fields and examples.
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
## Windowless by Default (Windows)
|
|
253
|
+
|
|
254
|
+
**The user asked for a document, not for Word.** Generating, editing, and reviewing all happen without Word appearing on screen, and you must keep it that way. A window that opens on its own steals focus, covers what the user is doing, and invites them to edit a document you are still writing.
|
|
255
|
+
|
|
256
|
+
**On Windows,** `/word/open-attach` defaults to `visible: false` — you do not have to ask for this, only avoid breaking it.
|
|
257
|
+
|
|
258
|
+
**Pass `visible: true` only when the user asked to see the document**, in words like "open it", "show me", "let me look at it", or "leave it open when you're done". A request to *create* or *fix* a document is not a request to watch it happen.
|
|
259
|
+
|
|
260
|
+
Nothing else needs a window:
|
|
261
|
+
|
|
262
|
+
| Operation | Needs a window? |
|
|
263
|
+
|-----------|-----------------|
|
|
264
|
+
| Generation (`/doc-gen/*`) | No — writes the .docx directly, Word is not involved at all, on either platform |
|
|
265
|
+
| Reading (`get/text`, `get/document-structure`, `find/*`, `get/styledtext`) | No |
|
|
266
|
+
| Editing (`insert/*`, `replace/*`, `delete/*`, `apply-style`, `format/*`, tables, charts) | No |
|
|
267
|
+
| `save`, `close`, `export-to-pdf`, `execute-script`, `update/toc` | No |
|
|
268
|
+
| Computer use on Word (screenshots, clicking, UIA/AppAct) | **Yes** — pass `visible: true` before falling back to UIA |
|
|
269
|
+
|
|
270
|
+
**Two consequences worth knowing:**
|
|
271
|
+
|
|
272
|
+
- **`documentId` and `pid` are still real numbers** for a windowless document — they come from the document's own hidden window. They are `0` only when Word cannot report a window at all. Either way, do not key anything off them: every other endpoint targets the document by `filePath`.
|
|
273
|
+
- **Close when you are done** — it releases the file. Leave it open and the user cannot rename, move, or delete their own document, and has no window to close it from. On Windows this is safe unconditionally: closing releases only your handle, and a document the user already had open stays open on screen.
|
|
274
|
+
|
|
275
|
+
Attaching never hides a window the user already has open.
|
|
276
|
+
|
|
277
|
+
### macOS is different — do not promise otherwise
|
|
278
|
+
|
|
279
|
+
**`visible` does not exist on macOS.** `/word/open-attach` runs AppleScript that activates Word and then maximizes the window, so the document **will** appear and take focus. Never tell the user their document is being handled off-screen on macOS, and do not plan around a window that will not be there.
|
|
280
|
+
|
|
281
|
+
**`/word/close` on macOS closes the document without saving, whoever opened it.** So on macOS, only close a document you opened yourself, always `/word/save` first, and leave a document the user already had open alone.
|
|
282
|
+
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
## Compatibility Mode (legacy `.doc`, macOS)
|
|
286
|
+
|
|
287
|
+
Word opens `.doc` in Compatibility Mode, where document-object AppleEvents can block indefinitely. Delegate drives those files through simulated user events (clipboard plus keystrokes) instead of the document object.
|
|
288
|
+
|
|
289
|
+
- Operations are slower than on `.docx`.
|
|
290
|
+
- Verification is weaker: `verified` proves the selection changed after the paste, not that specific text landed.
|
|
291
|
+
- Prefer converting to `.docx` when the user allows it.
|
|
292
|
+
|
|
293
|
+
**Result contract. Act on these fields:**
|
|
294
|
+
|
|
295
|
+
| Field | Meaning | Required action |
|
|
296
|
+
|---|---|---|
|
|
297
|
+
| `compatibilityMode: true` | legacy `.doc` driven by simulated user events | expect slower operations and weaker verification |
|
|
298
|
+
| `boundary_only`, `textInserted: false`, `retryTextOnly: true` | paragraph boundary landed; text did not | re-issue only the text; the empty paragraph remains |
|
|
299
|
+
| `applied_unverified` | the mutation MAY have landed | treat the document state as unknown, not as unchanged |
|
|
300
|
+
| `doNotRetry: true` | replaying the original mutation is forbidden | never replay the original operation |
|
|
301
|
+
|
|
302
|
+
After `applied_unverified`: read the document back (`/word/get/text`) or ask the user, before any further mutation on that document. Do not retry. Do not assume failure.
|
|
303
|
+
|
|
304
|
+
---
|
|
305
|
+
|
|
306
|
+
## Step 2: Pick a Template (NEW Documents Only)
|
|
307
|
+
|
|
308
|
+
**Skip this entirely if editing an existing document or if the user provided a .docx template file** (the template's theme is extracted automatically via `templatePath`).
|
|
309
|
+
|
|
310
|
+
Read the user's request and classify it into one of these 5 templates. Then read the matching layout file for full rules on heading style, structure, tone, required elements, and example patterns. **Do NOT mix templates.**
|
|
311
|
+
|
|
312
|
+
| # | Template | Layout File | Trigger words | Heading style |
|
|
313
|
+
| --- | -------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------ | --------------------------------------------------- |
|
|
314
|
+
| 1 | **Professional** | [layouts/01-professional.md](layouts/01-professional.md) | report, analysis, market, business, proposal, executive, financial | Numbered: `1. Executive Summary`, `2.1 Analysis` |
|
|
315
|
+
| 2 | **Educational/Kids** | [layouts/02-educational-kids.md](layouts/02-educational-kids.md) | kids, children, fun, learning, school, family, guide for children | Emoji-prefixed: `Meet the T-Rex!`, `Fun Facts!` |
|
|
316
|
+
| 3 | **Academic** | [layouts/03-academic.md](layouts/03-academic.md) | research, paper, study, thesis, whitepaper, specification | Numbered: `1. Introduction`, `2.1 Methodology` |
|
|
317
|
+
| 4 | **Creative** | [layouts/04-creative.md](layouts/04-creative.md) | travel, recipe, story, personal, portfolio, lifestyle, event | Descriptive: `The Hidden Beaches of Algarve` |
|
|
318
|
+
| 5 | **Operational** | [layouts/05-operational.md](layouts/05-operational.md) | meeting, plan, SOP, runbook, status, onboarding, retrospective | Action-oriented: `Deployment Steps`, `Action Items` |
|
|
319
|
+
|
|
320
|
+
**IMPORTANT — default to Professional.** Use Professional for ANY generic request like "create a doc about X", "write about Y", or "make a document on Z". The topic alone (animals, science, clouds, space, etc.) does NOT determine the template — only the user's explicit intent does:
|
|
321
|
+
- Educational/Kids: ONLY when the user explicitly says "for kids", "for children", "fun guide for kids", etc.
|
|
322
|
+
- Academic: ONLY when the user says "research paper", "thesis", "study", etc.
|
|
323
|
+
- Creative: ONLY when the user says "travel guide", "recipe", "story", "portfolio", etc.
|
|
324
|
+
- Operational: ONLY when the user says "meeting notes", "SOP", "runbook", "plan", etc.
|
|
325
|
+
- **Everything else → Professional.** A simple "doc about clouds" = Professional, NOT Educational/Kids.
|
|
326
|
+
|
|
327
|
+
---
|
|
328
|
+
|
|
329
|
+
## Research Before Writing (MANDATORY — DO NOT SKIP)
|
|
330
|
+
|
|
331
|
+
**STOP. You MUST web-search before generating.** Documents with made-up data are useless. No exceptions.
|
|
332
|
+
|
|
333
|
+
1. **WebSearch the topic** -- 3-5 searches minimum, gather real data
|
|
334
|
+
2. **Collect specific data points** -- Numbers, percentages, names, timelines, quotes
|
|
335
|
+
3. **Search for images** -- Use `ImageSearch` if the template calls for images (Creative, Educational/Kids). Download and include them.
|
|
336
|
+
4. **Organize findings** -- Group into sections following the template's structure
|
|
337
|
+
5. **THEN and ONLY THEN generate** -- Use `/doc-gen` with research-backed content
|
|
338
|
+
|
|
339
|
+
**Bad:** "The company has experienced significant growth in recent years."
|
|
340
|
+
**Good:** "UiPath's ARR reached $1.308 billion in FY2024, representing 22% YoY growth."
|
|
341
|
+
|
|
342
|
+
---
|
|
343
|
+
|
|
344
|
+
## Page Budget (MANDATORY for CREATE)
|
|
345
|
+
|
|
346
|
+
**STOP. Before generating, calculate a page budget.** Documents that ignore page targets bloat 30-50% beyond what the user asked for. If the user specifies a page count, you MUST plan to hit it. If no page count is given, default to these targets:
|
|
347
|
+
|
|
348
|
+
| Template | Default pages |
|
|
349
|
+
|----------|--------------|
|
|
350
|
+
| Professional | 8-15 |
|
|
351
|
+
| Academic | 10-20 |
|
|
352
|
+
| Creative | 5-10 |
|
|
353
|
+
| Educational/Kids | 5-8 |
|
|
354
|
+
| Operational | 3-8 |
|
|
355
|
+
|
|
356
|
+
### How to estimate pages
|
|
357
|
+
|
|
358
|
+
Each H1 heading starts on a new page. The section's content fills that page and can spill onto additional pages. Cover and TOC each consume a full page.
|
|
359
|
+
|
|
360
|
+
**Formula:**
|
|
361
|
+
|
|
362
|
+
```
|
|
363
|
+
fixed_pages = 2 (cover + TOC)
|
|
364
|
+
pages_per_section = (target_pages - fixed_pages) / number_of_H1_sections
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
`pages_per_section` is the TOTAL space each section should fill — including its starting page. If `pages_per_section = 1.86`, the section should fill its first page and spill ~86% into a second page.
|
|
368
|
+
|
|
369
|
+
**Block-to-page estimates (consulting/modern themes, LETTER size):**
|
|
370
|
+
|
|
371
|
+
| Block | Approximate page cost |
|
|
372
|
+
|-------|-----------------------|
|
|
373
|
+
| 1 paragraph (3-5 sentences) | 0.10 - 0.15 |
|
|
374
|
+
| 1 paragraph (6-8 sentences) | 0.15 - 0.25 |
|
|
375
|
+
| 1 table (≤6 rows) | 0.25 - 0.35 |
|
|
376
|
+
| 1 table (7-12 rows) | 0.40 - 0.55 |
|
|
377
|
+
| 1 chart | 0.45 - 0.55 |
|
|
378
|
+
| 1 callout | 0.15 - 0.25 |
|
|
379
|
+
| 1 bulleted/numbered list (5-8 items) | 0.20 - 0.30 |
|
|
380
|
+
| 1 H2 subheading | 0.05 overhead |
|
|
381
|
+
| 1 image (default 6"×4") | 0.50 - 0.60 |
|
|
382
|
+
| 1 diagram | 0.45 - 0.60 |
|
|
383
|
+
|
|
384
|
+
> For academic theme, multiply all estimates by 1.6× (double spacing).
|
|
385
|
+
|
|
386
|
+
### Budget rules
|
|
387
|
+
|
|
388
|
+
1. **Compute `pages_per_section`** using the formula above. Write it down before generating.
|
|
389
|
+
2. **Plan each section's blocks** so the sum of block costs ≈ `pages_per_section`.
|
|
390
|
+
3. **Do NOT add H2 subsections unless the user explicitly asks for them.** If the user says "Regional Analysis", write ONE section with a comparison table — not 5 sub-sections per region.
|
|
391
|
+
4. **Do NOT add tables beyond what was requested.** Each unplanned table costs 0.25-0.55 pages.
|
|
392
|
+
5. **Scale prose to fill the budget.** If `pages_per_section` ≈ 1.8, plan 5-7 paragraphs + 1-2 visual elements (table, chart, callout). If ≈ 1.0, plan 2-3 paragraphs + 1 visual.
|
|
393
|
+
6. **If `pages_per_section` < 1.0:** keep sections to 2-3 short paragraphs + at most 1 small table. Content should fit on the starting page.
|
|
394
|
+
7. **If `pages_per_section` ≥ 1.5:** sections MUST spill onto a second page. Use 4-6 paragraphs + 1-2 visual elements, or add 1 H2 subsection with its own content.
|
|
395
|
+
8. **If `pages_per_section` ≥ 2.5:** use 2-3 H2 subsections per section with substantial content in each.
|
|
396
|
+
|
|
397
|
+
### Example: 15-page report with 7 H1 sections
|
|
398
|
+
|
|
399
|
+
```
|
|
400
|
+
pages_per_section = (15 - 2) / 7 ≈ 1.86 → each section fills ~1.86 pages (spills onto second page)
|
|
401
|
+
Plan: 5-6 paragraphs + 1-2 visuals (table/chart/callout) per section
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
---
|
|
405
|
+
|
|
406
|
+
## Quality Rules (ALL Templates)
|
|
407
|
+
|
|
408
|
+
Minimum bar for every document — see [reference/quality-assurance.md](reference/quality-assurance.md) for the full per-section and final-document checklists.
|
|
409
|
+
|
|
410
|
+
- **`bookmarkId`** on EVERY level-1 heading
|
|
411
|
+
- **Left-aligned body text** -- NEVER justified
|
|
412
|
+
- **Two fonts maximum** (themes enforce this)
|
|
413
|
+
- **EVERY table needs a `caption`**
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
## File Resolution — ALWAYS Required Before Open/Attach
|
|
418
|
+
|
|
419
|
+
**`/word/open-attach` requires a full absolute file path.** A bare filename will fail.
|
|
420
|
+
|
|
421
|
+
**`/word/open-attach` must be its own standalone call — NEVER batch it with other operations.** Batch operations run independently; the document attachment from one operation does not carry into the next operation in the same batch.
|
|
422
|
+
|
|
423
|
+
**Always pass `filePath` to every subsequent Word API call.** All Word endpoints require `filePath` in the request body. Use the `filePath` returned in the `open-attach` response to ensure consistent targeting.
|
|
424
|
+
|
|
425
|
+
Whenever the user refers to a document **without giving you the full path** (any name, partial or full), call `file_discovery` first:
|
|
426
|
+
|
|
427
|
+
```json
|
|
428
|
+
{ "appType": "word", "partialName": "<name the user gave>" }
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
| Response | Action |
|
|
432
|
+
|----------|--------|
|
|
433
|
+
| `confidence: 'exact'` | Pass `resolved.filePath` to `/word/open-attach` |
|
|
434
|
+
| `confidence: 'ambiguous'` | Show the `matches` list and ask the user which file |
|
|
435
|
+
| NOT FOUND (plain text) | Ask the user for the full file path — STRICTLY FORBIDDEN to search the filesystem (no `find`, `ls`, `mdfind`, `execute_bash_command`, or any other command) |
|
|
436
|
+
|
|
437
|
+
### Opening Files from SharePoint / OneDrive / Browser URLs
|
|
438
|
+
|
|
439
|
+
When the user gives a `*.sharepoint.com` or `*-my.sharepoint.com` URL — every shape SharePoint emits, including:
|
|
440
|
+
- `:w:/g/personal/<user>_<domain>_<tld>/<opaque-id>?e=...` (older sharing token)
|
|
441
|
+
- `:w:/p/<user>/<opaque-id>?e=...` (newer personalized sharing token)
|
|
442
|
+
- `:w:/r/personal/<user>/_layouts/15/Doc.aspx?sourcedoc={GUID}&file=<name>.docx&action=edit` (browser "Open in Word" link)
|
|
443
|
+
- `:w:/r/personal/<user>/Documents/<file>.docx?d=w...` (direct browser link)
|
|
444
|
+
|
|
445
|
+
**NEVER try to download via HTTP** — SharePoint URLs require authentication and return HTML instead of the file. **NEVER click browser UI** to find the file — it lands on similarly-named wrong files.
|
|
446
|
+
|
|
447
|
+
1. **Try the original URL with `ms-word:` first — no conversion.** Desktop Word is signed into the user's Microsoft account and can resolve sharing-link tokens directly through Microsoft's sharing service. Most SharePoint URLs work without rewriting:
|
|
448
|
+
- **Windows:** `ExecutePowershellCommand: Start-Process "WINWORD.EXE" -ArgumentList "/o `"<original_url>`""`
|
|
449
|
+
- **macOS:** `osascript -e 'open location "ms-word:ofe|u|<original_url>"'` (the shell `open` command corrupts nested `https://` URLs — use AppleScript)
|
|
450
|
+
|
|
451
|
+
Wait a few seconds, then call `/word/get-opened-files` to confirm. If the right file opened, you are done. SharePoint URLs returned by `/word/get-opened-files` are valid `filePath` values for all `/word/*` calls — pass them as-is.
|
|
452
|
+
|
|
453
|
+
2. **If step 1 fails AND the URL has a `/Documents/<file>.docx` style path**, retry with the converted direct URL. Conversion rules:
|
|
454
|
+
- **Strip** `/:w:/r/`, `/:w:/g/`, `/:w:/p/`, `/:p:/r/`, `/:p:/g/`, `/:p:/p/`, `/:b:/r/`, `/:b:/g/`, `/:b:/p/` routing prefixes
|
|
455
|
+
- **Strip** query parameters (`?sourcedoc=...&action=edit`, `?d=w...`, `?e=...`)
|
|
456
|
+
- **Fix domain** for personal OneDrive: `company.sharepoint.com` → `company-my.sharepoint.com` (when path contains `/personal/`)
|
|
457
|
+
|
|
458
|
+
This conversion does NOT work for sharing-link-token URLs (`/personal/<user>/<opaque-id>` with no file path) — those have only step 1.
|
|
459
|
+
|
|
460
|
+
3. **If both fail, ASK the user.** Either ask for a different URL (a direct document URL with a `.docx` path), or ask whether the file is already open in Word so you can attach via `/word/get-opened-files`. **NEVER scan the browser windows for similarly-named files and pick one — you will land on the wrong file.**
|
|
461
|
+
|
|
462
|
+
---
|
|
463
|
+
|
|
464
|
+
## Reference Files (Load on Demand)
|
|
465
|
+
|
|
466
|
+
### API Docs — load per the EDIT path in Step 1
|
|
467
|
+
|
|
468
|
+
| File | Load when |
|
|
469
|
+
|------|-----------|
|
|
470
|
+
| [api/basic.md](api/basic.md) | **MANDATORY** before any edit — open, save, get text, find, replace, insert, delete, format, apply style, position rules |
|
|
471
|
+
| [api/advanced.md](api/advanced.md) | Tables, images, charts, headers/footers, page layout, lists, hyperlinks, text boxes, PDF export, undo, batch ops |
|
|
472
|
+
| [api/expert.md](api/expert.md) | C# scripting (Windows), position troubleshooting, shape management, emoji encoding |
|
|
473
|
+
|
|
474
|
+
### Generation Docs
|
|
475
|
+
|
|
476
|
+
| File | Load when |
|
|
477
|
+
|------|-----------|
|
|
478
|
+
| [generation.md](generation.md) | CREATE path — doc-gen workflow, content block types, themes, options |
|
|
479
|
+
|
|
480
|
+
### Reference Guides — load when the specific problem arises
|
|
481
|
+
|
|
482
|
+
| File | Load when |
|
|
483
|
+
|------|-----------|
|
|
484
|
+
| [reference/uia-fallback.md](reference/uia-fallback.md) | **MANDATORY** before switching to UIA — keyboard shortcuts (both platforms), paste_content, AppAct patterns, HTML layout templates |
|
|
485
|
+
| [reference/tables.md](reference/tables.md) | Table overflow, column limits, spacing, theme table styles |
|
|
486
|
+
| [reference/visual-elements.md](reference/visual-elements.md) | Chart design best practices, SmartArt categories, cover page styles |
|
|
487
|
+
| [reference/formatting.md](reference/formatting.md) | Typography standards, image sizing, page breaks, TOC management, page numbering |
|
|
488
|
+
| [reference/quality-assurance.md](reference/quality-assurance.md) | QA checklist before handover — per-section and final-document checks |
|
|
489
|
+
| [reference/tracked-changes.md](reference/tracked-changes.md) | Track changes & comments (Windows only) |
|
|
490
|
+
|
|
491
|
+
---
|
|
492
|
+
|
|
493
|
+
## Handover
|
|
494
|
+
|
|
495
|
+
1. **Health check** — **macOS:** `/word/get-status` (automated, returns JSON with issues). **Windows:** manual checks via `/word/get/document-structure` + `/word/get/textformatting`. See [reference/quality-assurance.md](reference/quality-assurance.md). **Do NOT skip or fake this — use the actual endpoints.**
|
|
496
|
+
2. **Save** (Ctrl+S / Cmd+S or `/word/save`)
|
|
497
|
+
3. **Default save location**: user's Documents folder
|
|
498
|
+
4. **File naming**: `[Topic]_Report_[Date].docx`
|
|
499
|
+
5. **Export PDF** if needed: `/word/export-to-pdf`
|
|
500
|
+
6. **Keep open** for user review
|
|
501
|
+
|
|
502
|
+
> For documents created with `/doc-gen`, skip heading-style and table-autofit steps — the generator handles these.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
## Windows-Specific Notes
|
|
2
|
+
|
|
3
|
+
### Execution Order
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
/word/* API → retry with corrected params → C# scripting (/word/execute-script) → PowerShell helper scripts → UIA (LAST RESORT)
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
1. **`/word/*` API** — always try first (goes to C# interop on port 5055)
|
|
10
|
+
2. **Retry** — check error message, fix params, try again
|
|
11
|
+
3. **C# scripting** — `/word/execute-script` for operations the API doesn't cover (see `api/expert.md`)
|
|
12
|
+
4. **PowerShell scripts** — `ExecutePowershellCommand` with scripts from `windows/scripts/` (see table below)
|
|
13
|
+
5. **UIA (AppAct)** — LAST RESORT only
|
|
14
|
+
|
|
15
|
+
Steps 1–4 all work on a document with no window, which is the default. **Step 5 does not:** UIA drives the on-screen window, so re-open with `visible: true` before falling back to it, and tell the user why Word is appearing.
|
|
16
|
+
|
|
17
|
+
**Sequential execution only** — Word COM API does NOT support concurrent calls.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
### C# Scripting — When to Use
|
|
22
|
+
|
|
23
|
+
| Operation | Approach |
|
|
24
|
+
|-----------|----------|
|
|
25
|
+
| Add/insert table rows or columns | `/word/execute-script` |
|
|
26
|
+
| Merge table cells | `/word/execute-script` |
|
|
27
|
+
| Complex conditional formatting | `/word/execute-script` |
|
|
28
|
+
| Loops over paragraphs | `/word/execute-script` |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
### PowerShell Helper Scripts — When to Use
|
|
33
|
+
|
|
34
|
+
Run via `ExecutePowershellCommand`. These operate on **live Word instances** via COM — no need to save/close first. Use when the API and C# scripting don't cover the operation, **BEFORE falling back to UIA**.
|
|
35
|
+
|
|
36
|
+
| Script | Purpose | When to use |
|
|
37
|
+
|--------|---------|-------------|
|
|
38
|
+
| `autofit-tables.ps1` | Auto-fit all tables to page width | **Handover** — after all tables inserted |
|
|
39
|
+
| `normalize-formatting.ps1` | Apply consistent font and spacing | **Handover** — cleanup pass |
|
|
40
|
+
| `apply-heading-style.ps1` | Apply heading style (H1-H4) | Batch heading application |
|
|
41
|
+
| `export-document.ps1` | Export to PDF, RTF, HTML, TXT | When `/word/export-to-pdf` API fails |
|
|
42
|
+
| `create-chart-with-data.ps1` | Create chart with data in one step | When `/word/insert/chart` API fails |
|
|
43
|
+
| `create-chart.ps1` | Insert chart (column, bar, line, pie) | When `create-chart-with-data.ps1` fails |
|
|
44
|
+
| `insert-smartart.ps1` | Insert SmartArt diagrams | **No API support** — script is preferred over UIA |
|
|
45
|
+
| `insert-cover-page.ps1` | Insert Word built-in cover page | **No API support** — script is preferred over UIA |
|
|
46
|
+
| `insert-text-box.ps1` | Insert text box | When `/word/insert/textbox` API fails |
|
|
47
|
+
| `insert-horizontal-line.ps1` | Insert horizontal divider | When API fails |
|
|
48
|
+
| `insert-image.ps1` | Insert image | When `/word/insert/picture` API fails |
|
|
49
|
+
| `get-current-file.ps1` | Get path of active document | When `file_discovery` fails |
|
|
50
|
+
|
|
51
|
+
**Key handover scripts:**
|
|
52
|
+
```powershell
|
|
53
|
+
.\windows\scripts\autofit-tables.ps1 -Mode window
|
|
54
|
+
.\windows\scripts\normalize-formatting.ps1 -Scope all -Font "Calibri"
|
|
55
|
+
```
|