# word错别字批注

**Repository Path**: lxynb/word-typo-annotation

## Basic Information

- **Project Name**: word错别字批注
- **Description**: 使用python的docx库和spir.doc库完成对word的错别字批注功能，是批注功能而不是检测错别字功能
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-21
- **Last Updated**: 2025-09-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Word错别字批注工具

## 介绍
这是一个基于Python的Word文档错别字批注工具，使用`python-docx`和`spire.doc`库实现。该工具的主要功能是对Word文档中的错别字进行标注，而不是检测错别字本身。批注功能通过在文档中插入评论来标记错误位置，并提供错误原因。

## 功能特点
- **错别字批注**：在Word文档中对已知错别字进行批注，插入评论说明错误原因。
- **错误替换**：提供替换错别字的功能，生成修正后的文档。
- **去重合并**：对重复的错误位置进行去重合并，避免重复批注。

## 软件架构
- **依赖库**：
  - `python-docx`：用于处理Word文档。
  - `spire.doc`：用于更复杂的文档操作，如插入评论等。
- **主要模块**：
  - `mark_typos`：负责对错别字进行批注。
  - `replace_typos`：负责替换错别字并生成修正后的文档。

## 安装教程
1. 安装Python环境（建议使用Python 3.7及以上版本）。
2. 安装所需的Python库：
   ```bash
   pip install python-docx
   pip install spire.doc
   ```
3. 下载项目代码并解压到本地目录。

## 使用说明
1. 准备需要批注的Word文档，并将其放置在`typos_doc`目录下，例如`百度测试错别字.docx`。
2. 在代码中定义错别字信息，格式如下：
   ```python
   typos_info = [
       {
           "文本错误位置": "错误文本",
           "文本错误内容": "错误词",
           "文本正确内容": "正确词",
           "错误原因": "错误原因说明"
       }
   ]
   ```
3. 调用`mark_typos`函数进行批注，或调用`replace_typos`函数进行替换：
   ```python
   mark_typos("typos_doc/百度测试错别字.docx", typos_info, "result/批注.docx")
   replace_typos("typos_doc/百度测试错别字.docx", typos_info, "result/正确版.docx")
   ```
4. 批注结果将保存在`result`目录下的`批注.docx`文件中，修正后的文档将保存在`正确版.docx`文件中。

## 参与贡献
1. Fork本仓库。
2. 新建`Feat_xxx`分支。
3. 提交代码。
4. 创建Pull Request。

## 特技
1. 使用`Readme_XXX.md`来支持不同的语言，例如`Readme_en.md`、`Readme_zh.md`。
2. Gitee官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以通过 [https://gitee.com/explore](https://gitee.com/explore) 了解Gitee上的优秀开源项目。
4. [GVP](https://gitee.com/gvp) 是Gitee最有价值开源项目，综合评定出的优秀开源项目。
5. Gitee官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. Gitee封面人物是一档用来展示Gitee会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)