mcpField
S
syncfusion-java-word

syncfusion-java-word

github.com/syncfusionDocuments2112 installsUpdated 1w ago
Repository

About syncfusion-java-word

A skill that generates Java code using Syncfusion Word Library references for DOCX and related document processing. It is intended for developers who need examples grounded in documented APIs, rather than generated files.

Key features

  1. 01Generate Java code snippets
  2. 02Create and edit Word documents
  3. 03Convert between document formats
  4. 04Merge, split, and compare documents
  5. 05Handle security and track changes

Use cases

  1. 01Generate Java code for a formatted DOCX
  2. 02Convert HTML or RTF to DOCX
  3. 03Add mail merge, comments, or document protection

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/syncfusion/document-sdk-skills --skill syncfusion-java-word

After installing, type/syncfusion-java-wordin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
references/
bookmarks.md
comments.md
compare-word-documents.md
content-controls.md
document-structure.md
encryption.md
fields.md
find-and-replace.md
footnotes-and-endnotes.md
form-fields.md
header-footer.md
html-conversions.md
hyperlinks.md
macros.md
mail-merge.md
markdown-conversion.md
mathematical-equation.md
merge-word-documents.md
paragraph-and-styles.md
rtf-conversions.md
shapes.md
split-word-documents.md
styles-and-formats.md
tables.md
text-conversions.md
track-changes.md
watermark.md
xml-conversions.md

Details

From the project README

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

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/*.md file(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:

FileContents
document-structure.mdCreate/load document, add sections, page setup, save to file or stream, supported formats
styles-and-formats.mdParagraphs, headings, bullet & numbered lists
paragraph-and-styles.mdAdd paragraphs, paragraph formatting, styles (built-in/custom), text formatting, tab stops, breaks, symbols, text boxes
tables.mdCreate tables, cell formatting, merge cells
bookmarks.mdCreate bookmarks, navigate, retrieve, insert, replace, delete content
shapes.mdAdd shapes, format, rotate, group, ungroup shapes
mail-merge.mdSimple 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.mdAdd checkboxes, dropdowns, text input fields, modify properties
macros.mdLoad/save macro-enabled documents (DOTM, DOCM), check for macros, remove macros, preserve macros through conversion
mathematical-equation.mdCreate equations (fraction, radical, matrix, N-array, etc.), modify existing equations, LaTeX support, equation formatting
split-word-documents.mdSplit documents by sections, headings, bookmarks, placeholder text
merge-word-documents.mdMerge documents in new page, same page, maintain imported list styles
compare-word-documents.mdCompare two Word documents, set author and date, comparison options, ignore format changes
html-conversions.mdConvert HTML to DOCX, convert DOCX to HTML, XHTML validation, customize images (import/export), CSS selectors, export options, headers/footers export
rtf-conversions.mdConvert RTF to DOCX, convert DOCX to RTF, preserve formatting and content
markdown-conversion.mdConvert Markdown to DOCX, convert DOCX to Markdown, customize images, CommonMark and GitHub-flavored syntax support
text-conversions.mdConvert Text to DOCX, convert DOCX to Text, extract plain text, preserve text content
xml-conversions.mdConvert Word to XML (WordML), convert XML to Word, Word Processing XML format (2007+)
encryption.mdEncrypt with password, open encrypted doc, remove encryption, protect from editing, editable ranges
watermark.mdText and picture watermarks, watermark layout, scaling, washout effect, remove watermark
find-and-replace.mdFind/FindAll/FindNext, Replace (string/regex), ReplaceSingleLine, and FindItem* APIs
footnotes-and-endnotes.mdAdd footnotes and endnotes, set positions (bottom of page/end of section), numbering formats, separators, modify content, remove notes
track-changes.mdEnable/disable track changes, accept/reject changes, filter by reviewer, revision information
comments.mdAdd/modify/remove comments, insert on specific text, access parent comments, retrieve commented items
content-controls.mdBlock and inline content controls, types (rich text, plain text, checkbox, date, dropdown, picture), properties, protection, form filling, XML mapping
header-footer.mdAdd/remove headers and footers, page numbers with fields (date, time), odd/even pages, first page different, borders, images, link to previous
hyperlinks.mdWeb hyperlink, email hyperlink, file hyperlink, bookmark hyperlink, image hyperlink, modify hyperlink

Rules

  • Never use Python libraries (e.g., python-docx)

Comments

Markdown supported