# Cycberform.Doc

**Repository Path**: fanhuibin1/CycberformDoc

## Basic Information

- **Project Name**: Cycberform.Doc
- **Description**: 对标 POI、Spire.Doc等工具类的开源Word文档处理 SDK。是Java领域目前最好用的Office文档处理工具类。目前专注于支持docx文档，doc文档支持有限。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: release/0.1
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2026-10-09
- **Last Updated**: 2026-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Cycberform.Doc

**An open-source Java SDK for Word document workflows.**

[简体中文](README.md) · [English](README.en.md) · [Documentation](docs/README.md) · [Features and code](docs/feature-guide.md)

**Our goal:** Provide an **open-source alternative to Apache POI, Aspose and Spire** for Java business document workflows, reducing custom document code, commercial licensing costs and dependence on commercial license restrictions. **Apache License 2.0 allows free commercial use**, with no commercial license purchase required for this component; users and distributors must comply with the license and preserve required notices. Excel and other formats are future goals.

**Available today:** **DOCX is the primary supported format**, covering document generation, template filling, text, images, tables, HTML import, document composition and review workflows, without installing Office. Already widely used commercially in our own contract system. Legacy **DOC has limited support for plain paragraph text and selected direct formatting**; see [format support](docs/compatibility.md#文件格式).

<!-- feature-overview:start -->

## Feature progress

| Catalog features | Complete / current scope | Partial | Runnable examples |
| ---: | ---: | ---: | ---: |
| 180 | 165 / 171 (96.5%) | 6 | 189 |

Feature development for this release is closed. Current work focuses on complex-content tests and reliability. 9 entries are outside this release; completion reflects declared feature scope. [Feature details](docs/feature-details.md) · [Unsupported capabilities](docs/unsupported-capabilities.md) · [Testing and acceptance](docs/validation.md)


<!-- feature-overview:end -->

## Quick start

Requires JDK 17+. Add this dependency to your application's `pom.xml`:

```xml
<dependency>
  <groupId>com.zhaoxinms.cycberform</groupId>
  <artifactId>cyberform-doc-sdk</artifactId>
  <version>0.1.0</version>
</dependency>
```

**Cycberform.Doc 0.1.0 is released.** [Release notes](docs/releases/0.1.0.md) · [Source tag v0.1.0](https://gitee.com/fanhuibin1/CycberformDoc/tree/v0.1.0). Use the Maven coordinates above. If the version is not yet available from Central, build the tagged source with Maven 3.9+ and install it locally:

```sh
mvn -B -ntp install
```

Use version 0.1.0 for this release. [Maven integration](docs/maven.md) · [Create your first document](docs/getting-started.md) · [Runnable examples](docs/examples.md).

## Showcase

Click an image to open its usage guide. Every preview is 640 × 400, scaled proportionally with padding from actual document output.

<!-- capability-showcase:start -->

<a id="basic-capabilities"></a>

### Basic capabilities · 3 examples

Contracts, typography, imported tables, images and barcodes for everyday document generation.

| **Contract templates and merged tables** | **XHTML tables imported into Word** | **Fine typography** |
| --- | --- | --- |
| [![Merged delivery tables, payment schedules, headers, footers and watermarks.](docs/assets/previews/contract.png)](docs/showcase.md) | [![Editable native tables retain supported headers, merged cells and formatting.](docs/assets/previews/xhtml-table.png)](docs/xhtml-tables.md) | [![Adjust character width, spacing and vertical position for precise typography.](docs/assets/previews/type-showcase.png)](docs/fine-typography.md) |
| Merged delivery tables, payment schedules, headers, footers and watermarks. | Editable native tables retain supported headers, merged cells and formatting. | Adjust character width, spacing and vertical position for precise typography. |
| [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/ContractShowcase.java) · [DOCX](docs/assets/contract-showcase/contract-showcase.docx) · [Scope and evidence](docs/showcase.md) | [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/XhtmlTablesExample.java) · [DOCX](docs/assets/xhtml-tables/imported.docx) · [Scope and evidence](docs/xhtml-tables.md) | [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/TypographyGallery.java) · [DOCX](docs/assets/typography-gallery/type-showcase.docx) · [Scope and evidence](docs/fine-typography.md) |

<a id="advanced-capabilities"></a>

### Advanced capabilities · 3 examples

Editable charts, reusable clauses, document review and approval images for business workflows.

| **Combine reusable contract content** | **Professional table styling** | **HTML into a contract content control** |
| --- | --- | --- |
| [![Reuse clauses, payment terms and delivery tables with supported numbering and references retained.](docs/assets/previews/composition.png)](docs/capability-showcase.md) | [![Style headers, first columns, totals and alternating rows for clear business tables.](docs/assets/previews/conditional-table-style.png)](docs/conditional-table-style.md) | [![Populate a tagged control with editable images, tables, lists and links.](docs/assets/previews/html-control-filled.png)](docs/html-content-controls.md) |
| Reuse clauses, payment terms and delivery tables with supported numbering and references retained. | Style headers, first columns, totals and alternating rows for clear business tables. | Populate a tagged control with editable images, tables, lists and links. |
| [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/CapabilityShowcase.java) · [DOCX](docs/assets/capability-showcase/composition.docx) · [Scope and evidence](docs/capability-showcase.md) | [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/ConditionalTableStyleExample.java) · [DOCX](docs/assets/conditional-table-style/source.docx) · [Scope and evidence](docs/conditional-table-style.md) | [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/HtmlContentControlExample.java) · [DOCX](docs/assets/html-content-controls/filled.docx) · [Scope and evidence](docs/html-content-controls.md) |

<a id="specialized-workflows"></a>

### Specialized workflows · 3 examples

Irregular tables, multilingual documents, repeated headers and Chinese clause numbering for complex documents.

| **Right-to-left tables** | **Repeated headers for long tables** | **Chinese clauses and multilevel numbering** |
| --- | --- | --- |
| [![Arrange table cells from right to left with supported header, edge and alternating-row styles.](docs/assets/previews/rtl-table-style.png)](docs/rtl-table-style.md) | [![Keep long tables readable with styled multi-row headers that repeat on subsequent pages.](docs/assets/previews/repeated-header-style.png)](docs/repeated-header-style.md) | [![Use traditional Chinese counting and uppercase numbering in multilevel clauses and table lists.](docs/assets/previews/traditional-chinese-lists.png)](docs/traditional-chinese-lists.md) |
| Arrange table cells from right to left with supported header, edge and alternating-row styles. | Keep long tables readable with styled multi-row headers that repeat on subsequent pages. | Use traditional Chinese counting and uppercase numbering in multilevel clauses and table lists. |
| [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/RtlTableStyleExample.java) · [DOCX](docs/assets/rtl-table-style/source.docx) · [Scope and evidence](docs/rtl-table-style.md) | [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/RepeatedHeaderStyleExample.java) · [DOCX](docs/assets/repeated-header-style/source.docx) · [Scope and evidence](docs/repeated-header-style.md) | [Source](cyberform-doc-examples/src/main/java/com/zhaoxinms/cycberform/doc/examples/TraditionalChineseListExample.java) · [DOCX](docs/assets/traditional-chinese-lists/combined.docx) · [Scope and evidence](docs/traditional-chinese-lists.md) |


<!-- capability-showcase:end -->

[All features and screenshot gaps](docs/feature-screenshots.md) · [Original images and evidence](docs/capability-evidence.md).

Microsoft Word renders the documented output externally; these screenshots do not imply a built-in rendering engine.

## Features and code

<!-- feature-navigation:start -->

[Features and code](docs/feature-guide.md) · [Implementation scope](docs/feature-details.md)

<!-- feature-navigation:end -->

Find usage guides, runnable Java source and actual output for each feature. Supported behavior and remaining limits are listed explicitly.

**DOCX is the primary format. DOC** supports only restricted simple-document creation and edits to existing plain paragraphs and selected direct formatting; it does not offer the same capabilities as DOCX. WPS support is limited to specific Word binary variants. PDF conversion, independent pagination and printing are not currently delivered engines. See [compatibility](docs/compatibility.md) and each feature's declared scope.

## Development and support

[Architecture](docs/architecture.md) · [Validation](docs/validation.md) · [Roadmap](docs/roadmap.md) · [Changelog](CHANGELOG.md).

```sh
mvn -B -ntp verify
python scripts/docs.py --check
python scripts/check-attribution.py
```

The [SDT module](cyberform-doc-sdt/README.md) builds separately. Please include a minimal reproduction, sanitized document and Java version when reporting issues.

[Contributing](CONTRIBUTING.md) · [Issues](https://gitee.com/fanhuibin1/CycberformDoc/issues) · [License](LICENSE)

Developed by **山西肇新科技有限公司**, author **范厨子** · [Company website](http://zhaoxinms.com) · [Apache 2.0](LICENSE).