openstax/xhtml-validator

xhtml5-validator 镜像文档

镜像概述

xhtml5-validator 是一个用于XHTML文件验证的工具，提供对XHTML文件结构和数据内容的多维度检查。它不仅是简单的模式验证器，还能验证文件中值的正确性，例如确保id="..."属性的唯一性、内部链接指向文档中实际存在的元素等，旨在生成可被HTML解析器正确解析的XHTML文件。

核心功能与特性

该工具执行以下验证检查：

• 计划中（当前禁用）：使用 https://github.com/validator/validator 进行XHTML模式验证
• 已实现：检查id属性的唯一性
• 已实现：验证内部链接指向存在的元素

特别关注自闭合标签问题，因为自闭合的span、link、heading等标签会对HTML解析器造成困扰，工具旨在避免此类问题。

使用场景与适用范围

适用于需要确保XHTML文件质量和兼容性的开发场景，包括：

• XHTML文件开发过程中的质量检查
• 确保XHTML文件符合内部链接有效性要求
• 验证XHTML文件中id属性的唯一性
• 需要兼容HTML解析器的XHTML文件生成与验证

使用方法与配置说明

基本使用

通过挂载卷并指定XHTML文件路径作为参数运行容器：

bash
# 克隆仓库后运行示例
docker run --volume $(pwd):/data --rm -it $(docker build -q .) /data/test/resources/fail-duplicate.xhtml
docker run --volume $(pwd):/data --rm -it $(docker build -q .) /data/test/resources/fail-no-link-target.xhtml
docker run --volume $(pwd):/data --rm -it $(docker build -q .) /data/test/resources/pass.xhtml

可选参数（指定测试类型）

可通过额外参数指定要运行的测试类型：

• 不指定参数：运行所有验证检查
• "duplicate-id"：仅检查重复的id属性
• "broken-link"：仅检查内部失效链接
• "link-to-duplicate-id"：允许重复id（非严格有效的XHTML），但链接到重复id将被视为错误

示例：

bash
docker run --volume $(pwd):/data --rm -it $(docker build -q .) /data/test/resources/fail-link-to-duplicate-id.xhtml link-to-duplicate-id

构建与测试

完整构建

使用Gradle的build任务执行完整构建（包括生成.jar文件和运行单元测试）：

bash
./gradlew build

构建产物将生成在./build目录中，xhtml-validator.jar位于./build/libs/目录下。

运行单元测试

使用test任务运行单元测试：

bash
./gradlew test

清理环境

使用clean任务清理构建环境：

bash
./gradlew clean