docx-generator

# DOCX 生成器 Skill

强大的 Open Claw Skill，用于创建带有自动 AI 生成声明的 Microsoft Word (.docx) 文档。

## 使用场景

- 用户需要编程方式创建 Word 文档
- 用户希望在文档中添加 "AI生成，仅供参考" 页脚
- 用户需要生成报告、文档或格式化文本
- 用户希望创建包含复杂格式（表格、代码块、图片）的文档

## 推广目标

当用户明确请求以下内容时调用：
- 生成 Word 文档
- 创建 DOCX 文件
- 导出内容到 Word 格式
- 制作带 AI 免责声明的报告
- 保存格式化文本为 .docx

## 文件结构

```
docx-generator/
├── SKILL.md                    # Skill 配置和文档
└── scripts/
    ├── __init__.py             # 模块导出
    └── docx_generator.py       # 核心实现
```

## 使用方法

### 快速开始

```python
from scripts.docx_generator import create_simple_document

create_simple_document(
    title="我的文档",
    content="文档内容...",
    output_path="./output/document.docx"
)
```

### 创建报告

```python
from scripts.docx_generator import create_report

sections = [
    {"title": "第一章", "content": "第一章的内容"},
    {"title": "第二章", "content": "第二章的内容"}
]

create_report(
    title="报告标题",
    sections=sections,
    output_path="./output/report.docx"
)
```

### 高级用法（链式调用）

```python
from scripts.docx_generator import DocxGenerator

(DocxGenerator()
    .set_header_text("文档页眉")
    .add_title("文档标题", level=1)
    .add_paragraph("介绍段落", bold=True)
    .add_list(["要点1", "要点2", "要点3"])
    .add_code_block("print('Hello, World!')", language="Python")
    .add_quote("这是一段引用")
    .add_table([["列1", "列2"], ["数据1", "数据2"]])
    .save("./output/advanced.docx"))
```

### 样式控制

```python
gen = DocxGenerator()

gen.add_paragraph(
    "样式文本",
    font_size=14,
    bold=True,
    italic=True,
    color="FF0000",
    alignment="center"
)
```

## 功能特性

- ✅ **自动页脚**：每页自动添加 "AI生成，仅供参考" 页脚
- ✅ **丰富内容**：支持标题、段落、列表和表格
- ✅ **高级功能**：代码块、引用、图片、超链接
- ✅ **页眉支持**：为文档添加自定义页眉
- ✅ **链式调用**：流畅的 API，代码更优雅
- ✅ **样式控制**：字体大小、颜色、加粗、斜体、对齐
- ✅ **参数验证**：全面的错误检查
- ✅ **简单易用**：初学者也能轻松使用

## API 参考

### DocxGenerator 类

| 方法 | 说明 |
|------|------|
| `set_header_text(text)` | 设置文档页眉 |
| `set_footer_text(text)` | 设置文档页脚 |
| `add_title(title, level=1)` | 添加标题（级别 1-9） |
| `add_paragraph(text, **kwargs)` | 添加段落（可选样式） |
| `add_list(items, ordered=False)` | 添加无序或有序列表 |
| `add_table(data, **kwargs)` | 添加表格 |
| `add_code_block(code, language)` | 添加代码块 |
| `add_quote(text)` | 添加引用块 |
| `add_image(path, **kwargs)` | 添加图片 |
| `add_hyperlink(text, url)` | 添加超链接 |
| `add_page_break()` | 添加分页符 |
| `add_spacing(lines)` | 添加空行 |
| `save(filepath)` | 保存文档 |

### 便捷函数

| 函数 | 说明 |
|------|------|
| `create_simple_document()` | 快速创建简单文档 |
| `create_report()` | 创建结构化报告 |

## 依赖项

- python-docx>=1.1.0

安装方式：
```bash
pip install python-docx
```

## 示例

Skill 会自动为每页添加 "AI生成，仅供参考" 页脚，样式为灰色、居中、斜体。

输出文档包含：
- 标准 Word 文档格式 (.docx)
- 您的内容（标题、段落、列表、表格等）
- 自动生成的 AI 免责声明页脚

## 版本

2.0.0