QUICKSTART.md

Word 文档排版 AI Agent - 快速开始

一分钟快速体验

1. 安装依赖（首次使用）：

   pip install -r requirements.txt

2. 运行演示：

   python word_ai_agent.py

   这将自动生成演示文件并创建一个示例 Word 文档。

基本使用方法

方法一：直接在代码中使用

from word_ai_agent import WordAIAgent

# 定义排版规则
rules = """标题一：字体 宋体，字号 小一，对齐方式 居中，段前间距 1行，段后间距 0.5行
标题二：字体 黑体，字号 三号，加粗 是，段前间距 12磅
正文：字体 宋体，字号 小四，首行缩进 2字符，行距 1.25倍，段前间距 0磅，段后间距 0磅
页边距：上 2.5cm，下 2.5cm，左 3cm，右 3cm"""

# 准备 Markdown 内容
content = """# 我的文档标题

这是第一段正文，会自动应用首行缩进和指定的字体格式。

## 第一章

这是第二段内容，展示二级标题的样式。

这是另一段正文内容。"""

# 生成 Word 文档
agent = WordAIAgent()
agent.process(rules, content, "my_document.docx")
print("文档生成完成！")

方法二：通过命令行使用

1. 创建排版规则文件 rules.txt：

   标题一：字体 宋体，字号 小一，对齐方式 居中
   标题二：字体 黑体，字号 三号，加粗 是
   正文：字体 宋体，字号 小四，首行缩进 2字符，行距 1.25倍
   页边距：上 2.5cm，下 2.5cm，左 3cm，右 3cm
   

2. 创建 Markdown 内容文件 content.md：

   # 我的文档
   
   这是正文内容。
   
   ## 第一节
   
   这是第一节的内容。

3. 运行命令：

   python word_ai_agent.py --rules rules.txt --input content.md --output document.docx

支持的排版属性

属性	示例	说明
字体	字体 宋体	支持系统中安装的任何字体
字号	字号 小四 或 字号 12磅	支持中文字号和数字字号
对齐方式	对齐方式 居中	左对齐、居中、右对齐、两端对齐
加粗	加粗 是	是/否
倾斜	倾斜 是	是/否
首行缩进	首行缩进 2字符	支持字符、磅、厘米
行距	行距 1.25倍	倍数或磅值
段前间距	段前间距 12磅	磅、行、厘米
段后间距	段后间距 6磅	磅、行、厘米

常用中文字号

• 初号 (42磅)、小初 (36磅)
• 一号 (26磅)、小一 (24磅)
• 二号 (22磅)、小二 (18磅)
• 三号 (16磅)、小三 (15磅)
• 四号 (14磅)、小四 (12磅)
• 五号 (10.5磅)、小五 (9磅)

示例文件

查看 examples/ 文件夹中的示例文件：

• format_rules.txt - 完整的排版规则示例
• sample_content.md - Markdown 内容示例
• output_document.docx - 生成的文档示例

故障排除

1. 导入错误：确保已安装所有依赖包

   pip install -r requirements.txt

2. 字体问题：确保系统中已安装指定的字体（如宋体、黑体）

3. 文件编码：确保输入文件使用 UTF-8 编码

4. 路径问题：使用绝对路径或确保文件在当前工作目录中