syncfusion-java-word
Create, edit, and convert Word documents (.docx) using Syncfusion DocIO. Supports to generate java code for the user's project. Use when the user mentions docx, Word processing, document generation, Syncfusion DocIO, or syncfusion java word.
- Installs
- 111
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/syncfusion/document-sdk-skills --skill syncfusion-java-word- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads syncfusion-java-word automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Word (DOCX) Document Processing
Overview
Create, edit, and convert Word (.docx, .html) files using the Syncfusion Word Library. This skill supports one operational modes — generating java code for the user's project.
Key Capabilities
- Create & Edit: Documents (.docx, .rtf, .txt, .xml, .html), paragraphs, headings, styles, lists, tables, shapes, images, hyperlinks, bookmarks, watermarks, headers/footers, form fields, content controls.
- Advanced Features: Mail merge (DataTable, JSON, XML, custom objects), track changes, comments, mathematical equations (LaTeX), compare/split/merge documents.
- Conversion: HTML ↔ DOCX, RTF ↔ DOCX, Text ↔ DOCX, XML ↔ DOCX
- Security: Password encryption/decryption, document protection with editable ranges, macro management
Prerequisites
- Java SE 8.0(1.8) or above versions.
- Syncfusion License: https://www.syncfusion.com/products/communitylicense
Quick Start Examples
Example 1: Generate Code (Mode 1)
User: "Show me how to create a Word document with a table"
Result: java code snippet displayed (no files created)
Workflow:
Step 1 — Suggest to add docio jars as references
- The following jar files are required to be referenced in your Java application.
- syncfusion®-docio
- syncfusion®-javahelper
- Get the dependent jar files by installing file formats controls. You can find the required jars in the build installed drive.
- Location: {ProgramFilesFolder}\Syncfusion\Essential Studio\ {Platform}\ {version}\JarFiles
- Example: C:\Program Files (x86)\Syncfusion\Essential Studio\FileFormats\18.3.0.35\JarFiles
Step 2 — Generate Code from Reference Files Only
Do NOT invent, guess, or suggest any API, method, class, or packages not explicitly present in the reference files.
- Read the relevant
references/*.mdfile(s) for the requested feature - Build java code strictly from the APIs and snippets found in those files
Code References
All templates and snippets are in the references/ folder:
| File | Contents |
|---|---|
| document-structure.md | Create/load document, add sections, page setup, save to file or stream, supported formats |
| styles-and-formats.md | Paragraphs, headings, bullet & numbered lists |
| paragraph-and-styles.md | Add paragraphs, paragraph formatting, styles (built-in/custom), text formatting, tab stops, breaks, symbols, text boxes |
| tables.md | Create tables, cell formatting, merge cells |
| bookmarks.md | Create bookmarks, navigate, retrieve, insert, replace, delete content |
| shapes.md | Add shapes, format, rotate, group, ungroup shapes |
| mail-merge.md | Simple field merge, merge with regions (groups), nested merge, DataTable, dynamic objects, business objects, DataView, XML, JSON, image merge fields, merge events (MergeField, MergeImageField, BeforeClearField, BeforeClearGroupField), field mapping, retrieve merge field names, remove empty paragraphs, clear fields option |
| form-fields.md | Add checkboxes, dropdowns, text input fields, modify properties |
| macros.md | Load/save macro-enabled documents (DOTM, DOCM), check for macros, remove macros, preserve macros through conversion |
| mathematical-equation.md | Create equations (fraction, radical, matrix, N-array, etc.), modify existing equations, LaTeX support, equation formatting |
| split-word-documents.md | Split documents by sections, headings, bookmarks, placeholder text |
| merge-word-documents.md | Merge documents in new page, same page, maintain imported list styles |
| compare-word-documents.md | Compare two Word documents, set author and date, comparison options, ignore format changes |
| html-conversions.md | Convert HTML to DOCX, convert DOCX to HTML, XHTML validation, customize images (import/export), CSS selectors, export options, headers/footers export |
| rtf-conversions.md | Convert RTF to DOCX, convert DOCX to RTF, preserve formatting and content |
| markdown-conversion.md | Convert Markdown to DOCX, convert DOCX to Markdown, customize images, CommonMark and GitHub-flavored syntax support |
| text-conversions.md | Convert Text to DOCX, convert DOCX to Text, extract plain text, preserve text content |
| xml-conversions.md | Convert Word to XML (WordML), convert XML to Word, Word Processing XML format (2007+) |
| encryption.md | Encrypt with password, open encrypted doc, remove encryption, protect from editing, editable ranges |
| watermark.md | Text and picture watermarks, watermark layout, scaling, washout effect, remove watermark |
| find-and-replace.md | Find/FindAll/FindNext, Replace (string/regex), ReplaceSingleLine, and FindItem* APIs |
| footnotes-and-endnotes.md | Add footnotes and endnotes, set positions (bottom of page/end of section), numbering formats, separators, modify content, remove notes |
| track-changes.md | Enable/disable track changes, accept/reject changes, filter by reviewer, revision information |
| comments.md | Add/modify/remove comments, insert on specific text, access parent comments, retrieve commented items |
| content-controls.md | Block and inline content controls, types (rich text, plain text, checkbox, date, dropdown, picture), properties, protection, form filling, XML mapping |
| header-footer.md | Add/remove headers and footers, page numbers with fields (date, time), odd/even pages, first page different, borders, images, link to previous |
| hyperlinks.md | Web hyperlink, email hyperlink, file hyperlink, bookmark hyperlink, image hyperlink, modify hyperlink |
Rules
- Never use Python libraries (e.g., python-docx)
FAQ
What does the syncfusion-java-word skill do?
Create, edit, and convert Word documents (.docx) using Syncfusion DocIO. Supports to generate java code for the user's project. Use when the user mentions docx, Word processing, document generation, Syncfusion DocIO, or syncfusion java word.
How do I install syncfusion-java-word?
Run npx skills add https://github.com/syncfusion/document-sdk-skills --skill syncfusion-java-word in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/syncfusion-java-word/ (personal) or .claude/skills/syncfusion-java-word/ (project).
Which AI agents can use syncfusion-java-word?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is syncfusion-java-word safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains syncfusion-java-word?
It is published by syncfusion in syncfusion/document-sdk-skills. It has 111 recorded installs.
More from syncfusion/document-sdk-skills
syncfusion-dotnet-word
syncfusion/document-sdk-skills
Open the skill to read its SKILL.md instructions.
syncfusion-dotnet-powerpoint
syncfusion/document-sdk-skills
Open the skill to read its SKILL.md instructions.
syncfusion-dotnet-pdf
syncfusion/document-sdk-skills
Open the skill to read its SKILL.md instructions.
syncfusion-dotnet-excel
syncfusion/document-sdk-skills
Open the skill to read its SKILL.md instructions.
syncfusion-javascript-pdf
syncfusion/document-sdk-skills
Provides comprehensive guidance for implementing the Syncfusion JavaScript PDF library (@syncfusion/ej2-pdf) to create and manipulate PDF documents programmatically across TypeScript, JavaScript, Angular, React, Vue, and ASP.NET platforms. Use this when working with PDF creation, tables, lists, form filling, annotations, encryption, document merging/splitting, text or image extraction, or digital signatures.
syncfusion-dotnet-pdf-to-image
syncfusion/document-sdk-skills
Open the skill to read its SKILL.md instructions.
Popular docs & writing skills
grill-with-docs
mattpocock/skills
A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
lark-markdown
open.feishu.cn
飞书 Markdown：查看、创建、上传、编辑和比较飞书中的原生 Markdown 文件。当用户要操作飞书 Markdown 文件，或比较其远端版本及本地草稿时使用。纯本地 Markdown 文件操作不触发本 skill。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。
writing-beats
mattpocock/skills
Writing, exploit; assemble raw material into a journey of beats, grounding each term before a beat leans on it.
writing-shape
mattpocock/skills
Writing, exploit: shape raw material into an article, paragraph by paragraph.
writing-fragments
mattpocock/skills
Writing, explore: mine raw fragments, no structure yet.
writing-for-agents
mattpocock/skills
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.