TeXtidote 使用教程

TeXtidote 使用教程

textidoteSpelling, grammar and style checking on LaTeX documents项目地址:https://gitcode.com/gh_mirrors/te/textidote

项目介绍

TeXtidote 是一个用于 LaTeX 文档的校对工具，能够检查拼写、语法、风格等问题。它基于 Language Tool 库，支持多种语言，并能直接在 LaTeX 源文件上进行检查，无需清理标记。TeXtidote 还提供了 HTML 报告，方便用户查看和修改建议。

项目快速启动

安装 TeXtidote

首先，确保你已经安装了 Java Development Kit (JDK) 版本 8 或更高版本，以及 Ant。然后，从 GitHub 下载或克隆 TeXtidote 的源代码：

git clone https://github.com/sylvainhalle/textidote.git

进入 TeXtidote 目录并编译：

cd textidote
ant

编译完成后，将 TeXtidote 的可执行文件添加到系统路径中。在 /usr/local/bin 目录下创建一个名为 textidote 的文件，并添加以下内容：

#!/bin/bash
java -jar /opt/textidote/textidote.jar "$@"

赋予执行权限：

sudo chmod +x /usr/local/bin/textidote

使用 TeXtidote

现在，你可以在命令行中调用 TeXtidote 来检查 LaTeX 文件：

textidote --output html example.tex > report.html

这将生成一个 HTML 报告，你可以在浏览器中打开 report.html 查看结果。

应用案例和最佳实践

案例一：学术论文校对

假设你正在撰写一篇学术论文，可以使用 TeXtidote 来检查语法和拼写错误。以下是一个示例命令：

textidote --check en --output html paper.tex > paper_report.html

案例二：忽略特定词汇

如果你有一些特定的词汇不想被 TeXtidote 检查，可以使用 --dict 参数指定一个包含这些词汇的文本文件：

textidote --check en --dict dico.txt example.tex

最佳实践

1. 定期校对：在写作过程中定期使用 TeXtidote 进行校对，以便及时发现并修正错误。
2. 自定义词汇列表：创建一个自定义词汇列表，包含项目特定的术语和缩写，以避免误报。

典型生态项目

Language Tool

Language Tool 是一个开源的语法和风格检查工具，支持多种语言。TeXtidote 基于 Language Tool 构建，提供了对 LaTeX 文档的校对功能。

GitHub Actions

你可以将 TeXtidote 集成到 GitHub Actions 中，实现自动化的文档校对。以下是一个示例 GitHub Actions 配置：

name: TeXtidote Check
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up JDK 1.8
      uses: actions/setup-java@v1
      with:
        java-version: 1.8
    - name: Run TeXtidote
      run: |
        wget https://github.com/sylvainhalle/textidote/releases/download/v0.8/textidote.jar
        java -jar textidote.jar --output html paper.tex > report.html

通过这种方式，每次提交代码时都会自动运行 TeXtidote 进行校对。

textidoteSpelling, grammar and style checking on LaTeX documents项目地址:https://gitcode.com/gh_mirrors/te/textidote