RedPen

英語文書用の RedPen おすすめ設定

More than 1 year has passed since last update.

RedPen はマークアップ言語(Markdown、AsciiDoc、LaTeXなど)で書かれた技術文書を検査するツールです。

RedPen が提供する特徴のひとつに複数の自然言語への対応があります。つまりユーザは RedPen をつかって日本語で記述された文書だけでなく、英語文書の検査もできます。今回は RedPen をつかって英語文書を検査する際の、おすすめ設定について解説します。

英語文書用の設定でも日本語の場合とおなじように、必要な機能を追加してゆくだけです。英語文書の検査で使用する機能の一部は日本語の検査で利用したものです。そのため英語文書用の設定は日本語のものと類似した設定となります。

はじめの設定(やっぱり文長まわり)

対象となる文書が英語の場合でも、まずおすすめしたいのは文長関係の機能だけを追加する設定です。基本的に文が長いと読みにくいのは対象言語に依存しません(英語の方が日本語の文よりも平均的に長くはなりますが)。文長まわりの機能を加えて、シンプルな文を書くように気をつけましょう。

以下、文長関係の機能を追加した設定ファイルとなります。

<redpen-conf>
    <validators>
        <validator name="SentenceLength">
              <property name="max_len" value="120"/>
        </validator>
        <validator name="CommaNumber" />
        <validator name="SuccessiveWord" />
        <validator name="DoubledWord" />
    </validators>
</redpen-conf>

上記の設定例は先の記事で紹介した日本語用の設定とほぼ同じです。違いは lang=ja という設定がない点です。 RedPen はデフォルトの言語設定は英語になっているため、入力文書が英語であれば言語(lang)設定は必要ありません。

表現に関する機能を追加

RedPen は英語の表現について検査する機能をいくつか提供しています。以下英語の表現に関する機能を追加した設定ファイルです。

<redpen-conf>
    <validators>
        <validator name="SentenceLength">
              <property name="max_len" value="120"/>
        </validator>
        <validator name="CommaNumber" />
        <validator name="SuccessiveWord" />
        <validator name="DoubledWord" />

        <validator name="InvalidExpression" />
        <validator name="InvalidWord" />
        <validator name="Contraction" />
        <validator name="Spelling" />
        <validator name="DoubledWord" />
        <validator name="SuccessiveWord" />

        <validator name="DoubleNegative" />
        <validator name="FrequentSentenceStart" />
        <validator name="WordFrequency" />
        <validator name="Hyphenation" />
        <validator name="NumberFormat" />
        <validator name="WeakExpression" />
    </validators>
</redpen-conf>
  • InvalidExpression (不正な表現、句の検出)
  • InvalidWord(不正な単語の検出)
  • Contraction(省略形の仕様)
  • Spelling(スペルチェック)
  • DoubledWord(一文中での同一単語の複数回仕様)
  • SuccessiveWord(連続して同一単語が出現)
  • DoubleNegative(二重否定)
  • FrequentSentenceStart(文頭表現の頻度)
  • WordFrequency(単語頻度)
  • Hyphenation(ハイフンの使用方法)
  • NumberFormat(数値表現)
  • WeakExpression(弱い表現、曖昧な表現の仕様)

大きな文書用の設定

マニュアルなど大きな文書を英語で書くときには、パラグラフ、節を検査する機能を追加します。追加する機能は日本語の設定で追加したものと同じです。

<redpen-conf>
    <validators>
        <validator name="SentenceLength">
              <property name="max_len" value="120"/>
        </validator>
        <validator name="CommaNumber" />
        <validator name="SuccessiveWord" />
        <validator name="DoubledWord" />

        <validator name="InvalidExpression" />
        <validator name="InvalidWord" />
        <validator name="Contraction" />
        <validator name="Spelling" />
        <validator name="DoubledWord" />
        <validator name="SuccessiveWord" />

        <validator name="DoubleNegative" />
        <validator name="FrequentSentenceStart" />
        <validator name="WordFrequency" />
        <validator name="Hyphenation" />
        <validator name="NumberFormat" />
        <validator name="WeakExpression" />

        <validator name="ParagraphNumber" />
        <validator name="SectionLength" />
        <validator name="DuplicatedSection" />
        <validator name="EmptySection" />
    </validators>
</redpen-conf>
  • ParagraphNumber(節内のパラグラフ数)
  • SectionLength(節の長さ)
  • DuplicatedSection(類似した節が存在するかを検査。節の場所を移動させた際に、元の場所の節の削除を忘れた場合にエラーを出力してくれる)
  • EmptySection(節や章のはじめに解説用のパラグラフが存在しない場合にエラーを出力する)

文字に関する設定

RedPen における英語のデフォルト設定は半角文字(Ascii文字)の利用を仮定しています。英語文書は基本半角文字を利用して記述されるので、文字を上書きする必要はありません。もし利用する文字を変更したい場合には、symbols ブロックを追加して利用文字を上書きしてください。