WP2TXT 使用教程

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

WP2TXT 是一个命令行工具，用于从 Wikipedia 的 XML 压缩文件中提取文本内容和分类数据。项目的目录结构如下：

wp2txt/
├── bin/                      # 存放可执行脚本
├── data/                     # 存放项目数据
├── image/                    # 存放图像文件
├── lib/                      # 存放库文件
├── spec/                     # 存放测试文件
├── .dockerignore             # Docker 忽略文件
├── .gitignore                # Git 忽略文件
├── .rubocop.yml              # RuboCop 配置文件
├── .solargraph.yml           # Solargraph 配置文件
├── Dockerfile                # Docker 构建文件
├── Gemfile                   # Ruby 依赖文件
├── LICENSE                   # 项目许可证文件
├── README.md                 # 项目说明文件
├── Rakefile                  # Rake 任务文件
└── wp2txt.gemspec            # Gem 规范文件

• bin/: 包含用于执行 WP2TXT 的脚本文件。
• data/: 存储项目所需的数据文件。
• image/: 存储与项目相关的图像文件。
• lib/: 包含项目的核心库和模块。
• spec/: 包含项目的测试代码。

其他文件如 .dockerignore、.gitignore、.rubocop.yml、.solargraph.yml、Dockerfile、Gemfile、LICENSE、README.md、Rakefile 和 wp2txt.gemspec 分别是 Docker 忽略文件、Git 忽略文件、代码风格检查配置文件、代码分析工具配置文件、Docker 构建文件、Ruby 依赖配置文件、项目许可证、项目说明文件、Rake 任务配置文件和 Gem 规范文件。

2. 项目的启动文件介绍

WP2TXT 的启动主要是通过命令行执行 bin 目录下的脚本。以下是一个基本的启动命令：

$ wp2txt -i ./enwiki-20220801-pages-articles.xml.bz2 -o ./text

该命令会从指定的 XML 压缩文件中提取文本内容，并将其输出到指定的目录。

3. 项目的配置文件介绍

WP2TXT 的配置主要通过命令行参数进行。下面是几个主要的配置参数：

• -i, --input: 指定输入的压缩文件路径（bz2格式）或解压后的文件路径（xml格式）。
• -o, --output-dir: 指定输出的目录路径。
• -c, --convert, --no-convert: 指定是否将提取的内容转换为纯文本格式。

例如，以下命令会直接从压缩文件中提取文本内容，并且输出到指定目录，同时不进行格式转换：

$ wp2txt --no-convert -i ./enwiki-20220801-pages-articles.xml.bz2 -o ./text

通过这些参数，用户可以根据自己的需要调整 WP2TXT 的行为。