AutoMdxBuilder 项目使用教程

AutoMdxBuilder 项目使用教程

AutoMdxBuilder Automatically make mdx dictionaries 项目地址: https://gitcode.com/gh_mirrors/au/AutoMdxBuilder

1. 项目的目录结构及介绍

AutoMdxBuilder 项目的目录结构如下：

AutoMdxBuilder/
├── cross_platform/
│   └── images/
├── lib/
├── templates/
├── LICENSE
├── README.md
├── auto_mdx_builder.py
├── ebook_utils.py
├── func_lib.py
├── requirements.txt
└── settings.py

目录结构介绍

• cross_platform/: 包含跨平台相关的文件和资源，如图片等。
• lib/: 存放项目依赖的库文件。
• templates/: 存放词典制作的模板文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文档。
• auto_mdx_builder.py: 项目的主启动文件，负责自动化词典制作的主要逻辑。
• ebook_utils.py: 与电子书相关的工具函数。
• func_lib.py: 项目中使用的功能函数库。
• requirements.txt: 项目依赖的Python包列表。
• settings.py: 项目的配置文件，包含项目的各种设置和参数。

2. 项目的启动文件介绍

auto_mdx_builder.py

auto_mdx_builder.py 是 AutoMdxBuilder 项目的主启动文件。该文件包含了自动化词典制作的主要逻辑，包括词典的打包、解包、制作和还原等功能。

主要功能

• 词典打包: 将词条数据打包成 mdx/mdd 文件。
• 词典解包: 解包 mdx/mdd 文件，提取词条数据。
• 词典制作: 自动化制作词典，支持多种模板和多卷/集合类型。
• 词典还原: 将 Mdict 词典还原为原始格式。

使用方法

python auto_mdx_builder.py

3. 项目的配置文件介绍

settings.py

settings.py 是 AutoMdxBuilder 项目的配置文件，包含了项目的各种设置和参数。通过修改该文件，用户可以自定义词典制作的各种选项。

主要配置项

• 词典模板: 选择词典制作的模板，支持 A-D 四种模板。
• 词典类型: 设置词典的类型，如多卷词典、集合词典等。
• 输出路径: 指定词典制作后的输出路径。
• 其他参数: 包括词典的编码格式、分包大小等。

示例配置

# settings.py

# 选择词典模板
DICT_TEMPLATE = 'A'

# 词典类型
DICT_TYPE = 'multi_volume'

# 输出路径
OUTPUT_PATH = './output'

# 其他参数
ENCODING = 'utf-8'
SPLIT_SIZE = 1024 * 1024 * 10  # 10MB

通过修改 settings.py 文件中的配置项，用户可以根据自己的需求定制词典制作过程。

AutoMdxBuilder Automatically make mdx dictionaries 项目地址: https://gitcode.com/gh_mirrors/au/AutoMdxBuilder